Skip to main content
As a publishing platform (i.e. blog), the main purpose of Plume is to facilitate the authoring and publishing of posts. This is made possible through Markdown files with a bit of YAML sprinkled in. To get started you may add your files 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.com)
tags: [Vogons, Poetry, Art]
draft: true
---

Your post contents goes here...

​
Metadata Fields

The following metadata fields are 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 are not 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.

​
Alerts

In addition to the GitHub Flavored Markdown spec Plume supports “Alerts” (a.k.a. callouts or admonitions), an extension of the blockquote syntax useful for emphasizing important information. Alerts render as block quotes with a distinctive color and icon to emphasize the content. 
> [!NOTE]
> Useful information that users should know, even when skimming content.

> [!TIP]
> Helpful advice for doing things better or more easily.

> [!IMPORTANT]
> Key information users need to know to achieve their goal.

> [!WARNING]
> Urgent info that needs immediate user attention to avoid problems.

> [!CAUTION]
> Advises about risks or negative outcomes of certain actions.
TODO: Add a screenshot

​
Post Images

Images can be uploaded to the data/files folder and referenced in your post markdown or raw HTML. 
![Image Alt Text](/files/some-image.png)
or 
<img src="/files/some-image.png" alt="Image Alt Text"></img>
Make sure you preface the file path with a forward slash (i.e. /).
You may also organize your images in arbitrary sub-folders as long as your links follow suit. For example, an image at data/images/some-post/example.png can be referenced like so. 
![Example Image](/files/images/some-post/example.png)