معرفی شرکت ها
documentation-14.0.1
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشترتوضیحات
a documentation generator
| ویژگی | مقدار |
|---|---|
| سیستم عامل | - |
| نام فایل | documentation-14.0.1 |
| نام | documentation |
| نسخه کتابخانه | 14.0.1 |
| نگهدارنده | ['mourner', 'jfirebaugh', 'tmcw', 'anandthakker', 'birkskyum'] |
| ایمیل نگهدارنده | ['agafonkin@gmail.com', 'john.firebaugh@gmail.com', 'tom@macwright.com', 'vestibule@anandthakker.net', 'birk.skyum@pm.me'] |
| نویسنده | Tom MacWright |
| ایمیل نویسنده | - |
| آدرس صفحه اصلی | git+ssh://git@github.com/documentationjs/documentation.git |
| آدرس اینترنتی | https://documentation.js.org |
| مجوز | ISC |
<p align="center">
<img src="./.github/documentation-js-logo.png" width="650" />
</p>
<p align="center">
The documentation system for modern JavaScript
</p>
[](https://circleci.com/gh/documentationjs/documentation/tree/master)
[](http://badge.fury.io/js/documentation)
[](https://gitter.im/documentationjs/documentation?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
[](https://david-dm.org/documentationjs/documentation)
[](http://inch-ci.org/github/documentationjs/documentation)
[:date: Current maintenance status](https://github.com/documentationjs/documentation/wiki/Current-maintenance-status)
- Supports modern JavaScript: ES5, ES2017, JSX, Vue and [Flow](https://flow.org/) type annotations.
- Infers parameters, types, membership, and more. Write less documentation: let the computer write it for you.
- Integrates with GitHub to link directly from documentation to the code it refers to.
- Customizable output: HTML, JSON, Markdown, and more
## Examples
- [HTML output with default template](https://documentation.js.org/html-example/)
- [Markdown](https://github.com/documentationjs/documentation/blob/master/docs/NODE_API.md)
- [JSON](https://documentation.js.org/html-example/index.json)
## Documentation
- [Getting Started](docs/GETTING_STARTED.md): start here
- [Usage](docs/USAGE.md): how to use documentation.js
- [Recipes](docs/RECIPES.md): tricks for writing effective JSDoc docs
- [Node API](docs/NODE_API.md): documentation.js's self-generated documentation
- [Configuring documentation.js](docs/CONFIG.md)
- [FAQ](docs/FAQ.md)
- [Troubleshooting](docs/TROUBLESHOOTING.md)
- [Theming](docs/THEMING.md): tips for theming documentation output in HTML
- [See also](https://github.com/documentationjs/documentation/wiki/See-also): a list of projects similar to documentation.js
## User Guide
Globally install `documentation` using the [npm](https://www.npmjs.com/) package manager:
```sh
$ npm install -g documentation
```
This installs a command called `documentation` in your path, that you can
point at [JSDoc](https://jsdoc.app/about-getting-started.html)-annotated source code to generate
human-readable documentation. First, run `documentation` with the `--help`
option for help:
```sh
Usage:
# generate markdown docs for index.js and files it references
documentation build index.js -f md
# generate html docs for all files in src, and include links to source files in github
documentation build src/** -f html --github -o docs
# document index.js, ignoring any files it requires or imports
documentation build index.js -f md --shallow
# validate JSDoc syntax in util.js
documentation lint util.js
# update the API section of README.md with docs from index.js
documentation readme index.js --section=API
# build docs for all values exported by index.js
documentation build --document-exported index.js
# build html docs for a TypeScript project
documentation build index.ts --parse-extension ts -f html -o docs
Commands:
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]
```
## [Contributing](CONTRIBUTING.md)
_We have plenty of
[issues](https://github.com/documentationjs/documentation/issues) that we'd
love help with._
- Robust and complete `JSDoc` support, including typedefs.
- Strong support for HTML and Markdown output
- Documentation coverage, statistics, and validation
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.
نیازمندی
| مقدار | نام |
|---|---|
| ^7.18.10 | @babel/core |
| ^7.18.10 | @babel/generator |
| ^7.18.11 | @babel/parser |
| ^7.18.11 | @babel/traverse |
| ^7.18.10 | @babel/types |
| ^5.0.1 | chalk |
| ^3.5.3 | chokidar |
| ^5.1.0 | diff |
| 2.1.0 | doctrine-temporary-fork |
| ^13.1.0 | git-url-parse |
| 1.4.0 | github-slugger |
| ^8.0.3 | glob |
| ^2.4.1 | globals-docs |
| ^11.6.0 | highlight.js |
| ^3.0.0 | ini |
| ^4.1.0 | js-yaml |
| ^2.1.1 | konan |
| ^4.17.21 | lodash |
| ^2.2.1 | mdast-util-find-and-replace |
| ^1.1.0 | mdast-util-inject |
| ^1.1.0 | micromark-util-character |
| ^1.0.2 | parse-filepath |
| ^6.0.0 | pify |
| ^9.1.0 | read-pkg-up |
| ^14.0.2 | remark |
| ^3.0.1 | remark-gfm |
| ^15.0.1 | remark-html |
| ^6.0.1 | remark-reference-links |
| ^8.0.1 | remark-toc |
| ^1.22.1 | resolve |
| ^5.0.0 | strip-json-comments |
| ^3.0.0 | unist-builder |
| ^4.1.0 | unist-util-visit |
| ^5.3.4 | vfile |
| ^7.0.4 | vfile-reporter |
| ^3.0.0 | vfile-sort |
| ^17.5.1 | yargs |
| ^3.2.37 | @vue/compiler-sfc |
| ^2.7.8 | vue-template-compiler |
زبان مورد نیاز
| مقدار | نام |
|---|---|
| 18.12.1 | Npm |
نحوه نصب
نصب پکیج tgz documentation-14.0.1:
npm install documentation-14.0.1.tgz