diff options
author | Filipe Brandenburger <filbranden@google.com> | 2019-01-02 14:16:34 -0800 |
---|---|---|
committer | Filipe Brandenburger <filbranden@google.com> | 2019-01-02 14:16:34 -0800 |
commit | c3e270f4eeda70396b5af8dc01ac2a7234f098b9 (patch) | |
tree | 35c0fc453460feefe7c5e35474368a59d8d901ee /docs/CODING_STYLE.md | |
parent | 8d7fac92f07cc662e51dcda7c9f3a322454895c7 (diff) | |
download | systemd-c3e270f4eeda70396b5af8dc01ac2a7234f098b9.tar.gz |
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.
Diffstat (limited to 'docs/CODING_STYLE.md')
-rw-r--r-- | docs/CODING_STYLE.md | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/docs/CODING_STYLE.md b/docs/CODING_STYLE.md index a91e119c4a..4a1cc59ce6 100644 --- a/docs/CODING_STYLE.md +++ b/docs/CODING_STYLE.md @@ -1,3 +1,7 @@ +--- +title: Coding Style +--- + # Coding Style - 8ch indent, no tabs, except for files in `man/` which are 2ch indent, |