Skip to content

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

After adding or editing a page it must be published. Publishing a page will render the contents, and update the page cache.

Publish a single page

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

Publish all pages

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