Security News
The Unpaid Backbone of Open Source: Solo Maintainers Face Increasing Security Demands
Solo open source maintainers face burnout and security challenges, with 60% unpaid and 60% considering quitting.
gitbook-comment
Advanced tools
It generate markdown for any comment line starting with ///
(there is a space at the end of it).
/// ### Method Name
/// This is my awesome method.
function Sum(a, b) {
/// This will convert to markdown
// This is a normal comment
return a + b
}
/* Another normal comment */
Above code will become this:
This is my awesome method.
function Sum(a, b) {
This will convert to markdown
// This is a normal comment
return a + b
}
/* Another normal comment */
npm install --save gitbook-comment
gitbook-comment --help
to read the command line instructions "scripts": {
"doc-generate": "gitbook-comment generate -p ./",
"doc-clean-up": "gitbook-comment clean-up -p ./",
"doc-publish": "gitbook-comment publish -p ./"
}
docs
branch created locally on your machine by git branch docs
npm run doc-generate
on your working branch:
docs
Note If you do not commit your work in working branch, it may get lost in switching the branches.
note: This generator is creating the .md
files in same folder next to the original files.
Alternatively you can generate or clean up docs in any branch
# Generate doc in current branch
npm run doc-generate
# Check help for a command
npm run doc-generate -- -h
# Get full documentation
./node_modules/gitbook-comment/bin/gitbook-comment -h
# Use more more options on a command
npm run doc-generate -- -p ./src -i bin -e js,css,scss
# Clean up generated docs
npm run doc-comment clean-up
If you generate doc manually, make sure they are uploaded to docs or any other none development branch and use gitbook.com integration to view them.
FAQs
Generate Markdown file from comments in source code
The npm package gitbook-comment receives a total of 0 weekly downloads. As such, gitbook-comment popularity was classified as not popular.
We found that gitbook-comment demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Solo open source maintainers face burnout and security challenges, with 60% unpaid and 60% considering quitting.
Security News
License exceptions modify the terms of open source licenses, impacting how software can be used, modified, and distributed. Developers should be aware of the legal implications of these exceptions.
Security News
A developer is accusing Tencent of violating the GPL by modifying a Python utility and changing its license to BSD, highlighting the importance of copyleft compliance.