README.md in jekyll-theme-minimax-0.4.1 vs README.md in jekyll-theme-minimax-0.5.0
- old
+ new
@@ -24,10 +24,29 @@
$ gem install jekyll-theme-minimax
## Usage
-TODO: Write usage instructions here. Describe your available layouts, includes, sass and/or assets.
+- [Tag Cloud](#tag-cloud)
+
+### Tag Cloud
+
+In anywhere you want to show the tag cloud, insert `{% include tag_cloud.html %}`.
+
+You can manually write a page for each tag to list all posts that are labeled with the tag. For example, you want to show all posts labeled with `jekyll`, then create a page `tag/jekyll.md`:
+
+```
+---
+layout: tag_page
+tag: jekyll
+---
+```
+
+*Want free your hands*? Run a [script](scripts/tag-generator.py) to generate all tag pages automatically: `python scripts/tag-generator.py`.
+
+### Mathjax
+
+Minimax support Mathjax. You can write mathematical formulas in your posts if you set the `math` front matter to be `true` in these posts. [Example](_posts/2019-02-21-test-mathjax.md).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/hello. 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.