Skip to content

Latest commit

 

History

History
86 lines (65 loc) · 2.4 KB

README.md

File metadata and controls

86 lines (65 loc) · 2.4 KB

Minimola

Minimola is a Minima v2 Clone originally based on Even is a clean, responsive theme featuring categories, tags, an authors taxonomy for multi-author blogs, and pagination.

It deviates from Minima in some ways: E.g., it supports automatic dark-mode and uses purple for visited links and features link colors to achieve WCAG Compliance.

Contents

Installation

First download this theme to your themes directory:

cd themes
git clone https://github.com/1peter10/minimola.git

and then enable it in your config.toml:

theme = "minimola"

The theme requires tags and categories taxonomies to be enabled in your config.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.

It also requires to put 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"
+++

Options

Top-menu

Set a field in extra with a key of blog_menu:

# This is the default menu
blog_menu = [
    {url = "$BASE_URL", name = "Home"},
    {url = "$BASE_URL/categories", name = "Categories"},
    {url = "$BASE_URL/tags", name = "Tags"},
    {url = "$BASE_URL/about", name = "About"},
]

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 header. As it might be different from the <title> element that the title field in the config represents, you can set the even_title instead.

Special Features

Extra front-matter options for Posts and Pages

[extra]
update_note = "Text to show when the updated is used to date the latest update, e.g., to explain changes."
# adds a link to your code hosting site, which directs to the place to edit the post or page (edit_post_with_images is for posts that live in a folder
edit_post = true
edit_post_with_images = true
edit_page

More documentation

Check the comments in config.toml, or open an Issue!