coding.blog
Description: An open-source tool to help you easily create best-in-class software documentation for your projects
software (33467) open-source (4361) code (3017) beautiful (1386) documentation (688) document (617) elegant (539) docs (104) codedoc (1)
CODEDOC is an open-source tool that helps you with creating beautiful and modern software documentation. It creates a JAMStack app from your markdown files that you can easily deploy on services such as GitHub Pages.
1 link $ npm i -g @codedoc/cli # --> click on each line to copy it link Usage Assume you have a repo on github named my-project and want to write documentations for it using codedoc. Install the codedoc cli, clone your repo locally, then:
1 link $ cd my-project # --> go to your project folder 2 link $ codedoc init # --> initialize codedoc 3 link $ codedoc serve # --> serve the docs Open a browser on the URL the CLI tool tells you (e.g. localhost:3000/my-project ) and see the docs boilerplate.
coding.blog