ivyazmitinov / mkdocs-material-blog

Blogging with Material for MkDocs

MkDocs Material Blog theme

Based on a popular theme Material for MkDocs for MkDocs static site generator, I added new layouts and customized some styles to show this site in a blog-like theme.

Please visit my blog at vuquangtrong.github.io to see this theme in live.

Prepare

1. Clone this repo
2. Run _new.bat to init a virtual environment
3. Run _venv.bat to activate the virtual environment

Note that you are using virtual environment, next time when you start to edit this project, make sure to run _venv.bat first.

Installation

1. Run _install.bat to install required packages

Write docs

You can add your new documents in docs\blog.

Preview

1. Run _run.bat
2. Preview in browser at http://127.0.0.1:8000/

Publish

Run mkdocs build, then copy the content in the site folder to your website's serving folder.

Print to PDF

This function only work when you have Chrome and ChromeDrive installed and configured. For more detail, please visit Print to PDF plugin.

License

MIT License Copyright (c) 2020-2021 Vu Quang Trong