README.md in jekyll-theme-scaffold-1.1.0 vs README.md in jekyll-theme-scaffold-1.2.0
- old
+ new
@@ -8,11 +8,11 @@
According to [Merriam-Webster](https://www.merriam-webster.com/), a *scaffold* is
> a temporary or movable platform for workers (such as bricklayers, painters, or miners) to stand or sit on when working at a height above the floor or ground
-So is the target of the Jekyll theme Scaffold. It doesn't need to be modern, powerful, colorful, or beautiful; It just needs to be **simple**, **proper**, **naked**, and **neat**.
+So is the target of the Jekyll theme Scaffold. It doesn't need to be modern, colorful, or beautiful; It just needs to be **simple**, **proper**, **naked**, and **neat**.
Scaffold is empirical. Standing on it, you -- the blogger -- can build a great building based on your words.
*Check the [live demo](https://sziv2p.github.io/jekyll-theme-scaffold/).*
@@ -28,11 +28,10 @@
- Archive implemented by pure Liquid
- Pagination, via [`jekyll-paginate`](https://rubygems.org/gems/jekyll-paginate)
- TOC, via [`jekyll-toc`](https://github.com/allejo/jekyll-toc)
- [Jekyll Feed](https://github.com/jekyll/jekyll-feed/)
- [Jekyll SEO Tag](https://github.com/jekyll/jekyll-seo-tag/)
-- [Jekyll Sitemap](https://github.com/jekyll/jekyll-sitemap/)
- [Google Analytics](https://analytics.google.com/)
- [Disqus](https://disqus.com/)
- [MathJax](https://www.mathjax.org/)
## Table of Contents <!-- omit in toc -->
@@ -89,10 +88,12 @@
remote_theme: sziv2p/jekyll-theme-scaffold
```
## Usage
+The main usage of this theme is described in detail below. If you find the document difficult to understand or not specific enough, you can also use the [`gh-pages`](https://github.com/sziv2p/jekyll-theme-scaffold/tree/gh-pages) branch of this repository as an example to learn how to use this theme.
+
### Global Configuration
| Variable | Type | Default | Specification |
| -------- | ---- | ------- | ------------- |
| `title` | String | --- | The title of the website |
@@ -107,9 +108,10 @@
### Post Configuration
| Variable | Type | Default | Specification |
| -------- | ---- | ------- | ------------- |
+| `description` | String | --- | A description of the current post |
| `last_modified_at` | String | --- | The date of the last modification you made on a post after its publishing |
| `author` | String or Array | --- | The author name(s) of the post |
| `math` | Boolean | `false` | Does enable MathJax on this page |
| `comments` | Boolean | `true` | Does enable the Disqus comment system |
| `toc` | Boolean | `false` | Does enable the TOC |