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.9.tar.gz
(2.8 MB
view hashes)
Built Distribution
Close
Hashes for mkdocs_rtd-0.0.9-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0321f208da78460eab0e3d42a6ace7801190489834a94a96d8a53c40723e82fa |
|
MD5 | c3d29c6d190e073fc030ad68ab0a2148 |
|
BLAKE2b-256 | a4c59ea8752d8119c51cbc29048347caf0c0262a780304992a7144b8d19f04af |