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.9.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c8d72b8c562b64d69e74269bb054015b7eb33ca805ddaf207e72f0efcd00382f |
|
MD5 | 5c74ec7ef95c006e549ae74377e9d53e |
|
BLAKE2b-256 | aa7bc25453b16d22a4c85127b7d1cd3b125e7dbd1af381b709b9418a6097de9e |
Hashes for mkdocs_rebalance_theme-0.0.9-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8290f360d07655d0657974378a3657c425d7a2bf1631d28c558785da3bd68da9 |
|
MD5 | 7406e9c5d394ff2dcd12019e1b25b3d9 |
|
BLAKE2b-256 | ba9132ede2ade6b2c4ee74d036ef172eec80e93e4825eb9368b6748e1e4e24e7 |