Edupress theme for mkdocs
Project description
mkdocs-edupress-theme
Edupress theme for mkdocs.
Recommend installing mkdocs-paginate-plugin for best results.
Example from this project: https://kubilus1.github.io/mkdocs-edupress-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-edupress-theme-0.0.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 695c9656cd787b54ac1feb2c2f44316c090927544621ac657c91b57a7b320f7f |
|
MD5 | 6023164f5bb8c3ba4a7f33e1d094f5d4 |
|
BLAKE2b-256 | 0b598cd8feeb510e5cc1ebadfbdae010ca76ce509a6a10e31865d81914e40998 |
Hashes for mkdocs_edupress_theme-0.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | cf6d42651fa98b6cb1a77b85655db794aef3252266c847a2007c590c4fd10523 |
|
MD5 | eb95d16df1c2c66e24ab357afe180d2e |
|
BLAKE2b-256 | db0255378ad1962cb0b09495670d299cf87a70b7f95ff0fda64ef723a6b73778 |