Repository files navigation

This repository contains the user documentation forJSDoc. Use this repository to reportdocumentation bugs, and to submit pull requests for improving the docs.

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

The HTML docs are generated withEleventy. If you'd like to contribute to the docs, makesure Node.js and npm are installed, then follow these steps:

1. Clone this repository:

   git clone https://github.com/jsdoc/jsdoc.github.io

2. Install dependencies:

   npm install

3. Make your changes in thecontent directory, which contains the source files for the docs.

   The first few lines of each source file containYAML front matter, which is metadata inYAML format. If you need to use the character@ or[ at the start of a YAML value, youcan escape it with a backslash. For example, writetitle: @class astitle: \@class.

4. Rebuild the HTML files, and run a local server so that you can review them:

   npm run serve

5. Review the updated HTML files on the local server, and make sure your changes look okay. Inparticular, if you edited the YAML front matter, make sure your changes are reflected in thegenerated HTML files.

6. Send a pull request with your changes.

Copyright 2011 by thecontributors to the JSDoc documentation.

This repository is licensed under theCreative Commons Attribution-ShareAlike 3.0 Unportedlicense. A copy of the license is included in theLICENSE file.