https://github.com/wejs/we-plugin-doc-git

We.js plugin to show project documentation with markdown
https://github.com/wejs/we-plugin-doc-git

Last synced: about 1 month ago
JSON representation

We.js plugin to show project documentation with markdown

• Host: GitHub
• URL: https://github.com/wejs/we-plugin-doc-git
• Owner: wejs
• Created: 2015-05-26T18:02:49.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2017-12-31T15:23:06.000Z (almost 7 years ago)
• Last Synced: 2024-11-12T19:13:28.213Z (about 1 month ago)
• Language: JavaScript
• Size: 56.6 KB
• Stars: 0
• Watchers: 6
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# We.js documentation plugin viewer

[![Dependency Status](https://david-dm.org/wejs/we-plugin-doc-git.png)](https://david-dm.org/wejs/we-plugin-doc-git)

## Installation

```sh

we i we-plugin-doc-git

```

## Has suport to:

 - Load and show markdown docs fom git projects

### How to test

after clone and install npm packages:

```sh

npm test

```

##### For run only 'Chat' test use:

```sh

NODE_ENV=test LOG_LV=info ./node_modules/.bin/mocha test/bootstrap.js test/**/*.test.js -g 'Chat'

```

##### For run the javascript linter

```sh

npm run lint

```

#### NPM Info:

[![NPM](https://nodei.co/npm/we-plugin-doc-git.png?downloads=true&downloadRank=true&stars=true)](https://nodei.co/npm/we-plugin-doc-git/)

## Copyright and license

Copyright 2013-2014 Alberto Souza  and contributors , under [the MIT license](LICENSE).