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.20.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 11a18ce20387bbaf428e800bc59f43f98db69d57b6d0198aa7e94a565b04d4cf |
|
MD5 | 0e40db4999cebde823fd3abb1829ce79 |
|
BLAKE2b-256 | f2eadb0f8862d59c5096218643ae5255b2a83fe0ba3459044f0ec7babe025c68 |
Hashes for mkdocs_rebalance_theme-0.0.20-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e7b9b42dc42711b9c719a2ab166142eb88bc986678d05dac6f2a82b37e30bb87 |
|
MD5 | 2cf9fcdb18f6f9edafe72c3c27a328fc |
|
BLAKE2b-256 | 485463e3374005dab465d7bdba078cbe66224cdcdf90253b5e913b11ec5d2866 |