Skip to content
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions docs/THEMING.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,16 @@ The theme is free to implement HTML generation however it chooses. See
[the default theme](https://github.com/documentationjs/documentation/tree/master/src/default_theme)
for some ideas.

### Customizing the Default Theme

**Instructions**

- Copy contents of `default_theme` folder (noted above) into a new folder in your project. One way to do it is to create a new git repository with the folder contents and add this line to your `package.json` `devDependencies` section: `"docjs-theme": "my-gh-username/reponame"`. That way when you install dependencies, your new theme will be in the projects `node_modules` folder.

- 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"`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.


### Theming Markdown

The default Markdown generator for documentation.js isn't customizable - instead
Expand Down