Skip to main content

A minimal blog theme for MkDocs, based on the MkDocs Simple Blog, by Fernando Celmer.

Project description

MkDocs Mini Blog

Documentation Publish to PyPI

Mini Blog is a theme for MkDocs, a static site generator that's geared towards building project documentation. Follow the instructions below to install and activate the theme. For full documentation visit the project's documentation site.

Install

To install MkDocs, run the following command from the command line:

pip install mkdocs

Then, install the theme using PIP:

pip install mkdocs-mini-blog

Activating theme

After the theme is installed, edit your mkdocs.yml file and set the theme name to mini-blog:

theme:
    name: mini-blog

Getting Help

We use GitHub issues for tracking bugs and feature requests and have limited bandwidth to address them. If you need anything, I ask you to please follow our templates for opening issues or discussions.

License

GitHub License

This project is licensed under the terms of the MIT License.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mkdocs_mini_blog-0.1.0.tar.gz (275.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mkdocs_mini_blog-0.1.0-py3-none-any.whl (281.6 kB view details)

Uploaded Python 3

File details

Details for the file mkdocs_mini_blog-0.1.0.tar.gz.

File metadata

  • Download URL: mkdocs_mini_blog-0.1.0.tar.gz
  • Upload date:
  • Size: 275.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for mkdocs_mini_blog-0.1.0.tar.gz
Algorithm Hash digest
SHA256 b130841502f546eed2318dd38b8b456165f92828c2c0734475b61151605f8e27
MD5 69a7181d16440c2368aaa19af5e6d544
BLAKE2b-256 78afc55ccb5ce618c54cbf9b653260b23847151abf0fc9b5fa8423c5d92a6573

See more details on using hashes here.

Provenance

The following attestation bundles were made for mkdocs_mini_blog-0.1.0.tar.gz:

Publisher: release.yml on dpoulopoulos/mkdocs-mini-blog

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file mkdocs_mini_blog-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for mkdocs_mini_blog-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ee7670c0487b6659553ed85faca067f3ab8d0164b9c760e8ff98f9f3c78e8c4e
MD5 6697ac35ed910c6a797329b570156139
BLAKE2b-256 d34d3687fa73d7cb277c8bbd4667fd7cfd88656cf1aaa6f05a93e5b5165dc28e

See more details on using hashes here.

Provenance

The following attestation bundles were made for mkdocs_mini_blog-0.1.0-py3-none-any.whl:

Publisher: release.yml on dpoulopoulos/mkdocs-mini-blog

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page