Create a project with a Docusaurus documentation website template designed for Temple University CIS Projects in Computer Science courses.
npm install create-project-docsThis website is built using Docusaurus 3, a modern static website generator.
``bash`
npx create-project-docs add
Add documentation to a specific directory:
`bash`
npx create-project-docs add --path ../my-project
`bash`
npx create-project-docs new my-project
cd my-project
- --force - Overwrite existing documentation folder--skip-install
- - Skip running yarn install--help
- - Show help
``
$ yarn
``
$ 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.
``
$ 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.
Using SSH:
``
$ USE_SSH=true yarn deploy
Not using SSH:
``
$ GIT_USER=
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.