mkdocs-tamerdocs

Mkdocs theme used on AndroidTamer Documentation portals


Keywords
mkdocs, documentation, theme
License
GPL-2.0+
Install
pip install mkdocs-tamerdocs==0.0.3

Documentation

Mkdocs theme for Android Tamer Documentation

PyPI PyPI

Based on default mkdocs theme with multiple customizations.

Customizations include

  1. Capability to hide toc per page via hide_toc page parameter
  2. Bare minimum mindmapping capability for this to work we need following items
    1. add mindmap: true in page
    2. page should contain mind map in markdown list format.
  3. Last Build date is shown on the bottom of everypage
  4. Social icons added (Twitter / Facebook and Linkedin)
extra:
  twitter: https://www.twitter.com/anantshri
  facebook: https://www.facebook.com/Anantshri
  linkedin: https://www.linkedin.com/in/anantshri
  1. Some SEO Stuff added
  2. Remove search from the entire site via mkdocs.yml
 extra:
   search: false
  1. Asciinema integration.
    1. Add a tag asciinema:true to add relevent css and js
    2. page should contain <asciinema-player src="/ascii/demo.json"></asciinema-player> where src should point to hosted json file
  2. As include_prev_next is now deprecated hence new variable extra.navigate added to remove navigation options. So to remove navigation entirely.
extra:
  navigation: false