Plume Documentation

Appearance

Pages ​

text
/path/to/plume
├── data
│   ├── pages
│   │   ├── about-this-blog.md
│   │   └── something-else.md
│   └── [other data]
└── docker-compose.yaml

Front Matter ​

Pages, like posts, must contain some metadata like a title and the link text. This metadata is defined as "front matter", that is, some YAML set between triple-dashes (i.e. ---) and must be the first thing in the file.

markdown
---
title: About this Blog
link: About
weight: 200
---

Your page contents goes here...

Metadata Fields ​

The following metadata fields are supported for pages.

KeyTypeRequiredDetails
titlestring✅️Page title
linkstring✅️Navigation link text
weightint❌️Lower values will be sorted before higher value.

TIP

Metadata fields that are not required may be omitted.

Markdown ​

Immediately following the front matter should be your page contents, authored in Markdown format. See the Markdown documentation for more information about authoring with Markdown.

Publishing Pages ​

IMPORTANT

After adding a page you must publish your pages in order for the new page to show up in the list of pages (i.e. navigation).

Publishing pages will render the contents of and update the cache for all pages and the pages list.

console
docker compose run --rm php plume publish:pages
console
php plume publish:pages

Updating a page ​

Sometimes you may need to update a page after it's already been published (e.g. after making some edits). Publishing a single page will render the contents and update the cache for the specified page without updating the pages list.

console
docker compose run --rm php plume publish:page <slug>
console
php plume publish:page <slug>