path: root/README.md
diff options
authorbnewbold <bnewbold@robocracy.org>2017-07-16 15:29:23 -0700
committerbnewbold <bnewbold@robocracy.org>2017-07-16 15:29:37 -0700
commit6844b59b818ec835fe5367979dc47efe04f62c4b (patch)
treed65fba91427b5a2e0f4b90463d6a0e99799a1c62 /README.md
parentcb208a450611405c0de9ce112a5d0786b600c1df (diff)
forgot to commit meta-json.template
Diffstat (limited to 'README.md')
1 files changed, 21 insertions, 0 deletions
diff --git a/README.md b/README.md
index 5e43752..df2b3e1 100644
--- a/README.md
+++ b/README.md
@@ -49,3 +49,24 @@ it yet.
You might want to write a shell script wrapper to help with configuration and
pushing multiple files to multiple spaces.
+It's probably possible to use any pandoc-supported markup file format (not just
+Markdown), but this hasn't been tested.
+Metadata can also be extracted from a pandoc-style YAML header in the markdown
+file itself. This is helpful if you want to override the (case-sensitive, and
+thus buggy) title/page matching behavior, or if you want to override the
+Confluence space for different documents.
+ ---
+ confluence-page-id: 12345
+ confluence-space-key: PRJ5
+ confluence-page-title: "Some Fancy Title Here"
+ ...
+Space Key is used for creating pages and doing title-based lookup. If page-id
+(a number which can be found in the URL of pages on the confluence site) is
+given, that is used for lookup and editing instead.
+Other confluence metadata, such as the page hierarchy, can be modified in the
+Confluence web interface and should persist across updates from this tool.