aboutsummaryrefslogtreecommitdiffstats
path: root/man.sr.ht/index.md
diff options
context:
space:
mode:
authorDrew DeVault <sir@cmpwn.com>2019-04-12 11:56:09 -0400
committerDrew DeVault <sir@cmpwn.com>2019-04-12 11:56:09 -0400
commit034d92ce14251297c41f68cfbf7e37df5fe80d0f (patch)
tree9d8fd31ec85c480f8af853b1ce463c1048d50586 /man.sr.ht/index.md
parent8f4d5ccd2765ae841f529f8d9bde468a187d4987 (diff)
downloadsr.ht-docs-034d92ce14251297c41f68cfbf7e37df5fe80d0f.tar.gz
Add YAMl frontmatter to all pages
Diffstat (limited to 'man.sr.ht/index.md')
-rw-r--r--man.sr.ht/index.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/man.sr.ht/index.md b/man.sr.ht/index.md
index bb3f6c3..aacd017 100644
--- a/man.sr.ht/index.md
+++ b/man.sr.ht/index.md
@@ -1,3 +1,7 @@
+---
+title: man.sr.ht docs
+---
+
[man.sr.ht](https://man.sr.ht/) is a git-powered wiki that can host
documentation for your projects. Click "create wiki" in the sidebar
(or above if viewing on mobile) to get started (you will have to log in first).
@@ -19,6 +23,21 @@ the site](/markdown). Each page will be made available at the URL of the path to
the file, except for `index.md` which is also shown at the top-level of each
directory. Other kinds of files (html, images, etc) will not be served.
+## Frontmatter
+
+You may optionally begin a file with this pattern:
+
+```
+---
+# YAML goes here
+---
+```
+
+To add some extra metadata to your pages. The currently supported properties
+are:
+
+- **title**: set the article title
+
## Publishing your changes
Publishing your changes is as easy as committing them and pushing them