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 Distributions
Built Distribution
Hashes for mkdocs_rebalance_theme-0.0.17-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 34efae9a324b08bc022d907bea4a3ba1fbb86f354131d64c5e26a699a5d98748 |
|
MD5 | 9b3d32ff00a9916c8f1ca842c3685e7e |
|
BLAKE2b-256 | 2909ac74161b7c73f08b6d042dfaa61af1369aac7c194d0a56458d9d4e092df9 |