A fork of mkdocs readthedocs theme to make it work with mkapi
Project description
mkdocs-rtd
A fork of mkdocs readthedocs theme to make it work better, especially with mkapi.
Why just use extra_css
and extra_javascript
?
- The javascript written in
theme.js
shipped with the original theme has problems expanding the sidebar items and it's not easy to fix it only usingextra_javascript
.
Installation
pip install -U mkdocs-rtd
Usage
theme:
name: rtd
All options are the same when using the original theme (readthedocs
). See also:
https://www.mkdocs.org/user-guide/choosing-your-theme/#readthedocs
Modifications
- Add social icons (only Github supported now) to the top right corner of the page.
- Adjust some styles
- Open external links in new tab by default
- Do not reset side nav items when url hash is
#
or empty - Make search box sticky
- Add css support for
pymdownx.blocks.tab
(must usealternate_style: true
) - Set
ignoreUnescapedHTML
totrue
forhljs
- Keep current sidebar item always in view when scrolling
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
mkdocs_rtd-0.0.8.tar.gz
(2.8 MB
view hashes)
Built Distribution
Close
Hashes for mkdocs_rtd-0.0.8-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | bb0c5f448bc28118fc921cee2bb28808cff08125dab3ed6591533559584eddc4 |
|
MD5 | aeeaafe3001089873843fe51e6298b62 |
|
BLAKE2b-256 | 72da63ac495f48db5b557023ad0bf148422954182cf9d5ea292d0309472ed5d4 |