🎨A Jekyll theme based on MDUI
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.github
_data
_includes
_layouts
_posts
assets
category
docs
pages
.gitignore
.travis.yml
CHANGELOG.md
Gemfile
LICENSE.txt
README.md
_config.yml
gulpfile.js
index.html
jekyll-theme-mdui.gemspec
jekylltheme.jpg
manifest.json
package.json
search.json
sw.js
tags.json

README.md

Jekyll Theme MDUI

A Jekyll theme based on mdui

Contents

General

Version Jekyll Gem

Code Climate Build Status Commitizen friendly

Author

Demo

Jekyll-Theme-Mdui

Quick start

Quick start

快速开始

Docs

中文文档

TODO

  • [add docs for the new feature]
  • [fix passages on top can't be open by click image]

Note

File Required or Optional:

files Required or Optional Description
mainifest.json Optional Is the only file that every WebExtension must contain.See here.
sw.js Optional Service Workers.See here.
search.json Optional If you use the search page, it is required.
tags.json Optional If you use the tags page, it is required.
_data/friends.yml Optional If you use the friends page, it is required.
_data/sns.yml Optional It is footer sns,if you want used, it is required.
_data/meng.yml Optional It is Meng option,if you want used, it is required.
_data/site.yml Required It is theme config.
_data/lang.yml Required It is language config.
_data/menus.yml Required It is site menus config.

How to use? See Docs.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/KeJunMao/jekyll-theme-mdui. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

Development

To set up your environment to develop this theme, run bundle install.

Your theme is setup just like a normal Jekyll site! To test your theme, run bundle exec jekyll serve and open your browser at http://localhost:4000. This starts a Jekyll server using your theme. Add pages, documents, data, etc. like normal to test your theme's contents. As you make modifications to your theme and to your content, your site will regenerate and you should see the changes in the browser after a refresh, just like normal.

When your theme is released, only the files in _layouts, _includes, and assets tracked with Git will be released.

License

license

The theme is available as open source under the terms of the MIT License.