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.12.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2b4a600ff925bb555c389ebba75382307c78bd740b37150491fea803a4bc4388 |
|
MD5 | 93a8c17285e0e751a3482c6bc7f478f5 |
|
BLAKE2b-256 | e7add2dd66be032de57174fecdeaa308f257ec0678155f66ac343c22e163f58d |
Hashes for mkdocs_rebalance_theme-0.0.12-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ba8cdae9c0fad1f1316438761f2ef4fa3b9b91840df86071b8cdad3ca6f4a653 |
|
MD5 | 835035af2d9128cc0b62571dce3cda10 |
|
BLAKE2b-256 | c8304a9a0d289faf9aa17bf7c07529b4a994681e43ec220a4a7831843acbc786 |