anemone/README.md

133 lines
3.3 KiB
Markdown
Raw Normal View History

2022-11-21 21:13:31 +00:00
# anemone
2023-07-04 01:37:44 +01:00
Introducing "anemone," a minimalist [Zola](https://www.getzola.org) theme that prioritizes clean CSS and avoids heavy JavaScript. Enjoy a seamless user experience with lightning-fast load times. Let your content take center stage in a clutter-free, elegant design that enhances readability. Responsive and efficient, anemone brings focus to your ideas.
2023-07-04 01:37:44 +01:00
2023-09-09 18:21:52 +01:00
You can browse the demo website [here](https://anemone.pages.dev/)
I also use it on my own [website.](https://speyllsite.pages.dev/)
2023-07-04 01:37:44 +01:00
Anemone is a versatile Zola theme that comes with both light and dark variants. You can easily switch between the light and dark themes to suit your preferences.
![Anemone Light and Dark Theme](screenshot.png)
### Installation
To get started with Anemone, follow these simple steps:
1. Download the theme to your `themes` directory:
2023-07-04 01:37:44 +01:00
```bash
cd themes
git clone https://github.com/Speyll/anemone
```
2. Enable Anemone in your `config.toml`:
2023-07-04 01:37:44 +01:00
```toml
theme = "anemone"
```
### Options
Anemone provides various options to customize your website:
#### Default Taxonomies
2023-07-04 01:37:44 +01:00
To use tags, add the following code to a page's metadata:
2023-07-04 01:37:44 +01:00
```toml
[taxonomies]
tags = ["tag1", "tag2"]
2023-07-04 01:37:44 +01:00
```
#### Pages List in Homepage
Enable listing of pages in the homepage by adding the following code to `config.toml`:
2023-07-04 01:37:44 +01:00
```toml
[extra]
list_pages = true
```
2023-08-08 03:35:07 +01:00
#### Multilanguage
2023-08-08 03:35:07 +01:00
The theme has a built-in feature that allows you to use multiple languages. For detailed instructions on how to use this feature, you can refer to the [Zola Multilingual documentation](https://www.getzola.org/documentation/content/multilingual/). This documentation provides additional information on how to make the most out of this multilingual capability.
```toml
[languages.en]
weight = 1
title = "anemone"
languageName = "English"
languageCode = "en"
relativeURL = false
[languages.fr]
weight = 2
title = "anemone"
languageName = "Français"
languageCode = "fr"
relativeURL = false
taxonomies = [
{name = "tags", feed = true},
]
```
#### Multilanguage-Ready Navigation Bar
Customize the header navigation links with the following code in the `extra` section of `config.toml`:
2023-07-04 01:37:44 +01:00
```toml
[extra]
2023-08-08 03:35:07 +01:00
[[extra.header_nav]]
en = { name = "/home/", url = "/" }
fr = { name = "/accueil/", url = "/fr" }
[[extra.header_nav]]
en = { name = "/about/", url = "/about" }
fr = { name = "/concernant/", url = "/about" }
[[extra.header_nav]]
en = { name = "/journal/", url = "/journal" }
fr = { name = "/journal/", url = "/journal" }
[[extra.header_nav]]
en = { name = "/blog/", url = "/blog" }
fr = { name = "/blog/", url = "/blog" }
```
2023-07-04 01:37:44 +01:00
### Webrings
Add a webring with a shortcode:
```html
{{ webring(prev="#", webring="#", webringName="Random Webring", next="#") }}
2023-07-04 01:37:44 +01:00
```
#### Add Table of Contents (TOC) to Pages
2023-07-04 01:37:44 +01:00
In a page's frontmatter, set `extra.toc` to `true`:
2023-07-04 01:37:44 +01:00
```toml
[extra]
toc = true
```
### Extra Data
2023-07-04 01:37:44 +01:00
- Set the `author` in both the main config and in pages' metadata.
- Use the `image` variable in pages to add an image to HTML `<meta>` tags.
- Similarly, set `favicon` in the main config, and it will be used as the site icon.
2023-07-04 01:37:44 +01:00
#### Disable Twitter Card
2023-07-04 01:37:44 +01:00
Twitter metatags are generated by default. To disable them, set `extra.twitter_card` to `false` in `config.toml`:
2023-07-04 01:37:44 +01:00
```toml
[extra]
twitter_card = true
```
### License
2023-07-04 01:37:44 +01:00
2023-09-09 18:21:52 +01:00
The Anemone theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).