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.14.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | dc19d929fe61cfcae56aa7f85ba62f7ab48a4c177ce37048711a8d4ac0a7fa62 |
|
MD5 | 1b915847f78ce95f4415aef86f13a828 |
|
BLAKE2b-256 | fd13f378f4e3a30368bb14feef00d914fed396e6969cb2ae41dc157f0eb43dfb |
Hashes for mkdocs_rebalance_theme-0.0.14-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fd8e4309708e306c1c5e92b5e48c0c62b7b0528a03ae32df6e6cd46872655991 |
|
MD5 | 153d487e930f476dc13bfa5659aeeb49 |
|
BLAKE2b-256 | 526f83b756ac8ca79bd33c0c0d3275fe2db7e4a290247971feec48430bc5852a |