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.jsshipped 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
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.4.tar.gz
(2.8 MB
view details)
Built Distribution
File details
Details for the file mkdocs_rtd-0.0.4.tar.gz.
File metadata
- Download URL: mkdocs_rtd-0.0.4.tar.gz
- Upload date:
- Size: 2.8 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.6.1 CPython/3.8.10 Linux/5.15.0-1046-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 273189105f0e99d68e42f062212182402725a49a3ba6c49e6c250dbb4af83eab |
|
| MD5 | 162edd0f1f63b92a722ff9ddd2a22f2f |
|
| BLAKE2b-256 | 274fe9f027820d609e5e0296204f4d2a71b340fa8dd54412e80902b71b94eeaa |
File details
Details for the file mkdocs_rtd-0.0.4-py3-none-any.whl.
File metadata
- Download URL: mkdocs_rtd-0.0.4-py3-none-any.whl
- Upload date:
- Size: 2.8 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.6.1 CPython/3.8.10 Linux/5.15.0-1046-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | c13422c5786896971e663cc8f2657d021aa583221d4bd1a97dda579c09398f80 |
|
| MD5 | 9dd949b228c0592f148694a77a720cce |
|
| BLAKE2b-256 | 6d237e52b8b9b21732579e782ef2ea32e0a4849b1c4e645f9745fde390740ab5 |
