Website

This website is built using Docusaurus 3, a modern static website generator.

CLI Usage

$3

``bash
npx create-project-docs add
`

Add documentation to a specific directory:

`bash
npx create-project-docs add --path ../my-project
`

$3

`bash
npx create-project-docs new my-project
cd my-project
`

$3

- --force - Overwrite existing documentation folder
- --skip-install - Skip running yarn install
- --help - Show help

$3

`
$ yarn
`

$3

`
$ PROJECT_NAME=your-project-name yarn start
`

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

$3

`
$ PROJECT_NAME=your-project-name yarn build
`

This command generates static content into the build directory and can be served using any static contents hosting service.

$3

Using SSH:

`
$ USE_SSH=true yarn deploy
`

Not using SSH:

`
$ GIT_USER= yarn deploy
`

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages` branch.