📝 Your self-hosted, Markdown powered, flat-file publishing platform.
See the codeSee what people are saying (1)
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.
- 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.
- Theme support (experimental) for full customization of the look and feel of your app.
Requirements
Plume requires Docker with Docker Compose.
Alternatively, for a manual installation PHP is required.
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 Installation 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.
Contributors
341 commits
5 commits
Similar repos
Languages
PHP
84.7%
Twig
10.2%
JavaScript
1.8%
CSS
1.8%
Dockerfile
1.1%
📝 Your self-hosted, Markdown powered, flat-file publishing platform.
See the codeSee what people are saying (1)
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.
- 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.
- Theme support (experimental) for full customization of the look and feel of your app.
Requirements
Plume requires Docker with Docker Compose.
Alternatively, for a manual installation PHP is required.
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 Installation 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.
Similar repos
Contributors
341 commits
5 commits
Languages
PHP
84.7%
Twig
10.2%
JavaScript
1.8%
CSS
1.8%
Dockerfile
1.1%