Metadata-Version: 2.1
Name: mkdocs-rtd
Version: 0.0.6
Summary: A fork of mkdocs readthedocs theme to make it work with mkapi
License: MIT
Author: pwwang
Author-email: pwwang@pwwang.com
Requires-Python: >=3.7,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Description-Content-Type: text/markdown

# 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

