Product
Introducing SSO
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
@activeviam/documentation
Advanced tools
Readme
The documentation system for modern JavaScript
Globally install documentation
using the npm package manager:
$ npm install -g documentation
This installs a command called documentation
in your path, that you can
point at JSDoc-annotated source code to generate
human-readable documentation. First, run documentation
with the --help
option for help:
Usage:
# generate markdown docs for index.js and files it references
bin/documentation.js build index.js -f md
# generate html docs for all files in src
bin/documentation.js build src/** -f html -o docs
# document index.js, ignoring any files it requires or imports
bin/documentation.js build index.js -f md --shallow
# build and serve HTML docs for app.js
bin/documentation.js serve app.js
# build, serve, and live-update HTML docs for app.js
bin/documentation.js serve --watch app.js
# validate JSDoc syntax in util.js
bin/documentation.js lint util.js
# update the API section of README.md with docs from index.js
bin/documentation.js readme index.js --section=API
# build docs for all values exported by index.js
bin/documentation.js build --document-exported index.js
Commands:
serve [input..] generate, update, and display HTML documentation
build [input..] build documentation
lint [input..] check for common style and uniformity mistakes
readme [input..] inject documentation into your README.md
Options:
--version Show version number [boolean]
--help Show help [boolean]
We have plenty of issues that we'd love help with.
JSDoc
support, including typedefs.documentation is an OPEN Open Source Project. This means that:
Individuals making significant and valuable contributions are given commit-access to the project to contribute as they see fit. This project is more like an open wiki than a standard guarded open source project.
FAQs
a documentation generator
The npm package @activeviam/documentation receives a total of 4 weekly downloads. As such, @activeviam/documentation popularity was classified as not popular.
We found that @activeviam/documentation demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 3 open source maintainers 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.
Product
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.