generate-me-docs

0.6.9Β β€’Β PublicΒ β€’Β Published

πŸ“– Generate-Me-Docs

generate-me-docs is a command-line tool that can be used to generate documentation for your projects from your project's source. The tool is available on NPm

[!TIP] Install Globally:

npm install -g generate-me-docs

πŸͺ΄ Usage

To use generate-me-docs, you must provide the name of the folder containing the source files and your Gemini API key. The tool will automatically generate a set of MARKDIWN files!.

npx generate-me-docs [folder] [apiKey] <extraRequests> 

πŸ₯  Props

Prop Description Required
folder Source files folder true
apiKey Google's Gemini API Key true
extraRequests Extra requests you want to pass false

πŸ’― Example

+ npx generate-me-docs src apikeyxyz "Add Some Emojis Too"

Package Sidebar

Install

npm i generate-me-docs

Weekly Downloads

0

Version

0.6.9

License

MIT

Unpacked Size

5.87 kB

Total Files

3

Last publish

Collaborators

  • arnavk-09