https://github.com/pwwang/mkdocs-rtd

https://github.com/pwwang/mkdocs-rtd

Last synced: 14 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/pwwang/mkdocs-rtd
• Owner: pwwang
• Created: 2023-09-14T19:25:58.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2024-04-09T06:27:04.000Z (9 months ago)
• Last Synced: 2024-04-09T07:31:43.717Z (9 months ago)
• Language: HTML
• Size: 2.65 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# 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:

## 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