mkdocs-rtd 0.0.10

A fork of mkdocs readthedocs theme to make it work with mkapi

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

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