Skip to content

Commit bf265cb

Browse files
committed
chore: update README
1 parent 68fc050 commit bf265cb

File tree

1 file changed

+23
-24
lines changed

1 file changed

+23
-24
lines changed

Diff for: README.md

+23-24
Original file line numberDiff line numberDiff line change
@@ -1,56 +1,55 @@
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
22
documentation bugs, and to submit pull requests for improving the docs.
33

44
If you just want to read the documentation, please visit [Use JSDoc][use-jsdoc].
55

6-
76
## Contributing to the documentation
87

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:
1510

16-
2. Install Bower and Gulp globally:
11+
1. Clone this repository:
1712

18-
npm install -g gulp
19-
npm install -g bower
13+
```
14+
git clone https://github.com/jsdoc/jsdoc.github.io
15+
```
2016
21-
3. Install the dependencies:
17+
2. Install dependencies:
2218
23-
npm install
24-
bower install
19+
```
20+
npm install
21+
```
2522
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.
2724
2825
The first few lines of each source file contain [YAML][] front matter, which is metadata in
2926
[YAML][] format. If you need to use the character `@` or `[` at the start of a YAML value, you
3027
can escape it with a backslash. For example, write `title: @class` as `title: \@class`.
3128
32-
5. Rebuild the HTML files:
29+
4. Rebuild the HTML files, and run a local server so that you can review them:
3330
34-
gulp
31+
```
32+
npm run serve
33+
```
3534
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.
3835
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.
4039
40+
6. Send a pull request with your changes.
4141
4242
## Legal stuff
4343
44-
Copyright (c) 2011-2014 by Michael Mathews and the JSDoc 3 documentation [contributors][].
44+
Copyright 2011 by the [contributors][] to the JSDoc documentation.
4545
4646
This repository is licensed under the [Creative Commons Attribution-ShareAlike 3.0 Unported][cc]
4747
license. A copy of the license is included in the [`LICENSE` file][license].
4848
4949
[cc]: https://creativecommons.org/licenses/by-sa/3.0/legalcode
5050
[contributors]: https://github.com/jsdoc/jsdoc.github.io/graphs/contributors
51-
[Gulp]: https://gulpjs.com/
51+
[eleventy]: https://www.11ty.dev/
5252
[jsdoc]: https://github.com/jsdoc/jsdoc
5353
[license]: https://github.com/jsdoc/jsdoc.github.io/LICENSE
54-
[Metalsmith]: https://www.metalsmith.io/
5554
[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

Comments
 (0)