new mkdoc, local, using pandoc

sitaramc · Dec 7, 2013 · f27380d · f27380d
1 parent 117452d
commit f27380d
Show file tree

Hide file tree

Showing 32 changed files with 160 additions and 166 deletions.
diff --git a/common-header.html b/common-header.html
@@ -0,0 +1,12 @@
+<p style="text-align:center">
+    <a href="master-toc.html">master TOC</a>
+|
+    <a href="index.html">main page</a>
+|
+    <a href="gitolite.html">single-page</a>
+|
+    <a href="index.html#license">license</a>
+</p>
+<p style="text-align:center">
+<font color="gray">This is for gitolite "g3"; for older (v2.x) documentation click <a href="http://sitaramc.github.com/gitolite/g2/master-toc.html">here</a></font>
+</p>
diff --git a/contrib/sskm.mkd b/contrib/sskm.mkd
@@ -1,5 +1,7 @@
 # changing keys -- self service key management
 
+<!-- pandoc: toc -->
+
 Copyright: Jeff Mitchell (jmitchell@kde.org).  Licensed under CC-BY-NC-SA
 unported 3.0, http://creativecommons.org/licenses/by-nc-sa/3.0/
 
@@ -11,10 +13,6 @@ The key management is done using a command called `sskm`.  This command must be
 
 ----
 
-TOC
-
-----
-
 ## Important!
 
 There are a few things that you should know before using the key management system. Please do not ignore this section!

diff --git a/contrib/ukm.mkd b/contrib/ukm.mkd
@@ -1,5 +1,7 @@
 # user key management
 
+<!-- pandoc: toc -->
+
 Copyright 2012-2013  Ralf Hemmecke <ralf@hemmecke.org>.
 
 Licensed under the [Creative Commons
@@ -15,10 +17,6 @@ below.
 
 ----
 
-TOC
-
-----
-
 ## Important Warning!
 
 User key management undermines the fundamental principle of gitolite

diff --git a/cookbook.mkd b/cookbook.mkd
@@ -1,5 +1,7 @@
 # gitolite cookbook
 
+<!-- pandoc: toc -->
+
 Documentation is meant to be as complete as possible, which means it attempts
 to cover all situations and scenarios.  That makes it harder to read.
 
@@ -16,10 +18,6 @@ documentation before asking for help.  In particular, the [basic][] and
 
 ----
 
-TOC
-
-----
-
 ## #cb-admin administration
 
 ### separating "key admin" from "repo admin"

diff --git a/cust.mkd b/cust.mkd
@@ -1,5 +1,7 @@
 # customising gitolite
 
+<!-- pandoc: toc -->
+
 Much of gitolite (g3)'s functionality comes from programs and scripts that are
 not considered "core".  This keeps the core simpler, and allows you to enhance
 gitolite for your own purposes without too much fuss.  (As an extreme example,
@@ -18,10 +20,6 @@ Here's how to find out more:
 
 ----
 
-TOC
-
-----
-
 ## #ncintro introduction
 
 There are 5 basic types of non-core programs.

diff --git a/dev-notes.mkd b/dev-notes.mkd
@@ -1,8 +1,6 @@
 # notes for developers
 
-TOC
-
-----
+<!-- pandoc: toc -->
 
 Gitolite has a huge bunch of existing features that gradually need to be moved
 over.  Plus you may want to write your own programs to interact with it.

diff --git a/dev-status.mkd b/dev-status.mkd
@@ -1,4 +1,4 @@
-# #dev-status g3 development status
+# g3 development status
 
 Not yet done (will be tackled in this order unless someone asks):
 

diff --git a/emergencies.mkd b/emergencies.mkd
@@ -1,12 +1,12 @@
 # help for emergencies
 
-----
+<!-- pandoc: toc -->
 
-"Don't Panic!"
+>   ----
 
-----
+>   .@red<**"Don't Panic!"**>@
 
-TOC
+>   ----
 
 ## install/setup issues
 

diff --git a/extras/glssh.mkd b/extras/glssh.mkd
@@ -1,8 +1,6 @@
-# #glssh how gitolite uses ssh
+# how gitolite uses ssh
 
-TOC
-
-----
+<!-- pandoc: toc -->
 
 Although other forms of authentications exist (see the document on
 [authentication versus authorisation][auth]), ssh is the one that most git

diff --git a/extras/sts.mkd b/extras/sts.mkd
@@ -1,4 +1,6 @@
-# #sts ssh troubleshooting and tips
+# ssh troubleshooting and tips
+
+<!-- pandoc: toc -->
 
 **This document must be read in full the first time.  If you start from some
 nice looking section in the middle it may not help you unless you're already
@@ -10,10 +12,6 @@ tricks that gitolite can do.
 
 ----
 
-TOC
-
-----
-
 ## IMPORTANT -- READ THIS FIRST
 
 ### caveats

diff --git a/g2migr-example.mkd b/g2migr-example.mkd
@@ -1,8 +1,8 @@
 # migration example
 
-This shows what a typical migration would look like, using a test setup.
+<!-- pandoc: toc -->
 
-TOC
+This shows what a typical migration would look like, using a test setup.
 
 ## existing setup
 

diff --git a/g2migr.mkd b/g2migr.mkd
@@ -1,14 +1,12 @@
-# #g2migr pre-migration checklist
+# pre-migration checklist
+
+<!-- pandoc: toc -->
 
 <font color="red"> **This document is a *MUST* read if you are currently using
 g2 and want to move to g3.** </font>
 
 ----
 
-TOC
-
-----
-
 First things first: g2 will be supported for a good long time for critical
 bugs, although enhancements and new features won't happen.
 

diff --git a/git-config.mkd b/git-config.mkd
@@ -1,8 +1,6 @@
 # "git-config" keys and values
 
-TOC
-
-----
+<!-- pandoc: toc -->
 
 Here's all you want to know about setting repo-specific git-config values.