Improving readme for theme
This commit is contained in:
parent
7986d359af
commit
006d2691fd
49
README.md
49
README.md
|
@ -17,6 +17,9 @@ Demo: [quirky-perlman-34d0da.netlify.com](https://quirky-perlman-34d0da.netlify.
|
||||||
|
|
||||||
- [Installation](#installation)
|
- [Installation](#installation)
|
||||||
- [Options](#options)
|
- [Options](#options)
|
||||||
|
- [Title](#title)
|
||||||
|
- [Sass](#Sass)
|
||||||
|
- [RSS](#RSS)
|
||||||
- [Footer menu](#footer-menu)
|
- [Footer menu](#footer-menu)
|
||||||
- [Original](#original)
|
- [Original](#original)
|
||||||
- [License](#license)
|
- [License](#license)
|
||||||
|
@ -38,10 +41,49 @@ Posts should be placed in the `blog` folder.
|
||||||
|
|
||||||
## Options
|
## Options
|
||||||
|
|
||||||
### footer-menu
|
### Title
|
||||||
|
Set a tile and description for your site to appear in the header:
|
||||||
|
|
||||||
|
```toml
|
||||||
|
title = "Different strokes"
|
||||||
|
description = "for different folks"
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
### Sass
|
||||||
|
|
||||||
|
The theme's css is compiled from sass and the output is imported inline to the header :zap:
|
||||||
|
|
||||||
|
You can overide the styles by enabling sass compilation in the config:
|
||||||
|
|
||||||
|
```toml
|
||||||
|
compile_sass = true
|
||||||
|
```
|
||||||
|
|
||||||
|
...and placing a replacement `style.scss` file in the sass folder.
|
||||||
|
|
||||||
|
### RSS
|
||||||
|
Enable rss with the standard zola option:
|
||||||
|
|
||||||
|
```toml
|
||||||
|
generate_rss = true
|
||||||
|
```
|
||||||
|
|
||||||
|
...and include your name and email in the feed by setting fields in `extra` with keys `author` and `email`:
|
||||||
|
|
||||||
|
```toml
|
||||||
|
[extra]
|
||||||
|
|
||||||
|
author = "Grant Green"
|
||||||
|
email = "grant@green.org"
|
||||||
|
```
|
||||||
|
|
||||||
|
### Footer-menu
|
||||||
Set a field in `extra` with a key of `footer_links`:
|
Set a field in `extra` with a key of `footer_links`:
|
||||||
|
|
||||||
```toml
|
```toml
|
||||||
|
[extra]
|
||||||
|
|
||||||
footer_links = [
|
footer_links = [
|
||||||
{url = "$BASE_URL/about", name = "About"},
|
{url = "$BASE_URL/about", name = "About"},
|
||||||
{url = "$BASE_URL/rss.xml", name = "RSS"},
|
{url = "$BASE_URL/rss.xml", name = "RSS"},
|
||||||
|
@ -53,9 +95,8 @@ If you put `$BASE_URL` in a url, it will automatically be replaced by the actual
|
||||||
site URL.
|
site URL.
|
||||||
|
|
||||||
## Original
|
## Original
|
||||||
This template is based on the Jekyll template [Light Speed Jekyll](https://github.com/bradleytaunt/lightspeed) by Bradley Taunt.
|
This template is based on the Jekyll template [Light Speed Jekyll](https://github.com/bradleytaunt/lightspeed) by **Bradley Taunt**:
|
||||||
|
|
||||||
**Bradley Taunt**
|
|
||||||
- <https://github.com/bradleytaunt>
|
- <https://github.com/bradleytaunt>
|
||||||
- <https://twitter.com/bradtaunt>
|
- <https://twitter.com/bradtaunt>
|
||||||
|
|
||||||
|
@ -64,5 +105,5 @@ This template is based on the Jekyll template [Light Speed Jekyll](https://githu
|
||||||
|
|
||||||
Open sourced under the [MIT license](LICENSE.md).
|
Open sourced under the [MIT license](LICENSE.md).
|
||||||
|
|
||||||
This project is open source except for example articles found in `_posts`.
|
This project is open source except for example articles found in `content`.
|
||||||
|
|
||||||
|
|
|
@ -13,3 +13,12 @@ homepage = "https://github.com/carpetscheme"
|
||||||
author = "Bradley Taunt"
|
author = "Bradley Taunt"
|
||||||
homepage = "https://github.com/bradleytaunt"
|
homepage = "https://github.com/bradleytaunt"
|
||||||
repo = "https://github.com/bradleytaunt/lightspeed"
|
repo = "https://github.com/bradleytaunt/lightspeed"
|
||||||
|
|
||||||
|
[extra]
|
||||||
|
author = ""
|
||||||
|
email = ""
|
||||||
|
|
||||||
|
footer_links = [
|
||||||
|
{url = "$BASE_URL/about", name = "About"},
|
||||||
|
]
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue