README.md in jekyll-theme-kagami-0.1.8 vs README.md in jekyll-theme-kagami-0.1.9

- old
+ new

@@ -77,10 +77,25 @@ google_analytics: UA-NNNNNNNN-N ``` Google Analytics will only appear in production, i.e., `JEKYLL_ENV=production` +### Navigation + +Pages and posts can be listed as navigation item in header of pages. Add following frontmatter will make it + +```yaml +navlevel: header +navtitle: Awesome Title # optional, specifies the text to display on navigation item +``` + +Navigation items are ordered in alphabetical order by default in Jekyll. While you can adjust the order manually using + +```yaml +position: 999 +``` + ### Tags and category Layout file `post-list` supports filters by tag or category. Create pages with following frontmatter will generate a filtered post list. ```yaml @@ -111,19 +126,19 @@ ```yaml mathjax: true ``` -### Use `.sidenote` and `.retina2x` +### Use `.side-note` 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) +Add `{:.side-note}` notation after a paragraph (in a new line just after paragraph WITHOUT extra line breaks) 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: +Kagami is also optimized for high-res image display: ```markdown ![image@2x](path-to-image@2x.png){:.retina2x} ```