https://github.com/stringmanolo/docu
CLI Documentation generator tool from coments for multiple languages.
https://github.com/stringmanolo/docu
coments documentation-generator documentation-tool
Last synced: 7 months ago
JSON representation
CLI Documentation generator tool from coments for multiple languages.
- Host: GitHub
- URL: https://github.com/stringmanolo/docu
- Owner: StringManolo
- Created: 2021-05-29T00:53:07.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-05-31T10:29:18.000Z (over 4 years ago)
- Last Synced: 2025-04-02T02:46:57.199Z (10 months ago)
- Topics: coments, documentation-generator, documentation-tool
- Language: HTML
- Homepage: https://stringmanolo.ga/docu/generated/fwl_docu.html
- Size: 125 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# docu.mjs
---
### ES6 module
---
##### Docu is a code geneator CLI tool. Is intended to generate documentation in html, markdown and bbcode from code commentaries.
---
CLI tool to create documents from commentaries in html, markdown and bbcode.
##### Features:
- Generate output in 3 languages
- Keep all changes in one file
- Output to console to allow automatization
- Navigate directly to the lines by clicking
- Easy share (documentated functions or directly the code line)
- No 3° party dependencies
- Support multiple languages
##### Download:
> ```git clone https://github.com/StringManolo/docu && cd docu```
##### Usage:
> ```node docu.mjs myCodeFile html > documentation.html```
> ```node docu.mjs myCodeFile markdown > documentation.md```
> ```node docu.mjs myCodeFile bbcode > documentation.bbcode.txt```
> ```lynx --dump documentation.html > documentation.txt```
##### Example:
Use fwl.mjs file as a reference on how to comment your code..
If you add an example, has to be the last paramter in your commentary.