Skip to content

Commit

Permalink
docs(readme): add Write Documentation section
Browse files Browse the repository at this point in the history
  • Loading branch information
sebkolind committed Aug 1, 2024
1 parent ddda3f5 commit a4ae782
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ git clone [email protected]:sebkolind/ts-lib-starter.git my-project
cd my-project
```

### Configure package
### Configure Package

Open the `package.json` file and change the `name`, `description` and `author` fields to something you'd like.
The `name` should be unique and you should use a namespace (like how I use `@sebkolind` for my packages),
Expand All @@ -51,3 +51,11 @@ docs:dev # development
docs:build # build for release
docs:preview # preview release
```

## Write Documentation

I use [VitePress](https://vitepress.dev/) to write documentation for my packages. It's easy to use, comes
with a great default theme, and you write your content in Markdown.

VitePress is already installed, so to get started you can use the documentation found [here](https://vitepress.dev/guide).
I use the default configuration, so it should be easy to follow the guide from start to finish.

0 comments on commit a4ae782

Please sign in to comment.