« get me outta code hell

hsmusic-docs - Unnamed repository; edit this file 'description' to name the repository.
about summary refs log tree commit diff
path: root/documents/news.md
diff options
context:
space:
mode:
Diffstat (limited to 'documents/news.md')
-rw-r--r--documents/news.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/documents/news.md b/documents/news.md
new file mode 100644
index 0000000..b019572
--- /dev/null
+++ b/documents/news.md
@@ -0,0 +1,12 @@
+# News Format
+
+News documents are stored all in one file, `news.yaml`, one document (entry) per news entry.
+
+## News entry documents
+
+Linked as `[[news-entry:directory]]`.
+
+* `Name`: news entry name
+* `Directory`: unique identifier among other news entries
+* `Date`: date of news entry posting
+* `Content`: news entry body (use `<hr class="split">` for "read more" link)