Install MkDocs - Read the Docs Alternative - on Windows 🌱

What is MkDocs?

MkDocs is a fast, simple and downright gorgeous static site generator that's geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML configuration file. It is designed to be easy to use and can be extended with third-party themes, plugins, and Markdown extensions. - https://github.com/mkdocs/mkdocs

Installation

  1. Log into the Windows device
  2. Download Python Download
  3. Run the downloaded Python installer, making sure to check the option to add Python to the path
  4. Launch PowerShell as Administrator
  5. Run the following commands in PowerShell
    # upgrade pip
    pip install --upgrade pip
    # create a mkdocs directory in user directory
    mkdir $ENV:UserProfile\mkdocs
    # change directory to mkdocs
    cd $ENV:UserProfile\mkdocs
    # install mkdocs
    pip install mkdocs
    # create a mkdocs site
    mkdocs new mkdocs-demo
    # change directory to mkdocs-demo
    cd mkdocs-demo
    # start the demo site
    mkdocs serve
  6. Open a web browser and navigate to http://DNSorIP:8000

Read the Docs Theme

  1. Back in PowerShell, press CTRL+C to kill the running process
  2. Run the following command
    # open the mkdocs config file in notepad
    notepad "$ENV:UserProfile\mkdocs\mkdocs-demo\mkdocs.yml"
  3. Add the following line to mkdocs.yml

    theme: readthedocs

  4. Save the change and close Notepad
  5. Run the following command to see the change
    # restart the demo site
    mkdocs serve

Source: https://www.mkdocs.org/getting-started/