Skip to content

PHLAK/Plume

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

269 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Plume

Join our Community Become a Sponsor One-time Donation
Packagist PHP Version Support License


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

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

Screenshot

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 highligting.
  • Full text search to find the content you're looking for, powered by YetiSearch.
  • Automatic light and dark modes based on the users system theme with custom override.
  • 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 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.

About

Your self-hosted, Markdown powered, flat-file publishing platform.

Topics

Resources

License

Contributing

Security policy

Stars

Watchers

Forks

Sponsor this project

  •  

Contributors