Skip to content

PHLAK/Plume

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

215 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.
  • Markdown rendering for publishing formatted articles easily.
  • Flat file structure for simple content management and backup.
  • Customization Custom pages, ...
  • Light and dark themes to suit your professional needs or personal style.
  • ???

Requirements

Plume requires Docker with Docker Compose or PHP (>= 8.2) if installing manually.

Installation

Quickstart

Coming soon, does not work yet
  1. Run curl -sSL https://init.plume.pub | sh
  2. Add your posts to the posts folder
  3. Run docker compose up -d

Docker Compose

For effortless management via Docker Compose check out Plume Compose.

Manual Docker Compose

  1. Download the docker-compose.yaml file to a directory of your choice
  2. Add your posts to the posts folder
  3. Run docker compose up -d

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 Help & Support 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.

Resources

License

Contributing

Security policy

Stars

Watchers

Forks

Sponsor this project

  •  

Contributors