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.21.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6637ae830247e9718aad2bac3e6181bb5f2688672f35990ed38b8de9025338fb |
|
MD5 | f2c9ddceed4eac7c1d86d4fc3562516f |
|
BLAKE2b-256 | b2e683f8e6e38e988a3ed877acbd725ff4a059c882747653e3dfdc2044feb479 |
Hashes for mkdocs_rebalance_theme-0.0.21-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d83a8d82905f770b922853ace10e16b22d1ea35f2ec68c0bb43ba515f862f109 |
|
MD5 | 12444b15eceff7f209374f170453c24f |
|
BLAKE2b-256 | 5ec8f96b4c2fc32ac8dfa8361fc7ff71700c127bfe1473967180c6463de2c264 |