Skip to main content
As a blog, the main purpose of Plume is facilitate authoring and publishing posts. This is made possible through Markdown files with a bit of YAML sprinkled in. To get started you may add your file with an extension of .md in the data/posts directory. 
/path/to/plume
├── data
│   ├── posts # Put your posts in this folder
│   │   ├── some-amazing-post.md
│   │   └── yet-another-post.md
│   └── [other data]
└── docker-compose.yaml
The name of the file (not including the .md extension) will be used as the post “slug”, the part that shows up in the URL. For example, for the file data/posts/vogon-poetry.md the URL would be something like example.com/posts/vogon-poetry.

​
Front Matter

In order for a post to be recognized by Plume it must contain some metadata like a title and published date. This metadata is defined as “front matter”, that is, some YAML set between tripple-dashes (i.e. ---) and must be the first thing in the file. 
---
title: An analysis of Vogon poetry
published: 2021-02-06 08:56:42
author: Arthur Dent
image:
  url: https://example.com/image.png
  caption: Photo by [Trillina McMillan](https://example.comm)
tags: [Vogons, Poetry, Art]
draft: true
---

Your post contents goes here...
The following meta data is supported.
KeyTypeRequiredDetails
titlestring✅️Post title
publishedstring, int✅️Post publish date
authorstring❌️Post author
image.urlstring❌️Reference uploaded images as /files/image-name.png
image.captionstring❌️Markdown allowed
tagsarray (of strings)❌️
draftboolean❌️
Metadata fields that aren’t requried rest may be omitted.

​
Markdown

Immediately following the front matter should be your post contents, authored in Markdown format. Plume supports the extended set of Markdown known as GitHub Flavored Markdown.
TODO: Alerts (NOTE, TIP, IMPORTANT, etc.)

​
Post Images

To add images to your posts you may upload your images to the data/files folder and reference them in your posts in markdown or raw HTML. 
![Image Alt Text](/files/some-image.png)
or 
<img src="/files/some-image.png" alt="Image Alt Text"></img>
You may also organize your images in arbitrary sub-folders as well as long as your links follow suite. For example, an image at data/images/some-post/example.png can be added like so. 
![Example Image](/files/images/some-post/example.png)