template:readthedokus
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
template:readthedokus [2022-09-13 07:00] – [20220817] 183.76.206.119 | 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 : 2022-09-13 | + | lastupdate_dt : 2023-08-22 |
- | compatible | + | compatible |
depends | depends | ||
conflicts | conflicts | ||
Line 19: | Line 19: | ||
---- | ---- | ||
- | This is a theme that imitates [[https:// | + | This is a DokuWiki |
- | Featuring: | + | ===== Featuring |
* "Read the Docs" appearance | * "Read the Docs" appearance | ||
* Embedded foldable TOC in the sidebar | * Embedded foldable TOC in the sidebar | ||
* Auto generated " | * Auto generated " | ||
- | |||
- | ===== Releases ====== | ||
- | |||
- | ==== 20220913 ==== | ||
- | |||
- | * Fixed " | ||
- | * Added "Show toolbox even when logged out" option. | ||
- | |||
- | ==== 20220817 ==== | ||
- | |||
- | * Fixed a sidebar style. | ||
- | * Modified to select a corresponding sidebar item when hash is specified in the URL. | ||
- | |||
- | ==== 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 " | ||
- | |||
- | ==== 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. | ||
===== Download and Install ====== | ===== Download and Install ====== | ||
Line 96: | 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 breadcrums|Use Dokuwiki | + | |Use DokuWiki breadcrumbs|Check to use DokuWiki |
- | |Start Page|Set start page url.| | + | |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. | |
- | ===== Template | + | |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 | ||
- | These are some of the options on " | + | These are some of the options on " |
^Option^Description^ | ^Option^Description^ | ||
Line 127: | Line 68: | ||
===== 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 137: | Line 78: | ||
* [[page2]] | * [[page2]] | ||
** Caption2 ** | ** Caption2 ** | ||
- | * [[page3]] | + | * page3 |
- | * [[page4]] | + | * page4 |
</ | </ | ||
- | ==== Previous/ | ||
- | Previous/ | + | Some index plugins are supported |
- | ==== No link to login page === | + | |
- | This theme doesn' | + | * [[doku> |
+ | * [[doku> | ||
+ | * [[doku> | ||
+ | * [[doku> | ||
+ | ==== Previous/ | ||
+ | |||
+ | Previous/ | ||
+ | ==== Link to Login Page === | ||
+ | |||
+ | This theme doesn' | ||
==== Admonitions ==== | ==== Admonitions ==== | ||
Line 164: | Line 112: | ||
* tip | * tip | ||
- | You can use "Wrap Plugin" | + | You can use "[[doku> |
< | < | ||
Line 172: | Line 120: | ||
</ | </ | ||
- | If you use the plugin, do not forget to add classes (admonition, | + | If you use the plugin, do not forget to add classes (admonition, |
- | + | ||
- | ==== Recommended options === | + | |
- | + | ||
- | ^Option^Value^Description^ | + | |
- | |useheading|on|Breadcrumbs on the page header looks nicer.| | + | |
===== Customization ===== | ===== Customization ===== | ||
Line 190: | Line 132: | ||
==== Using Google Fonts ==== | ==== Using Google Fonts ==== | ||
- | Also, you can use google fonts for better looking. Lato and Robot fonts are set in font-family in this theme CSS. If you decide to use it, check the option in the configuration manager to enable it. Change the tags in the following option. | + | Also, you can use google fonts for better looking. |
- | ==== Adding a fixed header/footer | + | ==== Adding a Fixed Header/Footer |
- | This theme supports a fixed header and footer. On the " | + | This theme supports a fixed header and footer. On the " |
=== 1. Set header/ | === 1. Set header/ | ||
- | These values must be valid css values. | + | These values must be valid CSS values. |
e.g. " | e.g. " | ||
Line 204: | Line 146: | ||
=== 2. Create header.html/ | === 2. Create header.html/ | ||
- | Create a file " | + | Create a file " |
Here is a sample header.html. This example also shows how to toggle a sidebar. Clicking the string " | Here is a sample header.html. This example also shows how to toggle a sidebar. Clicking the string " | ||
Line 228: | Line 170: | ||
</ | </ | ||
- | 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 menu add below to CSS file (dokuwiki | + | 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 menu add below to the CSS file (DokuWiki |
< | < | ||
Line 236: | Line 178: | ||
</ | </ | ||
- | ==== Centering the content | + | ==== Centering the Content |
To center the content, enter the content width in the "Site width" option on the " | To center the content, enter the content width in the "Site width" option on the " | ||
Line 278: | Line 220: | ||
[8] ... footer.html | [8] ... footer.html | ||
</ | </ | ||
+ | |||
+ | ===== Releases ====== | ||
+ | |||
+ | {{rss> | ||
+ | ==== 20221122 ==== | ||
+ | |||
+ | * Refactored sidebar styles. Now <li> elements without links are indented properly. | ||
+ | * Modified to support the nspages plugin. | ||
+ | |||
+ | ==== 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 in the URL. | ||
+ | |||
+ | ==== 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 " | ||
+ | |||
+ | ==== 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.1663045221.txt.gz · Last modified: 2022-09-13 07:00 by 183.76.206.119