Skip to content

zixia/mm-github-pages-starter

 
 

Repository files navigation

Chatie Style Minimal Mistakes remote theme starter

Fork this repo for the quickest method of getting started with the Minimal Mistakes Jekyll theme.

Contains basic configuration to get you a site with:

  • Sample posts.
  • Sample top navigation.
  • Sample author sidebar with social links.
  • Sample footer links.
  • Paginated home page.
  • Archive pages for posts grouped by year, category, and tag.
  • Sample about page.
  • Sample 404 page.
  • Site wide search.

Replace sample content with your own and configure as necessary.


Usage

Jekyll

Install all the Jekyll requirements and run it at localhost for blog preview.

1 Use Docker Compose

This is the recommended way for new users to easy getting started

make docker

2 Install Jekyll by Hand

You should not use this way except you are a Ruby expert.

make install
make serve

Test

In order to make sure everything(file name, file size, etc) is ok, you can run the following command to check them before git push.

npm install
npm test

Enhancements

PDF Viewer

Viewer.js is the best easy to use.

Others:

  1. reveal.js - The HTML Presentation Framework Used by slides.com
  2. PDF.js JSFiddle Example from PDF.js Examples 3
  3. Online PowerPoint to HTML5 Converter
  4. React MDX-based presentation decks
  5. WikiPedia:Web-based slideshow

Slide (reveal.js)

  1. Example from ahxxm.github.io
  2. Jekyll: Create Slides with reveal.js
  3. markdown → slides (reveal.js) → gh-pages (jekyll)
  4. A Jekyll-based framework for creating presentations based on Reveal.js and markdown. (example)

Resources

  1. Jekyll cheatsheet
  2. Jekyll Liquid Cheatsheet
  3. Minimal Mistakes Official Examples

Troubleshooting

scripts/fit-image.sh Realted

sudo apt-get install imagemagick
# mac:
# brew install imagemagick
sudo apt-get install webp

Jekyll Related

If you have a question about using Jekyll, start a discussion on the Jekyll Forum or StackOverflow. Other resources:

Author

Huan LI (李卓桓) [email protected]

Profile of Huan LI (李卓桓) on StackOverflow

Copyright & License

  • Code & Docs © 2019 - now Huan LI [email protected]
  • Code released under the Apache-2.0 License
  • Docs released under Creative Commons

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 71.6%
  • Shell 16.0%
  • Makefile 10.6%
  • JavaScript 1.8%