معرفی شرکت ها
verb-0.8.10
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشترتوضیحات
Documentation generator for GitHub projects. Verb is extremely powerful, easy to use, and is used on hundreds of projects of all sizes to generate everything from API docs to readmes.
| ویژگی | مقدار |
|---|---|
| سیستم عامل | - |
| نام فایل | verb-0.8.10 |
| نام | verb |
| نسخه کتابخانه | 0.8.10 |
| نگهدارنده | ['jonschlinkert', 'doowb', 'andersdjohnson'] |
| ایمیل نگهدارنده | ['github@sellside.com', 'brian.woodward@gmail.com', 'anders.d.johnson.dev@gmail.com'] |
| نویسنده | Jon Schlinkert |
| ایمیل نویسنده | - |
| آدرس صفحه اصلی | git://github.com/verbose/verb.git |
| آدرس اینترنتی | https://github.com/verbose/verb |
| مجوز | MIT |
# verb [](http://badge.fury.io/js/verb) [](https://travis-ci.org/verbose/verb)
> Documentation generator for GitHub projects. Verb is extremely powerful, easy to use, and is used on hundreds of projects of all sizes to generate everything from API docs to readmes.
**Built by verb**
The follow projects use verb to build the reamde and other docs:
* [micromatch](https://github.com/jonschlinkert/micromatch/) (1.7m downloads/mo) - this readme is pretty extensive, with a TOC and other advanced features
* [is-glob](https://www.npmjs.com/package/is-glob) (1.6m downloads/mo) - example of simple readme
* [repeat-string](https://www.npmjs.com/package/repeat-string) (2.2m downloads/mo) - example of another basic readme.
**Quickstart**
Install `verb` and `verb-cli` globally:
```sh
$ npm i verb verb-cli -g
```
Next, just add a `.verb.md` markdown template to your project and run `verb` in the commandline _(**NOTE** that verb will overwrite the existing `README`, so make sure your work is committed!)_.
I'm working on a site for verb, but in the meantime a good place to see `.verb.md` examples is to surf [my projects](https://github.com/jonschlinkert).
## Install
Install with [npm](https://www.npmjs.com/)
```sh
$ npm i verb --save-dev
```
## Usage
```js
var verb = require('verb');
```
## Table of contents
<!-- toc -->
* [Features](#features)
* [CLI](#cli)
* [API](#api)
- [Template API](#template-api)
- [Config API](#config-api)
- [Data API](#data-api)
- [Middleware API](#middleware-api)
- [Task API](#task-api)
- [](#-task--indexjs-l114-)[.task](index.js#L114)
- [](#-watch--indexjs-l180-)[.watch](index.js#L180)
* [Related projects](#related-projects)
* [Why use Verb?](#why-use-verb-)
* [Running tests](#running-tests)
* [Contributing](#contributing)
* [Troubleshooting](#troubleshooting)
* [Major changes](#major-changes)
* [Author](#author)
* [License](#license)
_(Table of contents generated by [verb])_
<!-- tocstop -->
## Features
* Generate markdown docs, or HTML
* Generate a Table of Contents simply by adding `<!-- toc -->` to any document.
* Include templates from locally installed npm packages with the `{%= include() %}` helper
* Include templates from your project's `docs/` directory with the `{%= docs() %}` helper
* Change the templates directory for either helper by passing a `cwd` to the helper: example: `{%= docs("foo", {cwd: ''}) %}`
## CLI
_(WIP)_
## API
> Verb's API is organized into the following categories:
* [Template API](#template-api)
* [Config API](#config-api)
* [Data API](#data-api)
* [Middleware API](#middleware-api)
* [Task API](#task-api)
### Template API
_(WIP)_
Methods:
* `.create`
* `.loader`
* `.load`
* `.engine`
* `.helper`
* `.helpers`
* `.asyncHelper`
* `.asyncHelpers`
* `.render`
Verb exposes entire API from [template](https://github.com/jonschlinkert/template). See the [template docs] the full API.
### Config API
**Transforms**
Run immediately during init. Used to extend or modify the `this` object.
```js
verb.transform('engine', function() {
this.engine('md', require('engine-lodash'));
});
```
**Application Settings**
> Set arbitrary values on `verb.cache`:
* `.set`
* `.get`
* `.del`
See the [config-cache docs] the full API.
**Options**
> Set and get values from `verb.options`:
* `.option`
* `.enable`
* `.enabled`
* `.disable`
* `.disabled`
* `.disabled`
See the [option-cache docs] the full API.
_(WIP)_
### Data API
> Set and get values from `verb.cache.data`
* `.data`
Verb exposes entire API from [plasma](https://github.com/jonschlinkert/plasma). See the [plasma docs] the full API.
_(WIP)_
### Middleware API
Verb exposes the entire [en-route] API. See the [en-route docs] the full API.
_(WIP)_
### Task API
### [.task](index.js#L114)
Define a Verb task.
**Params**
* `name` **{String}**: Task name
* `fn` **{Function}**
**Example**
```js
verb.task('docs', function() {
verb.src(['.verb.md', 'docs/*.md'])
.pipe(verb.dest('./'));
});
```
### [.watch](index.js#L180)
Re-run the specified task(s) when a file changes.
**Params**
* `glob` **{String|Array}**: Filepaths or glob patterns.
* `fn` **{Function}**: Task(s) to watch.
**Example**
```js
verb.task('watch', function() {
verb.watch('docs/*.md', ['docs']);
});
```
### [.src](index.js#L60)
Glob patterns or filepaths to source files.
**Params**
* `glob` **{String|Array}**: Glob patterns or file paths to source files.
* `options` **{Object}**: Options or locals to merge into the context and/or pass to `src` plugins
**Example**
```js
verb.src('src/*.hbs', {layout: 'default'})
```
### [.dest](index.js#L76)
Specify a destination for processed files.
**Params**
* `dest` **{String|Function}**: File path or rename function.
* `options` **{Object}**: Options and locals to pass to `dest` plugins
**Example**
```js
verb.dest('dist')
```
### [.copy](index.js#L95)
Copy a `glob` of files to the specified `dest`.
**Params**
* `glob` **{String|Array}**
* `dest` **{String|Function}**
* `returns` **{Stream}**: Stream, to continue processing if necessary.
**Example**
```js
verb.task('assets', function() {
verb.copy('assets/**', 'dist');
});
```
### [.diff](index.js#L116)
Display a visual representation of the difference between two objects or strings.
**Params**
* `a` **{Object|String}**
* `b` **{Object|String}**
* `methodName` **{String}**: Optionally pass a [jsdiff](https://github.com/nathan7/jsdiff)method name to use. The default is `diffJson`
**Example**
```js
var doc = verb.views.docs['foo.md'];
verb.render(doc, function(err, content) {
verb.diff(doc.orig, content);
});
```
## Related projects
* [assemble](https://www.npmjs.com/package/assemble): Static site generator for Grunt.js, Yeoman and Node.js. Used by Zurb Foundation, Zurb Ink, H5BP/Effeckt,… [more](https://www.npmjs.com/package/assemble) | [homepage](http://assemble.io)
* [composer](https://www.npmjs.com/package/composer): API-first task runner with three methods: task, run and watch. | [homepage](https://github.com/jonschlinkert/composer)
* [engine](https://www.npmjs.com/package/engine): Template engine based on Lo-Dash template, but adds features like the ability to register helpers… [more](https://www.npmjs.com/package/engine) | [homepage](https://github.com/jonschlinkert/engine)
* [template](https://www.npmjs.com/package/template): Render templates using any engine. Supports, layouts, pages, partials and custom template types. Use template… [more](https://www.npmjs.com/package/template) | [homepage](https://github.com/jonschlinkert/template)
## Why use Verb?
It's magical and smells like chocolate. If that's not enough for you, it's also the most powerful and easy-to-use documentation generator for node.js. And it's magical.
## Running tests
Install dev dependencies:
```sh
$ npm i -d && npm test
```
## Contributing
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/verbose/verb/issues/new).
## Troubleshooting
1. First things first, please make sure to run `npm cache clear`, then do `npm i verb verb-cli -g`. If that doesn't clear things up, try #2.
2. Create [an issue](https://github.com/verbose/verb/issues). We'd love to help, so please be sure to provide as much detail as possible, including:
* version of verb and verb-cli
* platform
* any error messages or other information that might be useful.
## Major changes
* `v0.4.0`: Verb now requires [verb-cli](https://github.com/verbose/verb-cli)to run. See the [getting started](#getting-started) section for details.
## Author
**Jon Schlinkert**
+ [github/jonschlinkert](https://github.com/jonschlinkert)
+ [twitter/jonschlinkert](http://twitter.com/jonschlinkert)
## License
Copyright © 2014-2015 [Jon Schlinkert](https://github.com/jonschlinkert)
Released under the MIT license.
***
_This file was generated by [verb-cli](https://github.com/assemble/verb-cli) on August 26, 2015._
نیازمندی
| مقدار | نام |
|---|---|
| ^0.1.1 | ansi-bold |
| ^0.1.1 | ansi-cyan |
| ^0.1.1 | ansi-red |
| ^0.1.1 | ansi-yellow |
| ^3.0.0 | arr-union |
| ^0.2.0 | async-helper-base |
| ^0.1.0 | base-loader |
| ^1.1.1 | chalk |
| ^0.4.0 | composer |
| ^0.1.2 | computed-property |
| ^0.8.0 | cwd |
| ^0.8.2 | data-store |
| ^2.0.2 | diff |
| ^0.8.0 | engine-lodash |
| ^3.3.1 | event-stream |
| ^2.1.0 | export-files |
| ^2.0.1 | extend-shallow |
| ^1.1.5 | get-value |
| ^0.3.0 | gfm-code-blocks |
| ^1.1.2 | git-user-name |
| ^2.1.0 | globby |
| ^0.2.0 | gulp-drafts |
| ^3.0.6 | gulp-util |
| ^0.1.0 | helper-changelog |
| ^0.1.2 | helper-codelinks |
| ^1.4.0 | helper-copyright |
| ^0.1.2 | helper-coverage |
| ^0.2.2 | helper-date |
| ^0.2.1 | helper-license |
| ^1.4.1 | helper-reflinks |
| ^0.10.0 | helper-related |
| ^0.3.1 | helper-resolve |
| ^0.2.0 | helper-toc |
| ^0.1.1 | init-file-loader |
| ^2.0.1 | is-plain-object |
| ^0.1.0 | is-true |
| ^0.5.4 | js-comments |
| ^0.1.2 | lint-templates |
| ^3.10.1 | lodash |
| ^1.0.2 | log-symbols |
| ^0.4.0 | logging-helpers |
| ^0.11.5 | markdown-toc |
| ^0.7.1 | markdown-utils |
| ^2.2.0 | micromatch |
| ^0.1.4 | middleware-utils |
| ^0.2.0 | parse-author |
| ^0.4.0 | parse-copyright |
| ^0.6.3 | parse-filepath |
| ^0.1.1 | parse-github-url |
| ^0.2.0 | parse-gitignore |
| ^1.2.5 | parser-front-matter |
| ^0.1.2 | plugin-error |
| ^0.1.8 | pretty-remarkable |
| ^0.3.3 | readme-badges |
| ^0.2.9 | readme-includes |
| ^3.0.1 | relative |
| ^0.1.0 | relative-dest |
| ^1.6.0 | remarkable |
| ^0.1.0 | stringify-travis-url |
| ^0.14.3 | template |
| ^0.4.4 | template-helper-apidocs |
| ^0.3.2 | template-helpers |
| ^0.3.3 | template-toc |
| ^2.0.0 | through2 |
| ^0.1.0 | update-copyright |
| ^1.0.0 | vinyl-fs |
| ^0.2.1 | year |
زبان مورد نیاز
| مقدار | نام |
|---|---|
| 0.12.0 | Npm |
نحوه نصب
نصب پکیج tgz verb-0.8.10:
npm install verb-0.8.10.tgz