Skip to content

ouglish/simple

 
 

Repository files navigation

simple -- A Simple Jekyll Theme

English | 中文 | demo

Features

This is a responsive Jekyll theme, and it's mobile-friendly. If you enjoy it, just star this repo.

Theme features include but are not limited to:

  • Editing, creating and publishing articles online
  • Using GitHub Flavored Markdown (GFM)
  • Formula rendering supported by MathJax
  • Flowchart rendering supported by Mermaid
  • By default, keep the iframe aspect ratio at 16:9 to better embed iframes like YouTube, Bilibili, etc
  • Comments supported by Gitalk
  • Using native JavaScript syntax impletments search functionality

Getting started

You can just operate it directly on GitHub, or edit it locally and push it back to your own remote repository.

Online Preview

  1. Fork the repo
  2. Rename forked repository as username.github.io; create the master branch and set it as the default branch
  3. Modify the corresponding configuration of the theme in the _config.yml file
  4. Visit https://username.github.io via browser, see the website online

Local Preview

  1. Installing Jekyll locally
  2. Clone a copy of your fork on your local
  3. Enter the root directory and run jekyll serve
  4. Visit http://localhost:4000 via browser to preview the website locally

Style Configuration

Theme styles can be changed by modifying CSS variables in the _sass/_variables.scss file, including but not limited to:

  • Use --font to change the font
  • Use --body-bg to change the background color of the website
  • Use --heading-color to change the color of the heading
  • Use --link-color to change the color of the hyperlink

Star trending

Stargazers over time

About

A minimalist, mobile first Jekyll theme.

Resources

License

Stars

1 star

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • SCSS 57.9%
  • HTML 26.5%
  • JavaScript 15.6%