MkDocs Material Template

This is a template based on Material for MkDocs.

Click here to preview!

The template features:

• All free features from MkDocs Material.
• Simple inclusion of post images
• DL Book Notations

Getting started

1. Fork this Git repository
2. Search for TODOs in the forked repository and modify accordingly to customize your site.

Please make sure to fork the repository (or at least keep the Git commit history), since it allows you to merge in future updates from the template easily.

Run Locally

1. Clone the repository (or your forked repository):

   cd ~
   git clone https://github.com/j3soon/mkdocs-material-template.git
   cd mkdocs-material-template
   

2. (Optional) Set up a virtual environment:

   virtualenv venv -p python3
   source venv/bin/activate
   

   Make sure to run the source command every time you open a new terminal.

3. Install dependencies:

   pip install -r requirements.txt
   

4. Preview the site (supports hot reload on save):

   mkdocs serve
   

   Go to https://127.0.0.1:8000 to view the site.

5. (Optional) Build the site:

   mkdocs build
   

   The site will be built to the site directory.

---

Last update: April 13, 2023
Created: April 7, 2023