How to Preview MkDocs Locally

How to Run and Preview MkDocs Locally

ISLE uses MkDocs to display our git documentation more beautifully. (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.)

Installation

• Install MkDocs: https://www.mkdocs.org/
• install our theme: https://squidfunk.github.io/mkdocs-material/

Run MkDocs

• Go to your project folder using a terminal or command prompt (Windows should use Administrator mode)
  • usage: cd your_local_path\ISLE-Documentation\
  • example: cd C:\xampp\htdocs\GITHUB\Islandora-Collaboration-Group\ISLE-Documentation\
• mkdocs serve

Preview with Browser

• MkDocs will serve locally on: http://127.0.0.1:8000/