JSDoc 3 website
HTML JavaScript CSS
Latest commit 0ea6199 Mar 29, 2017 @ght ght committed with hegemonic Fix redirected articles being used in 'related'. Fixes missing link t…
…ext in about-namepaths.html (#135)

fix related using redirected articles; fixes missing link text
Permalink
Failed to load latest commit information.
content/en Fix redirected articles being used in 'related'. Fixes missing link t… Mar 29, 2017
data show how to document ES 2015 classes and modules (#110, #113) Nov 10, 2015
images use locally hosted SVG version of CC license badge (#70) Dec 5, 2014
lib separate block tags from inline tags (#79) Dec 30, 2014
scripts add print version of html5shiv Jun 15, 2014
styles improve appearance of `code` element Feb 1, 2015
views update copyright date Feb 16, 2017
.eslintrc update ESLint config to match new rule name Dec 30, 2014
.gitignore Replace Jake with Metalsmith/gulp; convert content to Markdown Jun 9, 2014
.nojekyll fix GitHub Pages build errors Jun 10, 2014
CNAME Moved user guides from micmath.github.com. Oct 22, 2012
LICENSE Replace Jake with Metalsmith/gulp; convert content to Markdown Jun 9, 2014
README.md Replace Jake with Metalsmith/gulp; convert content to Markdown Jun 9, 2014
about-block-inline-tags.html update copyright date Feb 16, 2017
about-commandline.html update copyright date Feb 16, 2017
about-configuring-default-template.html update copyright date Feb 16, 2017
about-configuring-jsdoc.html update copyright date Feb 16, 2017
about-getting-started.html clean up the getting started page (#123) Mar 11, 2017
about-including-package.html update copyright date Feb 16, 2017
about-including-readme.html update copyright date Feb 16, 2017
about-inline-tags.html separate block tags from inline tags (#79) Dec 30, 2014
about-license-jsdoc3.html update copyright date Feb 16, 2017
about-namepaths.html Fix redirected articles being used in 'related'. Fixes missing link t… Mar 29, 2017
about-plugins.html update copyright date Feb 16, 2017
about-tutorials.html update copyright date Feb 16, 2017
bower.json Replace Jake with Metalsmith/gulp; convert content to Markdown Jun 9, 2014
gulpfile.js update dependencies Jul 30, 2015
howto-amd-modules.html update copyright date Feb 16, 2017
howto-commonjs-modules.html update copyright date Feb 16, 2017
howto-es2015-classes.html update copyright date Feb 16, 2017
howto-es2015-modules.html fix spelling (#122) Mar 11, 2017
index.html update copyright date Feb 16, 2017
package.json update dependencies Jul 30, 2015
plugins-markdown.html update copyright date Feb 16, 2017
tags-abstract.html update copyright date Feb 16, 2017
tags-access.html update copyright date Feb 16, 2017
tags-alias.html update copyright date Feb 16, 2017
tags-augments.html update copyright date Feb 16, 2017
tags-author.html update copyright date Feb 16, 2017
tags-borrows.html update copyright date Feb 16, 2017
tags-callback.html update copyright date Feb 16, 2017
tags-class.html update copyright date Feb 16, 2017
tags-classdesc.html update copyright date Feb 16, 2017
tags-constant.html update copyright date Feb 16, 2017
tags-constructor.html add "do not edit" banner to generated HTML files Nov 30, 2014
tags-constructs.html update copyright date Feb 16, 2017
tags-copyright.html update copyright date Feb 16, 2017
tags-default.html update copyright date Feb 16, 2017
tags-deprecated.html update copyright date Feb 16, 2017
tags-description.html update copyright date Feb 16, 2017
tags-enum.html update copyright date Feb 16, 2017
tags-event.html update copyright date Feb 16, 2017
tags-example.html update copyright date Feb 16, 2017
tags-exports.html update copyright date Feb 16, 2017
tags-external.html update copyright date Feb 16, 2017
tags-file.html update copyright date Feb 16, 2017
tags-fires.html update copyright date Feb 16, 2017
tags-function.html update copyright date Feb 16, 2017
tags-global.html update copyright date Feb 16, 2017
tags-ignore.html update copyright date Feb 16, 2017
tags-implements.html update copyright date Feb 16, 2017
tags-inheritdoc.html update copyright date Feb 16, 2017
tags-inline-link.html update copyright date Feb 16, 2017
tags-inline-tutorial.html update copyright date Feb 16, 2017
tags-inner.html update copyright date Feb 16, 2017
tags-instance.html update copyright date Feb 16, 2017
tags-interface.html update copyright date Feb 16, 2017
tags-kind.html update copyright date Feb 16, 2017
tags-lends.html update copyright date Feb 16, 2017
tags-license.html update copyright date Feb 16, 2017
tags-link.html separate block tags from inline tags (#79) Dec 30, 2014
tags-listens.html update copyright date Feb 16, 2017
tags-member.html update copyright date Feb 16, 2017
tags-memberof.html update copyright date Feb 16, 2017
tags-method.html add "do not edit" banner to generated HTML files Nov 30, 2014
tags-mixes.html update copyright date Feb 16, 2017
tags-mixin.html update copyright date Feb 16, 2017
tags-module.html update copyright date Feb 16, 2017
tags-name.html update copyright date Feb 16, 2017
tags-namespace.html fix typo in namespace tag Feb 27, 2017
tags-override.html update copyright date Feb 16, 2017
tags-param.html update copyright date Feb 16, 2017
tags-private.html update copyright date Feb 16, 2017
tags-property.html update copyright date Feb 16, 2017
tags-protected.html update copyright date Feb 16, 2017
tags-public.html update copyright date Feb 16, 2017
tags-readonly.html update copyright date Feb 16, 2017
tags-requires.html update copyright date Feb 16, 2017
tags-returns.html update copyright date Feb 16, 2017
tags-see.html update copyright date Feb 16, 2017
tags-since.html update copyright date Feb 16, 2017
tags-static.html update copyright date Feb 16, 2017
tags-summary.html update copyright date Feb 16, 2017
tags-this.html update copyright date Feb 16, 2017
tags-throws.html update copyright date Feb 16, 2017
tags-todo.html update copyright date Feb 16, 2017
tags-tutorial.html update copyright date Feb 16, 2017
tags-type.html update copyright date Feb 16, 2017
tags-typedef.html add missing parameter Feb 23, 2017
tags-variation.html update copyright date Feb 16, 2017
tags-version.html update copyright date Feb 16, 2017

README.md

This repository contains the user documentation for JSDoc 3. Use this repository to report documentation bugs, and to submit pull requests for improving the docs.

If you just want to read the documentation, please visit Use JSDoc.

Contributing to the documentation

The HTML docs are generated with Metalsmith and Gulp. If you'd like to contribute to the docs, make sure Node.js and npm are installed, then follow these steps:

  1. Clone this repository:

     git@github.com:jsdoc3/jsdoc3.github.com.git
    
  2. Install Bower and Gulp globally:

     npm install -g gulp
     npm install -g bower
    
  3. Install the dependencies:

     npm install
     bower install
    
  4. Make your changes in the content directory, which contains the source files for the docs.

    The first few lines of each source file contain YAML front matter, which is metadata in YAML format. If you need to use the character @ or [ at the start of a YAML value, you can escape it with a backslash. For example, write title: @class as title: \@class.

  5. Rebuild the HTML files:

     gulp
    
  6. Review the updated HTML files, and make sure your changes look okay. In particular, if you edited the YAML front matter, make sure your changes are reflected in the generated HTML files.

  7. Submit a pull request with your changes.

Legal stuff

Copyright (c) 2011-2014 by Michael Mathews and the JSDoc 3 documentation contributors.

This repository is licensed under the Creative Commons Attribution-ShareAlike 3.0 Unported license. A copy of the license is included in the LICENSE file.