8000 updated README · jsdoc/jsdoc.github.io@52c138a · GitHub
[go: up one dir, main page]

Skip to content

Commit 52c138a

Browse files
committed
updated README
1 parent a80648f commit 52c138a

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Before editing the user guides for JSDoc 3, please consider these notes:
55
- If you create a new file in the extended documentation then you must create a new `Jake\articles` file and include the extended documentation. See any of the other articles for an example of how it's done.
66
- Giving the article file name an appropriate prefix will automatically add it to the index page. The supported article prefixes are `about-`, `contribute-`, `howto-`, and `plugins-`. Please do not use the `tags-` prefix or your article may be deleted in a future build.
77
- To properly build the documentation you must have both `jsdoc3.github.com` and the `jsdoc` projects as siblings. They must reside beside one another in a parent directory.
8-
- Before committing, build the HTML by running the `jake` command in the `jsdoc3.github.com` project root. All the files will be rebuilt except for the tags definitions. The extended docs will be included but in order to get the definitions you'll have to merge the `show-defined-tags` branch of the `jsdoc` project into jsdoc.
8+
- Before committing, build the **HTML** by running the `jake` command in the `jsdoc3.github.com` project root. All the files will be rebuilt except for the tags definitions. The extended docs will be included but in order to get the definitions you'll have to merge the `show-defined-tags` branch of the `jsdoc` project into jsdoc.
99

1010
See: https://github.com/mde/jake
1111

0 commit comments

Comments
 (0)
0