https://github.com/j3soon/minimal-mistakes-template
Create your personal blog with MathJax, LaTex, and more built-in features by cloning this template.
https://github.com/j3soon/minimal-mistakes-template
example jekyll-theme latex mathjax mathjax-support minimal-example minimal-mistakes template
Last synced: about 1 year ago
JSON representation
Create your personal blog with MathJax, LaTex, and more built-in features by cloning this template.
- Host: GitHub
- URL: https://github.com/j3soon/minimal-mistakes-template
- Owner: j3soon
- License: mit
- Created: 2020-10-24T08:13:18.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2021-12-19T18:42:08.000Z (over 4 years ago)
- Last Synced: 2025-03-23T23:11:49.295Z (about 1 year ago)
- Topics: example, jekyll-theme, latex, mathjax, mathjax-support, minimal-example, minimal-mistakes, template
- Language: HTML
- Homepage: https://j3soon.github.io/minimal-mistakes-template/
- Size: 50.8 KB
- Stars: 5
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# [Minimal Mistakes Template](https://github.com/j3soon/minimal-mistakes-template/)
A minimum Jekyll blog template with some customization based on the [Minimal Mistakes Theme](https://mmistakes.github.io/minimal-mistakes/).
**[Click here to preview!](https://j3soon.github.io/minimal-mistakes-template/styling-syntax-test/)**
To further customize your site, please refer to [the documentation](https://mmistakes.github.io/minimal-mistakes/docs/quick-start-guide/).
## Run the template locally
First, follow the [installation guide of Jekyll](https://jekyllrb.com/docs/installation/). 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:
```sh
scripts/set_env_local.sh
```
Remember to revert the local preview settings before committing:
```sh
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:
```sh
scripts\set_env_local.bat
```
Remember to revert the local preview settings before committing:
```sh
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](https://github.com/mmistakes/minimal-mistakes/releases) specified in [Gemfile](Gemfile) with [MIT License](https://github.com/mmistakes/minimal-mistakes/blob/master/LICENSE).
- [MathJax](https://github.com/mathjax/MathJax/releases) specified in [_includes/scripts.html](_includes/scripts.html) with [Apache-2.0 License](https://github.com/mathjax/MathJax/blob/master/LICENSE).
- [dlbook_notation](https://github.com/goodfeli/dlbook_notation) in [_includes/dl-book-latex.html](_includes/scripts.html) with some customization for Jekyll.