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.3.tar.gz
(2.8 MB
view details)
Built Distribution
File details
Details for the file mkdocs_rtd-0.0.3.tar.gz.
File metadata
- Download URL: mkdocs_rtd-0.0.3.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 | 151ca349d5fc8073e27c4808f614965233239b005ab7a528d48b66b014551267 |
|
| MD5 | a3c50128eefa0e919a460e60bd68847b |
|
| BLAKE2b-256 | bdcb35c00d810b6a4fb8f28d8a4189adcecbd004b52942c9d88be40a308f1d92 |
File details
Details for the file mkdocs_rtd-0.0.3-py3-none-any.whl.
File metadata
- Download URL: mkdocs_rtd-0.0.3-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 | 25a1173f782b93c90b55156468e27b3b7e9f3f58da475e5e449376f15d64b31a |
|
| MD5 | 7e51014082545d5c00590242284e95f2 |
|
| BLAKE2b-256 | 7ef6987fe66ee9c28b0775834a84db818e6fe648049002a9f3bc8c119535f826 |
