lightspeed/README.md

130 lines
2.9 KiB
Markdown
Raw Normal View History

2019-04-09 10:58:22 +00:00
# Light Speed
2020-04-13 20:26:11 +00:00
An insanely fast and performance-based Zola theme, ported from [Light Speed Jekyll](https://github.com/bradleytaunt/lightspeed).
2020-04-13 19:53:24 +00:00
Some fun facts about the theme:
2019-04-09 10:58:22 +00:00
* Perfect score on Google's Lighthouse audit
2020-04-14 18:42:35 +00:00
* Only ~600 bytes of CSS
2019-04-09 10:58:22 +00:00
* No JavaScript
2020-09-13 13:08:54 +00:00
* Now with SEO!
2020-04-13 19:53:24 +00:00
Demo: [quirky-perlman-34d0da.netlify.com](https://quirky-perlman-34d0da.netlify.com)
2019-04-09 10:58:22 +00:00
-----
2020-04-13 20:23:39 +00:00
## Contents
- [Installation](#installation)
- [Options](#options)
2020-04-13 21:12:39 +00:00
- [Title](#title)
- [Sass](#Sass)
2020-04-13 20:23:39 +00:00
- [Footer menu](#footer-menu)
2020-04-18 14:49:03 +00:00
- [Author](#author)
2020-04-14 18:42:35 +00:00
- [Netlify](#netlify)
2020-04-13 20:23:39 +00:00
- [Original](#original)
- [License](#license)
## Installation
First download this theme to your `themes` directory:
```bash
$ cd themes
$ git clone https://github.com/carpetscheme/lightspeed.git
```
and then enable it in your `config.toml`:
```toml
theme = "lightspeed"
```
2020-04-14 18:42:35 +00:00
Posts should be placed directly in the `content` folder.
2020-04-13 20:23:39 +00:00
2020-04-19 09:16:25 +00:00
To sort the post index by date, enable sort in your index section `content/_index.md`:
```toml
sort_by = "date"
```
2020-04-13 20:23:39 +00:00
## Options
2020-04-13 21:12:39 +00:00
### Title
2020-04-14 18:42:35 +00:00
Set a title and description in the config to appear in the site header:
2020-04-13 21:12:39 +00:00
```toml
title = "Different strokes"
description = "for different folks"
```
### Footer-menu
2020-04-13 20:23:39 +00:00
Set a field in `extra` with a key of `footer_links`:
```toml
2020-04-13 21:12:39 +00:00
[extra]
2020-04-13 20:26:11 +00:00
footer_links = [
2020-04-13 20:23:39 +00:00
{url = "$BASE_URL/about", name = "About"},
2020-09-13 13:08:54 +00:00
{url = "$BASE_URL/atom.xml", name = "RSS"},
2020-04-13 20:23:39 +00:00
{url = "https://google.com", name = "Google"},
]
```
If you put `$BASE_URL` in a url, it will automatically be replaced by the actual
site URL.
2020-04-14 18:42:35 +00:00
Create pages such as `$BASE_URL/about` by placing them in a subfolder of the content directory, and specifying the path in the frontmatter:
```toml
path = "about"
```
2020-09-13 13:08:54 +00:00
### SEO
2020-04-18 14:49:03 +00:00
2020-09-13 13:08:54 +00:00
SEO header tags are enabled by default. Most fields are picked up from the page data, but you can set the `author` and for the `og:image` tag provide the path to an image.
2020-04-18 14:49:03 +00:00
```toml
[extra]
author = "Grant Green"
2020-09-13 13:08:54 +00:00
ogimage = "Greenery.png"
2020-04-18 14:49:03 +00:00
```
2020-09-13 13:08:54 +00:00
To disable SEO set field `seo` in `extra` to `false`.
2020-09-13 13:47:11 +00:00
### Footer text
By default the footer provides links to Zola and Netlify, and a tagline of "Mainted with :hearts for the web".
To disable any of those parts, and/or add a custom tagline of your own, the following options are available:
```toml
[extra]
zola = true
netlify = false
maintained_with_love = false
footer_tagline = "What if everything is an illusion and nothing exists? In that case, I definitely overpaid for my carpet."
```
2020-09-13 13:08:54 +00:00
### Sass
Styles are compiled from sass and 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 your sass folder.
2020-04-13 20:23:39 +00:00
## Original
2020-09-13 13:08:54 +00:00
This template is based on the Jekyll template [Light Speed Jekyll](https://github.com/bradleytaunt/lightspeed) by Bradley Taunt.
2019-04-09 10:58:22 +00:00
## License
Open sourced under the [MIT license](LICENSE.md).
2020-04-13 21:12:39 +00:00
This project is open source except for example articles found in `content`.
2020-04-13 20:23:39 +00:00