code-narrator-turbo uses OpenAI to generate documentation for your source code, as well as create HowTo, FAQ, Tutorial, and other custom pages. code-narrator-turbo documents itself and should be a validation of the documentation working, similar to a compiler compiling itself. Configuration code-narrator-turbo.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-turbo -D. code-narrator-turbo is code language, linguistic & framework neutral. It keeps your documentation always up to date.
-
Move to your project directory.
-
Install the package:
npm i https://github.com/ffrappo/code-narrator-turbo -D-
Create a
.envfile there (if it doesn't exist) and add yourOPENAI_API_KEY=****. -
Run code-narrator-turbo:
npx code-narrator-turbo- The first run is setup only. The second will start creating documentation.
After installing the package and running it for the first time, a code-narrator-turbo.config.js file will be generated. You can customize this file to configure the documentation generation for your project.
code-narrator-turbo Repository
If you encounter any issues or have suggestions, please report them here.
1.0.30
ISC