README.md

Minimal Mistakes Template

A minimum Jekyll blog template with some customization based on the Minimal Mistakes Theme.

Click here to preview!

To further customize your site, please refer to the documentation.

Run the template locally

First, follow the installation guide of Jekyll. Then, follow the subsection that corresponds to your operating system.

Linux & MacOS

(Tested on Ubuntu 18.04 LTS)

Run the following command to allow local preview:

scripts/set_env_local.sh

Remember to revert the local preview settings before committing:

scripts/set_env_ghpages.sh

Full local preview commands:

git clone https://github.com/j3soon/minimal-mistakes-template.git
cd minimal-mistakes-template
scripts/preview.sh
# If the local preview is correct, press Ctrl+C once.
# Stage, Commit, and Push the modifications to GitHub to update GitHub Pages

Windows

(Tested on Windows 10)

Run the following command to allow local preview:

scripts\set_env_local.bat

Remember to revert the local preview settings before committing:

scripts\set_env_ghpages.bat

Full local preview commands:

git clone https://github.com/j3soon/minimal-mistakes-template.git
cd minimal-mistakes-template
scripts\preview.bat
# If the local preview is correct, press Ctrl+C multiple times.
# Stage, Commit, and Push the modifications to GitHub to update GitHub Pages

Dependencies

• Minimal Mistakes specified in Gemfile with MIT License.
• MathJax specified in _includes/scripts.html with Apache-2.0 License.
• dlbook_notation in _includes/dl-book-latex.html with some customization for Jekyll.