lightspeed/README.md

69 lines
1.5 KiB
Markdown
Raw Normal View History

2019-04-09 10:58:22 +00:00
# Light Speed
2020-04-13 19:53:24 +00:00
An insanely fast and performance-based Zola theme, ported from [Lite Speed Jekyll](https://github.com/bradleytaunt/lightspeed).
Some fun facts about the theme:
2019-04-09 10:58:22 +00:00
* Perfect score on Google's Lighthouse audit
* Only ~434 bytes of CSS
* No media queries
* No JavaScript
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)
- [Footer menu](#footer-menu)
- [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"
```
Posts should be placed in the `blog` folder.
## Options
### footer-menu
Set a field in `extra` with a key of `footer_links`:
```toml
after_dark_menu = [
{url = "$BASE_URL/about", name = "About"},
{url = "$BASE_URL/rss.xml", name = "RSS"},
{url = "https://google.com", name = "Google"},
]
```
If you put `$BASE_URL` in a url, it will automatically be replaced by the actual
site URL.
## Original
This template is based on the Jekyll template [Lite Speed Jekyll](https://github.com/bradleytaunt/lightspeed) by Bradley Taunt.
2019-04-09 10:58:22 +00:00
**Bradley Taunt**
- <https://github.com/bradleytaunt>
- <https://twitter.com/bradtaunt>
## License
Open sourced under the [MIT license](LICENSE.md).
This project is open source except for example articles found in `_posts`.
2020-04-13 20:23:39 +00:00