README.md in jekyll-theme-kagami-0.1.2 vs README.md in jekyll-theme-kagami-0.1.3
- old
+ new
@@ -3,10 +3,12 @@
[](https://travis-ci.org/kamikat/jekyll-theme-kagami)
[](https://badge.fury.io/rb/jekyll-theme-kagami)
A peaceful theme for Jekyll and GitHub Pages.
+
+
## Installation
Add this line to your Jekyll site's Gemfile:
```ruby
@@ -27,11 +29,11 @@
$ gem install jekyll-theme-kagami
## Usage
-### Social Accounts
+### Social account links
You can customize social account links by adding following lines to `_config.yml`
```yaml
github_username: my_github_username
@@ -39,11 +41,11 @@
instagram_username: my_instagram_username
```
You can customize footer by overriding `_includes/footer.html`.
-### Syntax Highlighting
+### Syntax highlighting
Kagami support color schemes from [jekyll-pygments-themes](https://github.com/jwarby/jekyll-pygments-themes).
Add the following lines to choose a color scheme:
@@ -74,9 +76,37 @@
```yaml
google_analytics: UA-NNNNNNNN-N
```
Google Analytics will only appear in production, i.e., `JEKYLL_ENV=production`
+
+### Enabling MathJax
+
+You can use MathJax with Kramdown's [built-in support](https://kramdown.gettalong.org/syntax.html#math-blocks).
+
+To enable [MathJax](https://www.mathjax.org/), add following lines to your site
+or post's front matter stuff:
+
+```yaml
+mathjax: true
+```
+
+### Use `.sidenote` and `.retina2x`
+
+Taking advantages of [Block/span IAL](https://kramdown.gettalong.org/syntax.html#block-ials),
+Kagami supports extra elements in writing.
+
+Add a `{:.sidenote}` after a paragraph (in a new line just after paragraph)
+will style the paragraph as a sidenote. Sidenote will be pull to the left of
+the page and only be visible in desktop mode.
+
+Kagami supports image optimized for retina display:
+
+```markdown
+{:.retina2x}
+```
+
+And the retina image will be scaled to half of it's original size in pixels.
## Contributing
Bug reports and pull requests are welcome on GitHub at <https://github.com/kamikat/jekyll-theme-kagami>. 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.