Skip to content
This repository has been archived by the owner on Jun 9, 2023. It is now read-only.

A reader for Pelican that understands YAML-formatted metadata

Notifications You must be signed in to change notification settings

pR0Ps/pelican-yaml-metadata

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 

Repository files navigation

!!! This plugin has been moved !!!

See: https://github.com/pelican-plugins/yaml-metadata

This plugin now lives under the pelican-plugins organization. The repo is only being kept here in order to not break existing deployments and will receive no further development.

pelican-yaml-metadata

This Pelican plugin allows articles written in Markdown to define their metadata using a YAML header. This format is compatible with other popular static site generators like Jekyll or Hugo.

It is fully backwards-compatible with the default metadata parsing.

Usage

This plugin aims to keep things simple. After installing and enabling it, any markdown files will have the option of defining metadata using a YAML header instead of the standard key/value pairs.

In order to specify metadata using YAML, simply enclose it within --- lines.

Example:

---
title: Some title
author: Some person
tags:
  - tag 1
  - tag 2
date: 2014-12-25 00:00
summary: The article summary will be __parsed__ as markdown
---

This is some article text.

If the YAML block is not found, the metadata will be parsed using the normal markdown metadata syntax.

Installation

  1. Install using pip (pip install git+https://github.com/pR0Ps/pelican-yaml-metadata.git)
  2. Enable the plugin in your pelicanconf.py by adding "yaml_metadata" to the PLUGINS list.

License

Licensed under the MIT license

About

A reader for Pelican that understands YAML-formatted metadata

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages