Name | mkdocs-rtd JSON |
Version |
0.0.14
JSON |
| download |
home_page | None |
Summary | A fork of mkdocs readthedocs theme to make it work with mkapi |
upload_time | 2024-04-15 23:08:41 |
maintainer | None |
docs_url | None |
author | pwwang |
requires_python | <4.0,>=3.7 |
license | MIT |
keywords |
|
VCS |
|
bugtrack_url |
|
requirements |
No requirements were recorded.
|
Travis-CI |
No Travis.
|
coveralls test coverage |
No coveralls.
|
# 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 using `extra_javascript`.
## Installation
```bash
pip install -U mkdocs-rtd
```
## Usage
```yaml
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 use `alternate_style: true`)
- Set `ignoreUnescapedHTML` to `true` for `hljs`
- Keep current sidebar item always in view when scrolling
Raw data
{
"_id": null,
"home_page": null,
"name": "mkdocs-rtd",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.7",
"maintainer_email": null,
"keywords": null,
"author": "pwwang",
"author_email": "pwwang@pwwang.com",
"download_url": "https://files.pythonhosted.org/packages/9b/ef/a27767b9ddc9cd41b80fe15f74846f38fde62bb4fb70dc126ecc907ac608/mkdocs_rtd-0.0.14.tar.gz",
"platform": null,
"description": "# mkdocs-rtd\n\nA fork of mkdocs readthedocs theme to make it work better, especially with mkapi.\n\nWhy just use `extra_css` and `extra_javascript`?\n\n- 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 using `extra_javascript`.\n\n## Installation\n\n```bash\npip install -U mkdocs-rtd\n```\n\n## Usage\n\n```yaml\ntheme:\n name: rtd\n```\n\nAll options are the same when using the original theme (`readthedocs`). See also:\n<https://www.mkdocs.org/user-guide/choosing-your-theme/#readthedocs>\n\n## Modifications\n\n- Add social icons (only Github supported now) to the top right corner of the page.\n- Adjust some styles\n- Open external links in new tab by default\n- Do not reset side nav items when url hash is `#` or empty\n- Make search box sticky\n- Add css support for `pymdownx.blocks.tab` (must use `alternate_style: true`)\n- Set `ignoreUnescapedHTML` to `true` for `hljs`\n- Keep current sidebar item always in view when scrolling\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A fork of mkdocs readthedocs theme to make it work with mkapi",
"version": "0.0.14",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c49128b0dfebcde2b4555cf74c69ec11c9dff64b7e20a01a07f74941e5975d01",
"md5": "8f5ca7ca017e84e384bcb05e57fcc363",
"sha256": "d9ae35ae51bd852f9d3c1346c43546aa418669cadfa76aebfb01c84d649cf8aa"
},
"downloads": -1,
"filename": "mkdocs_rtd-0.0.14-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8f5ca7ca017e84e384bcb05e57fcc363",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.7",
"size": 2803186,
"upload_time": "2024-04-15T23:08:39",
"upload_time_iso_8601": "2024-04-15T23:08:39.084625Z",
"url": "https://files.pythonhosted.org/packages/c4/91/28b0dfebcde2b4555cf74c69ec11c9dff64b7e20a01a07f74941e5975d01/mkdocs_rtd-0.0.14-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9befa27767b9ddc9cd41b80fe15f74846f38fde62bb4fb70dc126ecc907ac608",
"md5": "1d42acbb6663a3856fcafcb7f17c4dab",
"sha256": "f6fb3b47de194a2c28dfb280b9ae315b0002e1d88c3f4713535cb1eab0f75d4a"
},
"downloads": -1,
"filename": "mkdocs_rtd-0.0.14.tar.gz",
"has_sig": false,
"md5_digest": "1d42acbb6663a3856fcafcb7f17c4dab",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.7",
"size": 2790954,
"upload_time": "2024-04-15T23:08:41",
"upload_time_iso_8601": "2024-04-15T23:08:41.520050Z",
"url": "https://files.pythonhosted.org/packages/9b/ef/a27767b9ddc9cd41b80fe15f74846f38fde62bb4fb70dc126ecc907ac608/mkdocs_rtd-0.0.14.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-15 23:08:41",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "mkdocs-rtd"
}