zola/docs/content/themes/feather/index.md

56 lines
1.7 KiB
Markdown
Raw Normal View History

2018-03-05 17:21:53 +00:00
+++
title = "feather"
description = "A fuzzy blog theme"
2018-03-05 17:21:53 +00:00
template = "theme.html"
date = 2024-04-02T04:09:32+10:00
2018-03-05 17:21:53 +00:00
[extra]
created = 2024-04-02T04:09:32+10:00
updated = 2024-04-02T04:09:32+10:00
repository = "https://github.com/piedoom/feather.git"
2018-03-05 17:21:53 +00:00
homepage = "https://github.com/piedoom/feather"
minimum_version = "0.11.0"
2018-03-05 17:21:53 +00:00
license = "MIT"
demo = "http://feather.doomy.org/"
2018-03-05 17:21:53 +00:00
[extra.author]
name = "doomy"
homepage = "https://doomy.org"
2018-03-05 17:21:53 +00:00
+++
# feather
A lightweight blog theme for [Zola](https://www.getzola.org/) (and to my knowledge the first of now
many themes created specifically for Zola).
2018-03-05 17:21:53 +00:00
# [Live demo 🔗](https://feather.doomy.org/)
2018-03-05 17:21:53 +00:00
[![screenshot](screenshot.png)](https://feather.doomy.org/)
2018-03-05 17:21:53 +00:00
# Developing & Contributing
Because feather comes with example content, you can run the theme just like any Zola
blog with `zola serve`.
2018-03-05 17:21:53 +00:00
# Usage
2019-04-06 09:37:49 +00:00
Using feather is easy. Install [Zola](https://www.getzola.org/) and follow
[the guide for creating a site and using a theme](https://www.getzola.org/documentation/themes/installing-and-using-themes/). Then,
2018-03-05 17:21:53 +00:00
add `theme = "feather"` to your `config.toml` file.
If you intend to publish your site to GitHub Pages, please check out [this
tutorial](https://www.getzola.org/documentation/deployment/github-pages/).
You can specify `tags` taxonomies .
2018-03-05 17:21:53 +00:00
## Options
2019-04-06 09:37:49 +00:00
Zola allows themes to [define `[extra]` variables](https://www.getzola.org/documentation/getting-started/configuration/)
in the config. Here's a full list of theme variables with example values and comments.
2018-03-05 17:21:53 +00:00
```
title = "My site" # Otherwise, this will read "Home" in the nav
2018-03-05 17:21:53 +00:00
[extra]
feather_analytics = "<script></script>" # basically just a place to put extra scripts
feather_disqus_domain = "mysite-com" # disqus embeds, if you want that
2018-03-05 17:21:53 +00:00
```