From 23a0a642334890004b9183e396f55120a69b8e2a Mon Sep 17 00:00:00 2001
From: Simon Michael <simon@joyful.com>
Date: Fri, 4 Oct 2019 09:53:59 -1000
Subject: [PATCH] note some editing tips in-doc

---
 index.html | 26 ++++++++++++++++++++++++--
 index.md   | 27 +++++++++++++++++++++++++--
 2 files changed, 49 insertions(+), 4 deletions(-)

diff --git a/index.html b/index.html
index d1d52da..3dc5299 100644
--- a/index.html
+++ b/index.html
@@ -34,8 +34,30 @@
   –––––––––––––––––––––––––––––––––––––––––––––––––– -->
   <div class="container">
 
-<!-- CSS: http://getskeleton.com -->
-<!-- markdown: http://pandoc.org/README.html -->
+<!--
+Editing tips:
+
+This is pandoc markdown (markdown-smart+autolink_bare_uris) + html.
+http://pandoc.org/README.html
+index.tmpl defines the page layout, using normalize, skeleton and local css.
+http://getskeleton.com
+We run pandoc locally and commit the html it generates, eg index.html.
+
+If editing via github web UI:
+- you can see an approximate preview with the Preview tab
+- no need to update the generated html; we'll do that when needed
+
+If editing in a local clone:
+- you can use make html or make html-watch to see an accurate preview
+- if you do, you might as well commit the updated html as well; 
+  otherwise we'll do that when needed
+
+If using emacs markdown-mode:
+- S-TAB cycles heading/content visibility
+- TAB on a heading cycles visibility of that section
+- C-x n s/C-x n w on a heading narrows to/widens from that section
+
+-->
 <div style="float:right; position:fixed; bottom:1em; right:1em;">
 <p><a href="https://github.com/plaintextaccounting/plaintextaccounting.github.io"><img src="https://img.shields.io/github/stars/plaintextaccounting/plaintextaccounting.github.io.svg?style=social&amp;label=Github" alt="github" title="send pull requests, bug reports, blog posts, star us, tweet with #plaintextaccounting tag" /></a></p>
 </div>
diff --git a/index.md b/index.md
index 3057652..9a936fb 100644
--- a/index.md
+++ b/index.md
@@ -1,7 +1,30 @@
 % Plain Text Accounting, a guide to Ledger and friends
 
-<!-- CSS: http://getskeleton.com -->
-<!-- markdown: http://pandoc.org/README.html -->
+<!--
+Editing tips:
+
+This is pandoc markdown (markdown-smart+autolink_bare_uris) + html.
+http://pandoc.org/README.html
+index.tmpl defines the page layout, using normalize, skeleton and local css.
+http://getskeleton.com
+We run pandoc locally and commit the html it generates, eg index.html.
+
+If editing via github web UI:
+- you can see an approximate preview with the Preview tab
+- no need to update the generated html; we'll do that when needed
+
+If editing in a local clone:
+- you can use make html or make html-watch to see an accurate preview
+- if you do, you might as well commit the updated html as well; 
+  otherwise we'll do that when needed
+
+If using emacs markdown-mode:
+- S-TAB cycles heading/content visibility
+- TAB on a heading cycles visibility of that section
+- C-x n s/C-x n w on a heading narrows to/widens from that section
+
+-->
+
 <div style="float:right; position:fixed; bottom:1em; right:1em;">
 [![github](https://img.shields.io/github/stars/plaintextaccounting/plaintextaccounting.github.io.svg?style=social&label=Github){title="send pull requests, bug reports, blog posts, star us, tweet with #plaintextaccounting tag"}](https://github.com/plaintextaccounting/plaintextaccounting.github.io)
 </div>