]> git.ipfire.org Git - thirdparty/systemd.git/commit - docs/HACKING.md
docs: add a "front matter" snippet to our markdown pages
authorFilipe Brandenburger <filbranden@google.com>
Wed, 2 Jan 2019 22:16:34 +0000 (14:16 -0800)
committerFilipe Brandenburger <filbranden@google.com>
Wed, 2 Jan 2019 22:16:34 +0000 (14:16 -0800)
commitc3e270f4eeda70396b5af8dc01ac2a7234f098b9
tree35c0fc453460feefe7c5e35474368a59d8d901ee
parent8d7fac92f07cc662e51dcda7c9f3a322454895c7
docs: add a "front matter" snippet to our markdown pages

It turns out Jekyll (the engine behind GitHub Pages) requires that pages
include a "Front Matter" snippet of YAML at the top for proper rendering.

Omitting it will still render the pages, but including it opens up new
possibilities, such as using a {% for %} loop to generate index.md instead of
requiring a separate script.

I'm hoping this will also fix the issue with some of the pages (notably
CODE_OF_CONDUCT.html) not being available under systemd.io

Tested locally by rendering the website with Jekyll. Before this change, the
*.md files were kept unchanged (so not sure how that even works?!), after this
commit, proper *.html files were generated from it.
19 files changed:
docs/AUTOMATIC_BOOT_ASSESSMENT.md
docs/BLOCK_DEVICE_LOCKING.md
docs/BOOT_LOADER_INTERFACE.md
docs/BOOT_LOADER_SPECIFICATION.md
docs/CGROUP_DELEGATION.md
docs/CODE_OF_CONDUCT.md
docs/CODE_QUALITY.md
docs/CODING_STYLE.md
docs/CONTRIBUTING.md
docs/DISTRO_PORTING.md
docs/ENVIRONMENT.md
docs/HACKING.md
docs/PORTABLE_SERVICES.md
docs/PREDICTABLE_INTERFACE_NAMES.md
docs/RELEASE.md
docs/TRANSIENT-SETTINGS.md
docs/TRANSLATORS.md
docs/UIDS-GIDS.md
docs/index.md