|
1 | | -# MatJek |
| 1 | +# Aper |
2 | 2 |
|
3 | | -A responsive [Material](https://material.io/) theme based on [Materialize.css](http://materializecss.com/) for jekyll sites. |
4 | | - |
5 | | -## Features |
6 | | - |
7 | | -* Google Analytics |
8 | | -* Disqus |
9 | | -* [GitHub project page](https://shawnteoh.github.io/matjek/projects/) |
10 | | -* [Tags](https://shawnteoh.github.io/matjek/tags/) and [Categories](https://shawnteoh.github.io/matjek/categories/) |
11 | | -* Modular CSS and JS includes ([example](https://github.com/ShawnTeoh/matjek/blob/gh-pages/projects.md/)) |
12 | | -* [Fancy "About" page](https://shawnteoh.github.io/matjek/about) |
13 | | - |
14 | | -## Installation |
15 | | - |
16 | | -Clone or fork this repo and edit `_config.yml` as needed. |
17 | | - |
18 | | -## Configuration |
19 | | - |
20 | | -Most of the configurations can be found in `_config.yml`. The configurations listed below are specific to MatJek. If you are not using `google_tracking_id` or `disqus_shortname`, just remove them completely. |
21 | | - |
22 | | -```yaml |
23 | | -github_profile: "github_profile_url" |
24 | | -user: "your_name" # Appears at sidebar |
25 | | -user_email: "your_email" # Appears at sidebar, remove whole variable if unwanted |
26 | | -contact_url: "google_form_link" |
27 | | -google_tracking_id: "google_analytics_ID" |
28 | | -disqus_shortname: "shortname_given_by_Disqus" |
29 | | -``` |
30 | | -
|
31 | | -Edit the images in `assets/res` to suit your liking, but try to stick to the original resolutions. |
32 | | - |
33 | | -If you would like to enable comments in a post (disqus_shortname must be provided), add this line to the front matter of the post. |
34 | | - |
35 | | -```yaml |
36 | | -comments: 1 |
37 | | -``` |
38 | | - |
39 | | -Add tags and categories to your posts in the front matter as well. Multiple tags/categories can be assigned but need to be separated by spaces. |
40 | | - |
41 | | -```yaml |
42 | | -categories: default default2 |
43 | | -tags: test test2 |
44 | | -``` |
45 | | - |
46 | | -## Contributing |
47 | | - |
48 | | -Bug reports and pull requests are welcomed on GitHub at https://github.com/shawnteoh/matjek. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct. |
49 | | - |
50 | | -## Development |
51 | | - |
52 | | -To set up your environment to develop this theme, clone/fork the repo and run `bundle install`. |
53 | | - |
54 | | -To test your theme, run `bundle exec jekyll serve` and open your browser at `http://localhost:4000/matjek/`. 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. |
55 | | - |
56 | | -## License |
57 | | - |
58 | | -The theme is available as open source under the terms of the [GPL v3 License](https://www.gnu.org/licenses/gpl-3.0.en.html). |
59 | | - |
60 | | -## Libraries |
61 | | -* [Materialize.css](http://materializecss.com/) |
62 | | -* [GeoPattern](https://github.com/btmills/geopattern/) |
63 | | -* [Animate.css](https://daneden.github.io/animate.css/) |
64 | | -* [Morphtext](http://morphext.fyianlai.com/) |
65 | | - |
66 | | -## References |
67 | | -* https://github.com/DONGChuan/Yummy-Jekyll/ |
68 | | -* https://github.com/codinfox/codinfox-lanyon/ |
0 commit comments