diff --git a/README.md b/README.md index 9ef95db..c408152 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,47 @@ Demo: [quirky-perlman-34d0da.netlify.com](https://quirky-perlman-34d0da.netlify. ----- -## Author +## 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. **Bradley Taunt** - @@ -25,3 +65,4 @@ Demo: [quirky-perlman-34d0da.netlify.com](https://quirky-perlman-34d0da.netlify. Open sourced under the [MIT license](LICENSE.md). This project is open source except for example articles found in `_posts`. + diff --git a/screenshot.png b/screenshot.png new file mode 100644 index 0000000..6070f1e Binary files /dev/null and b/screenshot.png differ diff --git a/theme.toml b/theme.toml new file mode 100644 index 0000000..afd67e0 --- /dev/null +++ b/theme.toml @@ -0,0 +1,15 @@ +iname = "lightspeed" +description = "Zola theme with a perfect Lighthouse score" +license = "MIT" +homepage = "https://github.com/carpetscheme/lightspeed" +min_version = "0.10.0" +demo = "https://quirky-perlman-34d0da.netlify.com/" + +[author] +name = "El Carpet" +homepage = "https://github.com/carpetscheme" + +[original] +author = "Bradley Taunt" +homepage = "https://github.com/bradleytaunt" +repo = "https://github.com/bradleytaunt/lightspeed"