code-narrator uses OpenAI to generate documentation for your source code, as well as create HowTo, FAQ, Tutorial, and other custom pages. Code-narrator documents itself and should be a validation of the documentation working, similar to a compiler compiling itself. Configuration code-narrator.config.js file is created on first run and sets the configuration for your project, such as project path, doc, documentation type, and more. The package can be installed using npm i code-narrator -D. code-narrator is code language, linguistic & framework neutral. It keeps your documentation always up to date.
- Install the package:
npm i code-narrator -D- Run code-narrator:
npx code-narratorAfter installing the package and running it for the first time, a code-narrator.config.js file will be generated. You can customize this file to configure the documentation generation for your project.
If you encounter any issues or have suggestions, please report them here.
- Ingi Gauti Ragnarsson @ingig
1.0.15
ISC