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.11.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 09d82bf743ea60d2ec8b26ee6dedeb498be777c9e9161a992d0880cbeab7f518 |
|
MD5 | f6c174be3fa230bb79903bd5c56a40d6 |
|
BLAKE2b-256 | fe06b7a69e71cdaa9c68db879e2bb500e61cecb60677dcea53a3607f0e7946db |
Hashes for mkdocs_rebalance_theme-0.0.11-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fea04d8235124fd148f32ec6b3a5ab9e850947d169b1079c33764e453be4d19b |
|
MD5 | 6be5840998df44c364a9abd6ad3e8c92 |
|
BLAKE2b-256 | 8a2816477d9f7906172e28f55e790b5b932996d5d26db0ad4f0e28b0949bc770 |