https://github.com/jfeigel/js-pages

:notebook: Custom Git script to compile JSDoc / ngdoc and deploy to gh-pages
https://github.com/jfeigel/js-pages

Last synced: about 6 hours ago
JSON representation

:notebook: Custom Git script to compile JSDoc / ngdoc and deploy to gh-pages

• Host: GitHub
• URL: https://github.com/jfeigel/js-pages
• Owner: jfeigel
• License: mit
• Created: 2016-01-15T01:26:27.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2016-05-02T11:49:58.000Z (over 8 years ago)
• Last Synced: 2024-08-08T23:41:21.889Z (about 2 months ago)
• Language: JavaScript
• Homepage: http://jfeigel.github.io/js-pages/
• Size: 421 KB
• Stars: 4
• Watchers: 4
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# :notebook: js-pages

Custom Git script to compile JSDoc / ngdoc and deploy to gh-pages

### Install / Run

```

npm install js-pages

node node_modules/js-pages

```

-

1. Choose [Grunt](http://gruntjs.com/) or [Gulp](http://gulpjs.com/) as your task runner to get a pre-built template.

1. Choose jsdoc, [Grunt version](https://github.com/krampstudio/grunt-jsdoc) or [Gulp version](https://github.com/mlucool/gulp-jsdoc3), or ngdoc, [Grunt version](https://github.com/m7r/grunt-ngdocs) or [Gulp version](https://github.com/nikhilmodak/gulp-ngdocs), as your documentation generator.

1. Choose a custom git alias that will be configured for your local repository (defaults to _pushdoc_)

1. Choose whether or not `sudo` is used to install your npm packages