Breve Documentation

Introduction ​

Welcome to Breve, your self-hosted, Markdown-powered publishing platform.

Breve Screenshot

Breve is quick and easy to set up with Docker Compose and simple to manage with all posts (and pages) authored in Markdown and stored in a flat-file structure. And with flexible customization options Breve can be tailored to fit your personal or professional style.

Features ​

  • Dockerized installation allows you to be up and running quickly.
  • Flat file structure enables simple content management and backup.
  • Markdown rendering for publishing, including Shiki powered syntax highlighting.
  • Full text search to find the content you're looking for, powered by YetiSearch.
  • Automatic light and dark modes based on the user's system theme with custom override.
  • RSS feed for post syndication.

Changelog ​

A list of changes can be found on the GitHub Releases page.

Support ​

Support Breve development through a one-time donation or monthly sponsorship.

Breve is created and maintained by Chris Kankiewicz (@PHLAK.dev).

This project is licensed under the MIT License.