README

Plume is your self-hosted, Markdown based publishing platform.

All posts (and pages) authored in Markdown, stored in a flat-file structure.

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

Features

• Dockerized installation allows you to be up and running quickly.
• Markdown rendering for publishing formatted articles easily.
• Flat file structure enables simple content management and backup.
• Light and dark mode to suit your professional needs or personal style.
• Advanced customization including Shiki powered syntax highligting and experimental theme support.

Requirements

Plume requires Docker with Docker Compose or PHP if installing manually.

Installation

Quickstart

For effortless management via Docker check out Plume Compose, a quick and easy way of getting up and running with a pre-configured Docker Compose configuration.

Other Installation Methods

See the Insallation documentation for more information.

Configuration

See the Configuration documentation for more information.

Sponsors

Love Plume? Sponsor development through a one-time donation or monthly sponsorship!

Changelog

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

Troubleshooting

See the Troubleshooting section of the documentation for troubleshooting instructions.

For general help and support join our GitHub Discussion or reach out on Bluesky.

Please report bugs to the GitHub Issue Tracker.

Copyright

This project is licensed under the MIT License.