actions
/
mdBook
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update theme CSS docs. (#1431)

This commit is contained in:
Eric Huss 2021-01-06 16:56:20 -08:00 committed by GitHub
parent 77e7cfd22b
commit 3d55375f61
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
guide/src/format/theme/README.md
View File

@ -14,9 +14,11 @@ Here are the files you can override:
- **_index.hbs_** is the handlebars template. - **_index.hbs_** is the handlebars template.
- **_head.hbs_** is appended to the HTML `<head>` section. - **_head.hbs_** is appended to the HTML `<head>` section.
- **_header.hbs_** content is appended on top of every book page. - **_header.hbs_** content is appended on top of every book page.
- **_book.css_** is the style used in the output. If you want to change the - **_css/_** contains the CSS files for styling the book.
design of your book, this is probably the file you want to modify. Sometimes - **_css/chrome.css_** is for UI elements.
in conjunction with `index.hbs` when you want to radically change the layout. - **_css/general.css_** is the base styles.
- **_css/print.css_** is the style for printer output.
- **_css/variables.css_** contains variables used in other CSS files.
- **_book.js_** is mostly used to add client side functionality, like hiding / - **_book.js_** is mostly used to add client side functionality, like hiding /
un-hiding the sidebar, changing the theme, ... un-hiding the sidebar, changing the theme, ...
- **_highlight.js_** is the JavaScript that is used to highlight code snippets, - **_highlight.js_** is the JavaScript that is used to highlight code snippets,