https://github.com/kcreate/docs-gen
node script that shows all the comments inside a source file as a list of cards. Generates a *.html file.
https://github.com/kcreate/docs-gen
Last synced: 8 months ago
JSON representation
node script that shows all the comments inside a source file as a list of cards. Generates a *.html file.
- Host: GitHub
- URL: https://github.com/kcreate/docs-gen
- Owner: KCreate
- Created: 2015-12-10T20:28:51.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2015-12-11T17:18:56.000Z (about 10 years ago)
- Last Synced: 2025-06-23T22:49:43.929Z (8 months ago)
- Language: JavaScript
- Size: 3.91 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# docs-gen
node script that shows all the comments inside a source file as a list of cards. Generates a *.html file.
Let's say you have a index.js file and you want to extract all the comments inside them and show them in a visually appealing way.
You can use this module like that:
```
node DIRECTORY/TO/MODULE/index.js sourceFile fileName encoding
```
Where the parameters mean the following:
__sourceFile__ = The path to the file you want to extract comments from.
__fileName__ = The name the html file that's being generated should have.
__encoding__ = If your file has a fancy url encoding, pass it here.
# Dependencies:
[extract-comments](https://www.npmjs.com/package/extract-comments)
[mkdirp](https://www.npmjs.com/package/mkdirp)
# License:
[MIT](https://opensource.org/licenses/MIT)