summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorgumi <git@gumi.ca>2020-06-08 22:59:03 +0000
committergumi <git@gumi.ca>2020-06-08 22:59:08 +0000
commit619eb5e840119cf1ea9b9b691bc5210859b3f085 (patch)
tree577d32d6329a7630985dc6177b2fcdc5ad983a0f /README.md
parenta3fa1982cd10cb27a7fe553376c226d0fb96a1db (diff)
downloadpolicies-619eb5e840119cf1ea9b9b691bc5210859b3f085.tar.gz
policies-619eb5e840119cf1ea9b9b691bc5210859b3f085.tar.bz2
policies-619eb5e840119cf1ea9b9b691bc5210859b3f085.tar.xz
policies-619eb5e840119cf1ea9b9b691bc5210859b3f085.zip
use a YAML Front Matter instead of a separate YAML file
this will prevent forgetting to update the policy metadata since now they are in the same file
Diffstat (limited to 'README.md')
-rw-r--r--README.md37
1 files changed, 35 insertions, 2 deletions
diff --git a/README.md b/README.md
index c864528..c2a600f 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,43 @@
# The Mana World Policies
Contains the legal documents and policies observed by The Mana World.
-## Dependencies
-- [Deno](https://deno.land) 1.x (can be installed with `make deno`)
+## Policy files
+Policy files are are located in the [policies](policies) directory.
+Currently, only Markdown is supported for policy files.
+
+### Front Matter
+The Front Matter is a YAML document that defines the properties of the policy.
+
+#### Required properties
+- name: the full name of the policy
+- description: a short summary of the policy
+
+#### Optional properties
+- aliases: an array of path aliases (redirects)
+- ignore: prevents the policy file from being built
+
+### Example
+```md
+---
+name: Policy Name
+description: A short sumary
+aliases: [foo, bar]
+---
+
+# title
+content
+```
+
+<br>
+
+---
## Generating the static site
+
+### Dependencies
+- GNU Make (pre-installed in most linux distros)
+- [Deno](https://deno.land) 1.x (can be installed with `make deno`)
+
```sh
make build
```