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.1.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.1-py3-none-any.whl (281.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: mkdocs_mini_blog-0.1.1.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.1.tar.gz
Algorithm Hash digest
SHA256 e294a1daeea56b77ca02c2f4d7a860b2e4fb2df489fa0aaaaaca38e0f93b71a4
MD5 d6ec4e004e4cb77d4c1e732d1a55bf28
BLAKE2b-256 35abff942e41ecb0b8bdf6b0455f9ed87494746bc2b233cbe87df94ba44b0547

See more details on using hashes here.

Provenance

The following attestation bundles were made for mkdocs_mini_blog-0.1.1.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.1-py3-none-any.whl.

File metadata

File hashes

Hashes for mkdocs_mini_blog-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 5b474b7d4ca9a681e547f2ad3a26f224fdb687b4f46e909932ffb6f19689a679
MD5 6893a74ee4345d809171de0d5a75d0ea
BLAKE2b-256 f088d4c92fb7a0aa89a8b6f12636d4c602e29a41e8f3a12757ad7612d1f66647

See more details on using hashes here.

Provenance

The following attestation bundles were made for mkdocs_mini_blog-0.1.1-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