mkdocs-rtd

Name	mkdocs-rtd JSON
Version	0.0.15 JSON
	download
home_page	None
Summary	A fork of mkdocs readthedocs theme to make it work with mkapi
upload_time	2024-08-12 21:48:59
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/c0/28/40b973e6de72c904312cc78afe3fbde3bd8c9a4ef435430493b8b494610d/mkdocs_rtd-0.0.15.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.15",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "88538ddc4dd326ef4bdf5109bbf96c2a6baaec5e05aab74fae8adac7cac24e84",
                "md5": "3032f3260f80ba145010bf4cc0147007",
                "sha256": "d8bc7b97e03a8ef5a70bac225edd5fbbfa5bd25bec72360c75b611cc7f64cb0a"
            },
            "downloads": -1,
            "filename": "mkdocs_rtd-0.0.15-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "3032f3260f80ba145010bf4cc0147007",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.7",
            "size": 2803222,
            "upload_time": "2024-08-12T21:48:57",
            "upload_time_iso_8601": "2024-08-12T21:48:57.354298Z",
            "url": "https://files.pythonhosted.org/packages/88/53/8ddc4dd326ef4bdf5109bbf96c2a6baaec5e05aab74fae8adac7cac24e84/mkdocs_rtd-0.0.15-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c02840b973e6de72c904312cc78afe3fbde3bd8c9a4ef435430493b8b494610d",
                "md5": "fdb2dc3e78689873a792c1e31db81ff5",
                "sha256": "a92ca9319bbcb5e042bb75a45117097827b166eae478ca1cfb7c4db61653af63"
            },
            "downloads": -1,
            "filename": "mkdocs_rtd-0.0.15.tar.gz",
            "has_sig": false,
            "md5_digest": "fdb2dc3e78689873a792c1e31db81ff5",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.7",
            "size": 2790996,
            "upload_time": "2024-08-12T21:48:59",
            "upload_time_iso_8601": "2024-08-12T21:48:59.518502Z",
            "url": "https://files.pythonhosted.org/packages/c0/28/40b973e6de72c904312cc78afe3fbde3bd8c9a4ef435430493b8b494610d/mkdocs_rtd-0.0.15.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-08-12 21:48:59",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "mkdocs-rtd"
}