mkdocs_starting_template

This is a template to preview mkdocs documents in Material theme

Install Process

• Mac/Linux
  1. Clone this repository git clone https://github.com/coley-angel/mkdocs_template.git cd ./mkdocs_template
  2. python 3.8 Download and install python https://www.python.org/downloads/release/python-380/
  3. Start Virutal Env python3 -m venv ./ source ./bin/activate
  4. Install requirements pip3 install -r requirements.txt mkdocs serve
  5. Start Mkdocs Server mkdocs serve
• Windows
  1. Clone this repository git clone https://github.com/coley-angel/mkdocs_template.git cd ./mkdocs_template
  2. python 3.8 Download and install python https://www.python.org/downloads/release/python-380/
  3. Start Virutal Env python -m venv ./ ./Scripts/activate
  4. Install requirements pip install -r requirements.txt
  5. Start Mkdocs server mkdocs serve

Markdown Reference Website(s)

https://www.markdownguide.org/basic-syntax/