Security News
Cloudflare Adds Security.txt Setup Wizard
Cloudflare has launched a setup wizard allowing users to easily create and manage a security.txt file for vulnerability disclosure on their websites.
documentation
Advanced tools
A documentation generation system that's beautiful by default, flexible across formats and styles, and powerful enough to support JSDoc's advanced syntax.
ES5 and ES6 support of JavaScript, with support for other transpilers a possibility
Using babel, we have support for a wide range of ES6 & ES7 features, as well as Flow type annotations.
Powerful inference
By statically analyzing your JavaScript code, documentation.js can write many parts of your documentation for you. It can infer parameter names and types, class membership, return values from Flow types, and lots more.
Support for C++
You can use the --polyglot
mode of documentationjs to document native node.js
modules in JSDoc within the C++ code that implements the feature.
Support for following dependency trees
Using module-deps, documentation
can
crawl require()
graphs - pointing it to your app's main
file will find all
referenced files and include all of their documentation.
GitHub Integration
The --github
option automatically permalinks documentation to the exact
sections of code it refers to in a GitHub repository.
Gulp integration
The gulp-documentation project
lets you run documentation
as a Gulp build task.
Getting_Started: start here
Usage: how to use documentation.js
Recipes: tricks for writing effective JSDoc docs
Node API: documentation.js's self-generated documentation
Theming HTML: tips for theming documentation output in HTML
See also: a list of projects similar to documentation.js
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 -h
option for help:
$ documentation -h
Usage: documentation <command> [options]
Options:
--lint check output for common style and uniformity mistakes
[boolean]
-t, --theme specify a theme: this must be a valid theme module
-p, --private generate documentation tagged as private [boolean]
--version Show version number [boolean]
--name project name. by default, inferred from package.json
--project-version project version. by default, inferred from package.json
--shallow shallow mode turns off dependency resolution, only
processing the specified files (or the main script
specified in package.json) [boolean] [default: false]
--polyglot polyglot mode turns off dependency resolution and enables
multi-language support. use this to document c++ [boolean]
-g, --github infer links to github in documentation [boolean]
-o, --output output location. omit for stdout, otherwise is a filename
for single-file outputs and a directory name for multi-file
outputs like html [default: "stdout"]
-c, --config configuration file. an array defining explicit sort order
-h, --help Show help [boolean]
-f, --format [choices: "json", "md", "html"] [default: "json"]
Examples:
documentation foo.js parse documentation in a given file
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.
3.0.4
FAQs
a documentation generator
The npm package documentation receives a total of 79,198 weekly downloads. As such, documentation popularity was classified as popular.
We found that documentation demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 5 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.
Security News
Cloudflare has launched a setup wizard allowing users to easily create and manage a security.txt file for vulnerability disclosure on their websites.
Security News
The Socket Research team breaks down a malicious npm package targeting the legitimate DOMPurify library. It uses obfuscated code to hide that it is exfiltrating browser and crypto wallet data.
Security News
ENISA’s 2024 report highlights the EU’s top cybersecurity threats, including rising DDoS attacks, ransomware, supply chain vulnerabilities, and weaponized AI.