https://github.com/lukehsiao/zola-pickles
A modern, simple, clean blog theme for Zola.
https://github.com/lukehsiao/zola-pickles
blog theme zola
Last synced: 8 months ago
JSON representation
A modern, simple, clean blog theme for Zola.
- Host: GitHub
- URL: https://github.com/lukehsiao/zola-pickles
- Owner: lukehsiao
- License: other
- Created: 2020-02-06T21:48:08.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2025-01-04T06:14:23.000Z (10 months ago)
- Last Synced: 2025-01-17T11:11:22.499Z (9 months ago)
- Topics: blog, theme, zola
- Language: SCSS
- Homepage: https://zola-pickles.pages.dev
- Size: 2.16 MB
- Stars: 32
- Watchers: 4
- Forks: 9
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
🥒
zola-pickes
## Installation
First download this theme to your `themes` directory:
```bash
$ cd themes
$ git clone https://github.com/lukehsiao/zola-pickles.git
```
and then enable it in your `config.toml`:
```toml
theme = "zola-pickles"
```
The theme requires putting the posts in the root of the `content` folder and to enable pagination, for example in `content/_index.md`.
```
+++
paginate_by = 5
sort_by = "date"
insert_anchor_links = "right"
+++
```
## Reference guides
## Configuration Options
```toml
[extra]
# A line to display underneath the main title
subtitle = "Example subtitle"
# Text to display in the footer of the page
copyright = "Copyright authors year"
# Your Google Analytics ID
analytics = ""
# See below
katex_enable = false
# See below
instantpage_enable = false
```
A full example configuration is included in config.toml.
Note how pickles also expects `title` and `description` to also be set in the Zola configuration.
### KaTeX math formula support
This theme contains math formula support using [KaTeX](https://katex.org/), which can be enabled by setting `katex_enable = true` in the `extra` section of `config.toml`.
After enabling this extension, the `katex` short code can be used in documents:
* `{% katex(block=true) %}\KaTeX{% end %}` to typeset a block of math formulas,
similar to `$$...$$` in LaTeX
### Figure Shortcode
The figure shortcode is convenient for captioning figures.
```
{% figure(link="https://www.example.com/", src="https://www.example.com/img.jpeg", alt="sample alt text") %}
Your caption here.
{% end %}
```
### Table Shortcode
The table shortcode is convenient for making mobile-friendly tables (centered with overflow scrollbar).
```
{% table() %}
| Item | Price | # In stock |
| :----------- | ----: | ---------: |
| Juicy Apples | 1.99 | 739 |
| Bananas | 1.89 | 6 |
{% end %}
```
### Fontawesome
This theme includes fontawesome, so that fontawesome icons can be directly used.
### Instant.page
The theme contains instant.page prefetching. This can be enabled by setting `instantpage_enable = true` in the `extra` section of `config.toml`.
## Showing article summaries
By default, the theme will use the first 280 characters of your post as a summary, if a proper [page summary](https://www.getzola.org/documentation/content/page/#summary) using `` is not provided.
For more sensible summaries, we recommend using the manual more indicator.