diff --git a/docs/THEMING.md b/docs/THEMING.md index 052f6dc2a..cd9761c9f 100644 --- a/docs/THEMING.md +++ b/docs/THEMING.md @@ -33,6 +33,35 @@ for some ideas. - You can now make changes that will show up when you generate your docs using your theme. Example `package.json` `scripts` entry: `"documentation build index.js -f html -o docs --theme node_modules/docjs-theme"` +#### Changes to Default Theme Via documentation.yml +If a documentation.yml file is used to establish a table of contents for your documentation, small changes to the default style can be made via a + + + ### Sub Section header + Text that describes the section and sub-section here. +``` +Any changes to elements and classes that also exist in the standard theme will be overwridden by what is in the documentation.yml. This opens up the possiblitity of the same CSS being defined twice, which can be confusing and is not best practice. However, it is easy to change HTML style this way. Recommend only using classes defined this way that do not exist in the standard documentation.js theme. + ### Theming Markdown The default Markdown generator for documentation.js isn't customizable - instead