Git Product home page Git Product logo

mkdocs-tamerdocs's Introduction

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

mkdocs-tamerdocs's People

Contributors

anantshri avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.