template:readthedokus
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
template:readthedokus [2021-06-24 10:05] – [Sites using this Template] my17560 | template:readthedokus [2024-01-29 17:57] (current) – [Adding a Fixed Header/Footer] coldscientist | ||
---|---|---|---|
Line 2: | Line 2: | ||
---- template ---- | ---- template ---- | ||
- | description | + | description |
author | author | ||
email : my17560@gmail.com | email : my17560@gmail.com | ||
- | lastupdate_dt : 2021-06-24 | + | lastupdate_dt : 2023-08-22 |
- | compatible | + | compatible |
depends | depends | ||
conflicts | conflicts | ||
Line 19: | Line 19: | ||
---- | ---- | ||
- | This is a theme that mimics | + | This is a DokuWiki |
+ | ===== Featuring ===== | ||
* "Read the Docs" appearance | * "Read the Docs" appearance | ||
* Embedded foldable TOC in the sidebar | * Embedded foldable TOC in the sidebar | ||
Line 31: | Line 32: | ||
* [[https:// | * [[https:// | ||
- | Refer to [[: | + | Refer to [[: |
- | ===== Sites using this Template ===== | + | ===== Sites Using This Template ===== |
- | * [[https:// | + | Please feel free to add your sites here or ask me via e-mail or GitHub issues. |
- | ===== Template | + | * Web Components Based Javascript Framework [[https:// |
+ | |||
+ | ===== Template | ||
These are template settings for this theme. | These are template settings for this theme. | ||
^Option^Description^ | ^Option^Description^ | ||
- | |Sidebar position|" | + | |Sidebar position|Choose |
- | + | |Use DokuWiki breadcrumbs|Check to use DokuWiki style breadcrumbs.| | |
+ | |Show toolbox even when logged out|Check to show the Toolbox always. By default, it is not shown unless you log in.| | ||
+ | |Start Page|Set start page URL. This page is shown when the " | ||
+ | |Enable Font Awesome|Check if you want to use Font Awesome. | ||
+ | |Specify a tag to include Font Awesome|Specify tags to include FontAwesome.The tags specified here are put in the head tag.| | ||
+ | |Enable Google Fonts|Check if you want to use Google Fonts. Don't forget to put the necessary tags in the option below. Technically, | ||
+ | |Specify tags to include Google Fonts|Specify tags to include Google Fonts. | ||
+ | ===== Template Variables ===== | ||
- | ===== Template variables ===== | + | These are some of the options on " |
- | + | ||
- | These are some of the options on " | + | |
^Option^Description^ | ^Option^Description^ | ||
Line 55: | Line 62: | ||
|Side bar width|Sidebar width.| | |Side bar width|Sidebar width.| | ||
|Header height|Header height. The theme puts padding on the top of the page according to this value.| | |Header height|Header height. The theme puts padding on the top of the page according to this value.| | ||
- | |Footer height|Footer height. | + | |Footer height|Footer height. |
- | |CSS breakpoint for smart phones|Screen size less than this value will be treated as a smartphone.| | + | |CSS breakpoint for smartphones |
|CSS breakpoint for tablets|Screen size less than this value will be treated as a tablet. | | |CSS breakpoint for tablets|Screen size less than this value will be treated as a tablet. | | ||
===== Notes ===== | ===== Notes ===== | ||
- | ==== Sidebar | + | ==== Sidebar |
- | Use strong for captions, lists of links for items. Anything other than that won't be styled, so use your own styles for them. | + | Use strong for captions, |
E.g. | E.g. | ||
Line 71: | Line 78: | ||
* [[page2]] | * [[page2]] | ||
** Caption2 ** | ** Caption2 ** | ||
- | * [[page3]] | + | * page3 |
- | * [[page4]] | + | * page4 |
</ | </ | ||
- | ==== Previous/ | ||
- | Previous/ | + | Some index plugins are supported by this template and can be used in the sidebar. |
- | ==== No link to login page === | + | |
- | This theme doesn' | + | * [[doku> |
+ | * [[doku> | ||
+ | * [[doku> | ||
+ | * [[doku> | ||
- | ==== Recommended options | + | ==== Previous/ |
- | ^Option^Value^Description^ | + | Previous/ |
- | |useheading|on|Breadcrumbs | + | ==== Link to Login Page === |
+ | This theme doesn' | ||
+ | ==== Admonitions ==== | ||
+ | |||
+ | This theme has "Read The Docs" style admonitions. To use them, wrap a content with a div that has a class " | ||
+ | |||
+ | E.g. | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | </ | ||
+ | </ | ||
+ | |||
+ | Types are: | ||
+ | * danger | ||
+ | * caution | ||
+ | * note | ||
+ | * tip | ||
+ | |||
+ | You can use " | ||
+ | |||
+ | < | ||
+ | <WRAP admonition note> | ||
+ | Note! | ||
+ | </ | ||
+ | </ | ||
+ | |||
+ | If you use the plugin, do not forget to add classes (admonition, | ||
===== Customization ===== | ===== Customization ===== | ||
Line 91: | Line 126: | ||
==== Using Font Awesome ==== | ==== Using Font Awesome ==== | ||
- | This theme uses Font Awesome. The file is not included, so you need to include | + | Even though this theme works without |
- | === Hide substitusions === | + | A home icon will appear beside the title, and +/- buttons on TOC, a mobile menu button will be replaced by Font Awesome. |
- | The theme has minimum substitutions (for +/- buttons on TOC and a mobile menu button) and they are visible by default. To make them invisible, you need to add CSS below to userall.css. Otherwise, both Font Awesome and substitutions are shown at the same time. | + | ==== Using Google Fonts ==== |
- | < | + | Also, you can use google fonts for better looking. ' |
- | #dw__toc .btn-expand img { | + | |
- | | + | ==== Adding a Fixed Header/ |
+ | |||
+ | This theme supports a fixed header and footer. On the " | ||
+ | |||
+ | === 1. Set header/ | ||
+ | |||
+ | These values must be valid CSS values. | ||
+ | |||
+ | e.g. " | ||
+ | |||
+ | === 2. Create header.html/ | ||
+ | |||
+ | Create a file " | ||
+ | |||
+ | Here is a sample header.html. This example also shows how to toggle a sidebar. Clicking the string " | ||
+ | |||
+ | < | ||
+ | <div onclick=" | ||
+ | < | ||
+ | header > div { | ||
+ | background-color: | ||
+ | position: fixed; | ||
+ | height: 50px; | ||
+ | left: 0; | ||
+ | top: 0; | ||
+ | right: 0; | ||
} | } | ||
+ | </ | ||
+ | < | ||
+ | function toggleMenu() | ||
+ | { | ||
+ | dokus.toggleSidebar(); | ||
+ | } | ||
+ | </ | ||
+ | </ | ||
- | # | + | You might want to hide a mobile menu since both the sticky header and the mobile menu are displayed at the same time on mobile devices. To hide the mobile |
- | display: none; | + | |
+ | < | ||
+ | # | ||
+ | display: none; | ||
} | } | ||
</ | </ | ||
- | ==== Using Google Fonts ==== | + | ==== Centering the Content |
- | Since the original | + | To center the content, enter the content width in the "Site width" option on the "Template Style Settings" |
- | < | + | ==== Include Hooks ==== |
- | <link href=' | + | |
- | <link href=' | + | The theme has some include-hooks. |
+ | |||
+ | < | ||
+ | +--------------------------------------------------+ | ||
+ | | | ||
+ | +-------------+------------------------------------+ | ||
+ | | Title | Docs > Page Title | | ||
+ | |( | ||
+ | | | ||
+ | +-------------+ | ||
+ | | | ||
+ | | | ||
+ | | | ||
+ | | | ||
+ | | | ||
+ | | | ||
+ | | | ||
+ | | | ||
+ | | | ||
+ | | | ||
+ | +-------------+ | ||
+ | | | ||
+ | +-------------+------------------------------------+ | ||
+ | | | ||
+ | +--------------------------------------------------+ | ||
+ | |||
+ | |||
+ | [1] ... header.html | ||
+ | [2] ... sidebarheader.html | ||
+ | [3] ... sidebartop.html | ||
+ | [4] ... sidebarbottom.html | ||
+ | [5] ... sidebarfooter.html | ||
+ | [6] ... pageheader.html | ||
+ | [7] ... pagefooter.html | ||
+ | [8] ... footer.html | ||
</ | </ | ||
- | ==== Adding a header/ | ||
- | This theme supports a fixed header and footer. On the " | + | ===== Releases ====== |
- | ==== Centering the content | + | {{rss> |
+ | ==== 20221122 | ||
- | To center | + | * Refactored sidebar styles. Now <li> elements without links are indented properly. |
+ | * Modified to support | ||
+ | |||
+ | ==== 20220913 ==== | ||
+ | |||
+ | * Fixed " | ||
+ | * Added "Show toolbox even when logged out" option. | ||
+ | |||
+ | ==== 20220817 ==== | ||
+ | |||
+ | * Fixed a sidebar style. | ||
+ | * Modified to select a corresponding sidebar item when a hash is specified | ||
+ | |||
+ | ==== 20220813 ==== | ||
+ | |||
+ | * Added styles to links to non-existent pages. | ||
+ | * Fixed warnings when index key doesn' | ||
+ | |||
+ | ==== 20220511 ==== | ||
+ | |||
+ | * Modified to support the simplenavi plugin. | ||
+ | |||
+ | ==== 20220413 ==== | ||
+ | |||
+ | * Modified the way to handle same page jump. | ||
+ | |||
+ | ==== 20220228 ==== | ||
+ | |||
+ | * Modified to make "Table of Contents" | ||
+ | * Fixed a TOC embedded in the wrong place in some cases. | ||
+ | |||
+ | ==== 20220219 ==== | ||
+ | |||
+ | * Modified to be able to render a hierarchical sidebar. | ||
+ | * Fixed to show "Edit this page" link only when the current user is editable. | ||
+ | * Modified to make non-admin pages localizable. | ||
+ | * Added "max-width: 100%" | ||
+ | |||
+ | ==== 20220208 ==== | ||
+ | |||
+ | * Removed " | ||
+ | |||
+ | ==== 20220207 ==== | ||
+ | |||
+ | * Added "Use DokuWiki breadcrumbs" | ||
+ | * Added "Start Page" option to specify start page. | ||
+ | * Google Fonts/Font Awesome location now defaults to blank to avoid using them via CDN easily since using CDN could be illegal in some countries. | ||
+ | |||
+ | ==== 20220106 ==== | ||
+ | |||
+ | * Added Font Awesome/ | ||
+ | |||
+ | ==== 20211011 ==== | ||
+ | |||
+ | * Fixed TOC embedding didn't work when the defer_js option is disabled. | ||
+ | |||
+ | ==== 20210917 ==== | ||
+ | |||
+ | * Fixed showing two vertical scrollbars on the mobile pages. | ||
+ | |||
+ | ==== 20210910 ==== | ||
+ | |||
+ | * Fixed the dynamic search result didn't show up. | ||
+ | * Fixed style.ini referencing missing files. | ||
template/readthedokus.1624521951.txt.gz · Last modified: 2021-06-24 10:05 by my17560