Skip to content

Commit

Permalink
renamed yuidoc-p5-theme-src to yuidoc-p5-theme
Browse files Browse the repository at this point in the history
  • Loading branch information
siv2r committed Dec 21, 2020
1 parent daf4605 commit 321cfe3
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion contributor_docs/inline_documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -273,7 +273,7 @@ Here is an example for a well-documented method. To create a new method, you can

## Generating documentation

* Run `grunt yui:build` once first to generate all local files needed, as well as a copy of the reference from the source code. Run it again anytime you make changes to the core JS files behind the yuidoc reference page. These are changes in files located in the yuidoc-p5-theme-src folder, NOT inline documentation changes to src.
* Run `grunt yui:build` once first to generate all local files needed, as well as a copy of the reference from the source code. Run it again anytime you make changes to the core JS files behind the yuidoc reference page. These are changes in files located in the yuidoc-p5-theme folder, NOT inline documentation changes to src.
* If you only made changes to the source code, you can just run `grunt yui`, though `grunt yui:build` will also do the trick.
* You can run `npm run docs:dev` to launch a live preview of the site that will update each time you make changes. (You will need to refresh the page after making changes to see them appear.)

Expand Down

0 comments on commit 321cfe3

Please sign in to comment.