Skip to content

Files

Latest commit

 

History

History
 
 

docusaurus

Docs

The docs for projen are managed in this directory and are powered by docusaurus.

Contributing

Follow the docusaurus docs to learn how to edit the docs.

All documentation should be in the project's root /docs folder, and not in this docusaurus directory.

Running the docusaurus server

yarn
yarn start

Builds API docs

Generated API docs are committed to the repo, but if you've been making changes and would like to see how they're reflected in the docs, you can generate them:

$ yarn docgen

This will generate the API docs in docs/api.