Skip to content

Implementation

Installing Mkdocs and Mkdocs Material

  • In your machine, install python and pip

    Preferably version 3.x

  • Run this command to install mkdocs-material
    >pip install mkdocs-material
    
  • Useful commands:

    Function Command
    Live preview of the website python -m mkdocs serve
    Build the website python -m mkdocs build

Building the website

  • Open the documetation template and click use this template button
  • Create your repository based on template by giving it name
  • Clone your repository and open it in your machine

Info

mkdocs material convert your markdown file into website without configuring any HTML, Javascript, or CSS

Back to top