Docs: Update THEMING.MD #1026
Merged
Docs: Update THEMING.MD #1026
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add instructions to effectively fork the default theme for the purpose of creating and using your own custom theme.
tmcw
reviewed
Feb 28, 2018
docs/THEMING.md
Outdated
|
|
||
| - In the folder you created, replace `require('../')` on lines 10 and 11 of `index.js` with `require('documentation')` and save. | ||
|
|
||
| - You can now make changes that will show up when you generate your docs using your theme. Example `package.json` `scripts` entry: `"node_modules/.bin/documentation build index.js -f html -o docs --theme node_modules/docjs-theme"` |
There was a problem hiding this comment.
Looks good, but I think this bit's extraneous: if it's an an npm script, ./node_modules/.bin/ is automatically added to the path resolution, so you should be able to just refer to documentation, not the full relative path.
Chanted the script line example to use documentation instead of referring to the node_modules bin folder.
|
@tmcw Updated per your feedback (or I think so, this is my first PR) |
|
Glad I could help (I think) - I am a huge fan of Observable and your work, thanks for making DocumentationJS! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add instructions to effectively fork the default theme for the purpose of creating and using your own custom theme.