Rebalance theme for mkdocs
Project description
mkdocs-rebalance-theme
Rebalance theme for mkdocs. Based off of https://github.com/Automattic/themes/tree/master/rebalance
Recommend installing mkdocs-paginate-plugin for best results.
Example from this project: https://kubilus1.github.io/mkdocs-rebalance-theme/
Layout
This is intended for a typical blog style layout. A top level 'index.md' is expected, but basically ignored. Posts can be in a subdir or in the top level directory. All files will be collected and treated as posts.
Extras
This theme supports a few special yaml config items in your posts such as:
index: <int>
This allows you to control the layout of posts. These will be sorted in reverse order. As you add new posts you can expect the greatest number/newest to be first.
featured_image: <path>
Adds a featured image to a post. This should be relative to the top level of
the site_url. Leave off any beginning /
tags: [<list of tags>]
Adds lists of tags on the homepage for each post. This may be used at a later point to show pages of matching tags.
author: <name>
Show the post's author. This may be used in the future to provide a page of matching articles.
date: <date>
Show the date of a post.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for mkdocs-rebalance-theme-0.0.19.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | fee7c8f7f9ef497563077cda383d0f8caf14e0fbb70fb124592dac31c80b80f3 |
|
MD5 | aae218ce0d7979daebf0d1ba9b564be6 |
|
BLAKE2b-256 | d3eeec54800703152dd66d255748f391d794dee3ba1464b5bd2bc93d18b116e9 |
Hashes for mkdocs_rebalance_theme-0.0.19-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 36398b3c0524d97357965642ff795508305b05aa15670f299fd6930aa5623b5a |
|
MD5 | eaf1cfa878a9f5f5931d00f66d771ef0 |
|
BLAKE2b-256 | b0d918d4d25b18ea1d04408760b15fe0207f64da873cb2fc68e3c9d3d3c91985 |