Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/micahkepe/radion
Custom Zola theme modeled off of "after-dark"
https://github.com/micahkepe/radion
blog static-site-generator zola-theme
Last synced: 22 days ago
JSON representation
Custom Zola theme modeled off of "after-dark"
- Host: GitHub
- URL: https://github.com/micahkepe/radion
- Owner: micahkepe
- License: mit
- Created: 2024-11-05T18:21:27.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2024-11-21T17:05:21.000Z (about 1 month ago)
- Last Synced: 2024-11-21T18:19:47.857Z (about 1 month ago)
- Topics: blog, static-site-generator, zola-theme
- Language: SCSS
- Homepage: https://micahkepe.com/blog/
- Size: 43.5 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# radion
Enhancements to the [`after-dark`](https://github.com/getzola/after-dark) Zola
theme originally developmed by Vincent Prouillet.
Demo: https://micahkepe.com/blog/
## Features
- [x] Code Snippet Clipboards
- [ ] Line(s)-specific highlighting
- [x] Latex Support
- [x] Light/Dark mode support
- [x] Search functionality
- [ ] Table of Contents shortcode
## Contents
- [Installation](#installation)
- [Options](#options)
- [Top menu](#top-menu)
- [Title](#title)
- [Author](#author)
- [Code Snippets](#code-snippets)
- [LaTex Support](#latex-support)
- [Searchbar](#searchbar)
- [Light and Dark Modes](#light-and-dark-modes)
- [Acknowledgements](#acknowledgements)
## Installation
First download this theme to your `themes` directory:
```bash
cd themes
git clone https://github.com/micahkepe/radion
```
and then enable it in your `config.toml`:
```toml
theme = "radion"
```
This theme requires your index section (`content/_index.md`) to be paginated to work:
```toml
paginate_by = 5
```
The posts should therefore be in directly under the `content` folder.
The theme requires tags and categories taxonomies to be enabled in your
`config.toml`:
```toml
taxonomies = [
# You can enable/disable RSS
{name = "categories", feed = true},
{name = "tags", feed = true},
]
```
If you want to paginate taxonomies pages, you will need to overwrite the
templates as it only works for non-paginated taxonomies by default.
## Options
### Top-menu
Set a field in `extra` with a key of `radion_menu`:
```toml
radion_menu = [
{url = "$BASE_URL", name = "Home"},
{url = "$BASE_URL/categories", name = "Categories"},
{url = "$BASE_URL/tags", name = "Tags"},
{url = "https://google.com", name = "Google"},
]
```
If you put `$BASE_URL` in a url, it will automatically be replaced by the actual
site URL.
### Title
The site title is shown on the homepage. As it might be different from the
`` element that the `title` field in the config represents, you can set
the `radion_title` instead.
### Author
You can set this on a per page basis or in the config file.
`config.toml`:
```toml
[extra]
author = "John Smith"
```
In a page (wrap this in +++):
```toml
title = "..."
date = 1970-01-01
[extra]
author = "John Smith"
```
### Code Snippets
Syntax Highlighting:
```toml
[markdown]
# Whether to do syntax highlighting
# Theme can be customized by setting the `highlight_theme` variable to a theme supported by Zola
highlight_code = true
highlight_theme = "one-dark"
```
Enhanced Codeblocks (Clipboard Support and Language Tags)
```toml
[extra]
codeblock = true
```
### LaTex Support
To enable LaTeX support with MathJax, set the following in your `config.toml`:
```toml
[extra]
latex = true
```
### Searchbar
To enable a searchbar at the top of the page navigation, set the following in
your `config.toml`:
```toml
build_search_index = true
[search]
index_format = "elasticlunr_json"
[extra]
enable_search = true
```
### Light and Dark Modes
To set the color theme of the site, set the following in your `config.toml`:
```toml
[extra]
theme = "toggle" # options: {light, dark, auto, toggle}
```
There are four options for the `theme` field:
- `light`: Always light mode
- `dark`: Always dark mode
- `auto`: Automatically switch between light and dark mode based on the user's
system preferences
- `toggle`: Allow the user to toggle between light and dark mode
## Acknowledgements
Lots of inspiration and code snippets taken from these awesome Zola themes:
- [`after-dark`](https://github.com/getzola/after-dark) by
[Vincent Prouillet](https://www.vincentprouillet.com/)
- [`apollo`](https://github.com/not-matthias/apollo/tree/main) by
[not-matthias](https://github.com/not-matthias)
- [`redux`](https://github.com/SeniorMars/redux) by
[SeniorMars](https://github.com/SeniorMars).