|
1 |
| -This repository contains the user documentation for [JSDoc 3][jsdoc]. Use this repository to report |
| 1 | +This repository contains the user documentation for [JSDoc][jsdoc]. Use this repository to report |
2 | 2 | documentation bugs, and to submit pull requests for improving the docs.
|
3 | 3 |
|
4 | 4 | If you just want to read the documentation, please visit [Use JSDoc][use-jsdoc].
|
5 | 5 |
|
6 |
| - |
7 | 6 | ## Contributing to the documentation
|
8 | 7 |
|
9 |
| -The HTML docs are generated with [Metalsmith][] and [Gulp][]. If you'd like to contribute to the |
10 |
| -docs, make sure Node.js and npm are installed, then follow these steps: |
11 |
| - |
12 |
| -1. Clone this repository: |
13 |
| - |
14 |
| - [email protected]:jsdoc3/jsdoc3.github.com.git |
| 8 | +The HTML docs are generated with [Eleventy][eleventy]. If you'd like to contribute to the docs, make |
| 9 | +sure Node.js and npm are installed, then follow these steps: |
15 | 10 |
|
16 |
| -2. Install Bower and Gulp globally: |
| 11 | +1. Clone this repository: |
17 | 12 |
|
18 |
| - npm install -g gulp |
19 |
| - npm install -g bower |
| 13 | + ``` |
| 14 | + git clone https://github.com/jsdoc/jsdoc.github.io |
| 15 | + ``` |
20 | 16 |
|
21 |
| -3. Install the dependencies: |
| 17 | +2. Install dependencies: |
22 | 18 |
|
23 |
| - npm install |
24 |
| - bower install |
| 19 | + ``` |
| 20 | + npm install |
| 21 | + ``` |
25 | 22 |
|
26 |
| -4. Make your changes in the `content` directory, which contains the source files for the docs. |
| 23 | +3. Make your changes in the `content` directory, which contains the source files for the docs. |
27 | 24 |
|
28 | 25 | The first few lines of each source file contain [YAML][] front matter, which is metadata in
|
29 | 26 | [YAML][] format. If you need to use the character `@` or `[` at the start of a YAML value, you
|
30 | 27 | can escape it with a backslash. For example, write `title: @class` as `title: \@class`.
|
31 | 28 |
|
32 |
| -5. Rebuild the HTML files: |
| 29 | +4. Rebuild the HTML files, and run a local server so that you can review them: |
33 | 30 |
|
34 |
| - gulp |
| 31 | + ``` |
| 32 | + npm run serve |
| 33 | + ``` |
35 | 34 |
|
36 |
| -6. Review the updated HTML files, and make sure your changes look okay. In particular, if you edited |
37 |
| -the YAML front matter, make sure your changes are reflected in the generated HTML files. |
38 | 35 |
|
39 |
| -7. Submit a pull request with your changes. |
| 36 | +5. Review the updated HTML files on the local server, and make sure your changes look okay. In |
| 37 | + particular, if you edited the YAML front matter, make sure your changes are reflected in the |
| 38 | + generated HTML files. |
40 | 39 |
|
| 40 | +6. Send a pull request with your changes. |
41 | 41 |
|
42 | 42 | ## Legal stuff
|
43 | 43 |
|
44 |
| -Copyright (c) 2011-2014 by Michael Mathews and the JSDoc 3 documentation [contributors][]. |
| 44 | +Copyright 2011 by the [contributors][] to the JSDoc documentation. |
45 | 45 |
|
46 | 46 | This repository is licensed under the [Creative Commons Attribution-ShareAlike 3.0 Unported][cc]
|
47 | 47 | license. A copy of the license is included in the [`LICENSE` file][license].
|
48 | 48 |
|
49 | 49 | [cc]: https://creativecommons.org/licenses/by-sa/3.0/legalcode
|
50 | 50 | [contributors]: https://github.com/jsdoc/jsdoc.github.io/graphs/contributors
|
51 |
| -[Gulp]: https://gulpjs.com/ |
| 51 | +[eleventy]: https://www.11ty.dev/ |
52 | 52 | [jsdoc]: https://github.com/jsdoc/jsdoc
|
53 | 53 | [license]: https://github.com/jsdoc/jsdoc.github.io/LICENSE
|
54 |
| -[Metalsmith]: https://www.metalsmith.io/ |
55 | 54 | [use-jsdoc]: https://jsdoc.app/
|
56 |
| -[YAML]: https://www.yaml.org/spec/1.2/spec.html |
| 55 | +[YAML]: https://yaml.org/spec/1.2.2/ |
0 commit comments