otmp_site/README.md

119 lines
2.5 KiB
Markdown
Raw Normal View History

2022-12-03 20:01:01 +01:00
# no style, please!
A (nearly) no-CSS, fast, minimalist [Zola](https://www.getzola.org/) theme.
Ported from from [riggraz](https://riggraz.dev/)'s [no style, please! Jekyll theme](https://riggraz.dev/no-style-please/), and I use it for [my site](https://4b.cx/)
![screenshot](./screenshot.png)
## Installation
First download this theme to your `themes` directory:
```bash
cd themes
git clone https://gitlab.com/4bcx/no-style-please.git
```
and then enable it in your `config.toml`:
```toml
theme = "no-style-please"
```
## Options
### Default taxonomies
Special templates for `tags`, `categories`, and `contexts` taxonomies are provided. However, generic templates exist for custom taxonomies.
To use taxonomies, in a page metadata add
```toml
[taxonomies]
tags = [ 'tag1', 'tag2' ]
categories = [ 'category A', 'B class' ]
genre = [ 'rock', 'alternative' ] # custom taxonomy
```
2022-12-03 20:01:01 +01:00
### Pages list in homepage
2022-12-04 22:19:16 +01:00
To enable listing of pages in homepage add the following in `config.toml`
2022-12-03 20:01:01 +01:00
```toml
2022-12-04 22:19:16 +01:00
[extra]
list_pages = true
2022-12-03 20:01:01 +01:00
```
### Header and footer nav links
Also in the `extra` section in `config.toml`
```toml
[extra]
header_nav = [
{ name = "~home", url = "/" },
{ name = "#tags", url = "/tags" },
{ name = "+categories", url = "/categories" },
{ name = "@contexts", url = "/contexts" },
{ name = "example", url = "http://example.com", new_tab=true },
]
footer_nav = [
{ name = "< previous", url = "#" },
{ name = "webring", url = "#" },
{ name = "next >", url = "#" },
]
```
2022-12-04 22:19:16 +01:00
### Add TOC to pages
In a page frontmatter, set `extra.add_toc` to `true`
```toml
[extra]
add_toc = true
```
2022-12-03 20:01:01 +01:00
### Extra data
- `author` can be set in both main config and in pages metadata
- `image` variable can be used in pages to add an image to HTML `<meta>` tags
- Same for `logo` in main config, except this one is also used as the site icon
### Horizontal rule shortcode `hr()`
Adds the option to insert text in the thematic break
```html
{{ hr(data_content="footnotes") }}
```
is rendered
![thematic break screenshot](./hr_footnotes.png)
### Invertable image `iimg()`
Images are not inverted in darkmode by default. To add an invertable image use the following
```html
{{ iimg(src="logo.png", alt="alt text") }}
```
In light mode
![image in light mode](./iimg_light.png)
In dark mode
![image in dark mode](./iimg_dark.png)
## TODO
- [ ] Add RTL support
- [ ] Write proper test pages
## License
The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).