jaguarjs-jsdoc-fixed

    0.1.2 • Public • Published

    Forked and added tweaks to the below patched jaguarjs module. See original readme below:


    A patched version of JaguarJS-JSDoc

    JaguarJS-JSDoc is by far the most beautiful JSDoc theme in existence, but unfortuantely it's no longer maintained.

    This patched version consists of every PR and every other patch I could find, all mashed together into one giant hideous amalgalm, all in the name of progress. It seems to work.

    Usage

    1. Install from npm
    $ npm install jaguarjs-jsdoc-patched --save-dev
    
    1. Copy the conf.json file to the root directory of your repo. Edit as necessary.

    2. Assuming you're using grunt-jsdoc, set the template to ./node_modules/jaguarjs-jsdoc-patched

      grunt.initConfig({
        ..other grunt tasks here..
        jsdoc : {
          dist : {
            src: ['src/*.js', 'README.md'],
            options: {
              destination: 'docs',
              configure : "conf.json",
              template: './node_modules/jaguarjs-jsdoc-patched'
            }
          }
        }
      });

    Other task runners should work similarly.

    1. Again assuming you're using grunt-jsdoc, simply run grunt jsdoc!

    License

    This project under the MIT License.

    Install

    npm i jaguarjs-jsdoc-fixed

    DownloadsWeekly Downloads

    1

    Version

    0.1.2

    License

    MIT

    Last publish

    Collaborators

    • bojand