gitolite/doc/mkdoc

#!/usr/bin/perl

#   cd <g3 clone>/doc; ./mkdoc     # --> creates ../html/*.html

my $MKD = "./Markdown.pl";

use 5.10.0;
use strict;
use warnings;
use lib '../src/lib/Gitolite/Test';
use Tsh;

$ENV{TSH_ERREXIT} = 1;

try "
    mkdir ../html;                      ok
    git status -s -uno;                 !/./
    git log --oneline -1
" or die 1;

my $head = (lines())[0];

main();

try "
    git checkout gh-pages;              ok
    git reset --hard github/gh-pages;   ok
    cd ..;                              ok
    git rm *.html;                      ok
    mv html/*.html .;                   ok
    git add *.html;                     ok
    git commit -m '$head';              ok
    git checkout master;                ok
    rmdir html;                         ok
" or die 2;

sub main {
    chomp(@ARGV = `find . -name "*.mkd" | cut -c3-`) if not @ARGV;
    @ARGV = grep { /./ } @ARGV;
    my @save = @ARGV;
    my $css_block = join("", <DATA>);

    my %ct; # chapter tocs
    my %title;
    my $mf = '';
    my $fh;

    while (<>) {
        $ARGV =~ /^(?:.*\/)?([^\/]+)\.mkd$/;
        my $b = $1;

        if (/^(#+) (?:#(\S+) )?(.*)/) {
            $title{$b} ||= $3;
            if ( length($1) == 1 ) {
                $ct{$b} .= "\n";
                $ct{$b} .= "  * [$3][$b]\n";
                $mf .= "[$b]: $b.html\n";
            } else {
                $ct{$b} .= " " x ( 4 * ( length($1) - 1 ) );
                $ct{$b} .= "  * ";
                $ct{$b} .= (
                    $2
                    ? "[$3][$2]"
                    : "$3"
                );
                $ct{$b} .= "\n";
                $mf .= "[$2]: $b.html" . ($2 ne $b ? "#$2" : "") . "\n" if $2;
            }
        }
    }

    # open($fh, ">", "master-toc.mk2")
    #   and print $fh $mt
    #   and close $fh;

    # after this, do this for every mkd (including the master-toc.mkd)

    #       cat $css_block > $base.html
    #       cat $base.mkd $mf | $MKD >> $base.html

    for my $mkd (@save) {
        $mkd =~ /^(?:.*\/)?([^\/]+)\.mkd$/;
        my $b = $1;

        my $css = $css_block;
        $css =~ s/%TITLE/$title{$b} || $b/e;

        open($fh, ">", "../html/$b.html")
          and print $fh $css
          and close $fh;

        my $mkt = `cat $mkd`;
        $mkt =~ s/^(#+) #(\S+) /$1 <a name="$2"><\/a> /mg;
        $mkt =~ s/^\[\[TOC\]\]/$ct{$b}/mg;
        open($fh, "|-", "$MKD >> ../html/$b.html")
          and print $fh $mkt, "\n\n", $mf
          and close $fh;
    }
}

__DATA__

<head>
    <title>%TITLE</title>
<style>
    body        { background: #fff; text-color: #000; margin-left:  40px;   font-size:  0.9em;  font-family: sans-serif; max-width: 800px; }
    h1          { background: #ffb; text-color: #000; margin-left: -30px;   border-top:    5px  solid #ccc; }
    h2          { background: #ffb; text-color: #000; margin-left: -20px;   border-top:    3px  solid #ddd; }
    h3          { background: #ffb; text-color: #000; margin-left: -10px; }
    h4          { background: #ffb; text-color: #000; }
    code        { font-size:    1.1em;  background:  #ddf; text-color: #000; }
    pre         { margin-left:  2em;    background:  #ddf; text-color: #000; }
    pre code    { font-size:    1.1em;  background:  #ddf; text-color: #000; }
</style>
</head>

<p style="text-align:center">
    <a href="master-toc.html">master TOC</a>
|
    <a href="index.html">main 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>
Q: all doc stuff 2012-03-16 02:54:47 +01:00			`#!/usr/bin/perl`

minor fixup to mkdoc; also pulled in Markdown.pl 2012-03-25 00:39:58 +01:00			`# cd <g3 clone>/doc; ./mkdoc # --> creates ../html/*.html`
Q: all doc stuff 2012-03-16 02:54:47 +01:00
minor fixup to mkdoc; also pulled in Markdown.pl 2012-03-25 00:39:58 +01:00			`my $MKD = "./Markdown.pl";`
Q: all doc stuff 2012-03-16 02:54:47 +01:00
			`use 5.10.0;`
			`use strict;`
			`use warnings;`
supporting DOS and fake Unix... I was very, very, tempted to say "sorry; not supported". Sadly, prudence won over juvenile glee... PS: DOS == dominant operating system 2012-04-06 16:59:05 +02:00			`use lib '../src/lib/Gitolite/Test';`
(mkdoc) make it do a little more post-mkdoc work 2012-03-26 01:54:21 +02:00			`use Tsh;`

			`$ENV{TSH_ERREXIT} = 1;`

			`try "`
			`mkdir ../html; ok`
			`git status -s -uno; !/./`
			`git log --oneline -1`
			`" or die 1;`

			`my $head = (lines())[0];`

			`main();`

			`try "`
			`git checkout gh-pages; ok`
			`git reset --hard github/gh-pages; ok`
			`cd ..; ok`
(doc) switch g2 <-> g3 2012-04-16 07:07:45 +02:00			`git rm *.html; ok`
			`mv html/*.html .; ok`
			`git add *.html; ok`
(mkdoc) make it do a little more post-mkdoc work 2012-03-26 01:54:21 +02:00			`git commit -m '$head'; ok`
(doc) switch g2 <-> g3 2012-04-16 07:07:45 +02:00			`git checkout master; ok`
(mkdoc) make it do a little more post-mkdoc work 2012-03-26 01:54:21 +02:00			`rmdir html; ok`
			`" or die 2;`

			`sub main {`
document overhaul - explicit 'list' gives way to mindmap, ... - 'fm2mt.pl' to produce master-toc.mkd from the mindmap - mkdoc no longer ignores master-toc.mkd, calls fm2mt.pl itself and LOTS of changes to the actual docs 2012-04-05 18:01:23 +02:00			chomp(@ARGV = `find . -name "*.mkd" \| cut -c3-`) if not @ARGV;
			`@ARGV = grep { /./ } @ARGV;`
(mkdoc) make it do a little more post-mkdoc work 2012-03-26 01:54:21 +02:00			`my @save = @ARGV;`
(minor) add titles to rendered HTML docs 2012-04-26 13:03:26 +02:00			`my $css_block = join("", <DATA>);`
(mkdoc) make it do a little more post-mkdoc work 2012-03-26 01:54:21 +02:00
(mkdoc) allow internal [[TOC]] again 2012-04-08 03:55:24 +02:00			`my %ct; # chapter tocs`
(minor) add titles to rendered HTML docs 2012-04-26 13:03:26 +02:00			`my %title;`
(mkdoc) make it do a little more post-mkdoc work 2012-03-26 01:54:21 +02:00			`my $mf = '';`
			`my $fh;`

			`while (<>) {`
			`$ARGV =~ /^(?:.*\/)?([^\/]+)\.mkd$/;`
			`my $b = $1;`

			`if (/^(#+) (?:#(\S+) )?(.*)/) {`
(minor) add titles to rendered HTML docs 2012-04-26 13:03:26 +02:00			`$title{$b} \|\|= $3;`
(mkdoc) make it do a little more post-mkdoc work 2012-03-26 01:54:21 +02:00			`if ( length($1) == 1 ) {`
(mkdoc) allow internal [[TOC]] again 2012-04-08 03:55:24 +02:00			`$ct{$b} .= "\n";`
			`$ct{$b} .= " * [$3][$b]\n";`
(mkdoc) make it do a little more post-mkdoc work 2012-03-26 01:54:21 +02:00			`$mf .= "[$b]: $b.html\n";`
			`} else {`
(mkdoc) allow internal [[TOC]] again 2012-04-08 03:55:24 +02:00			`$ct{$b} .= " " x ( 4 * ( length($1) - 1 ) );`
			`$ct{$b} .= " * ";`
			`$ct{$b} .= (`
(mkdoc) make it do a little more post-mkdoc work 2012-03-26 01:54:21 +02:00			`$2`
			`? "[$3][$2]"`
			`: "$3"`
			`);`
(mkdoc) allow internal [[TOC]] again 2012-04-08 03:55:24 +02:00			`$ct{$b} .= "\n";`
(mkdoc) make it do a little more post-mkdoc work 2012-03-26 01:54:21 +02:00			`$mf .= "[$2]: $b.html" . ($2 ne $b ? "#$2" : "") . "\n" if $2;`
			`}`
Q: all doc stuff 2012-03-16 02:54:47 +01:00			`}`
			`}`

document overhaul - explicit 'list' gives way to mindmap, ... - 'fm2mt.pl' to produce master-toc.mkd from the mindmap - mkdoc no longer ignores master-toc.mkd, calls fm2mt.pl itself and LOTS of changes to the actual docs 2012-04-05 18:01:23 +02:00			`# open($fh, ">", "master-toc.mk2")`
			`# and print $fh $mt`
			`# and close $fh;`
Q: all doc stuff 2012-03-16 02:54:47 +01:00
(mkdoc) make it do a little more post-mkdoc work 2012-03-26 01:54:21 +02:00			`# after this, do this for every mkd (including the master-toc.mkd)`
Q: all doc stuff 2012-03-16 02:54:47 +01:00
(mkdoc) make it do a little more post-mkdoc work 2012-03-26 01:54:21 +02:00			`# cat $css_block > $base.html`
			`# cat $base.mkd $mf \| $MKD >> $base.html`
Q: all doc stuff 2012-03-16 02:54:47 +01:00
document overhaul - explicit 'list' gives way to mindmap, ... - 'fm2mt.pl' to produce master-toc.mkd from the mindmap - mkdoc no longer ignores master-toc.mkd, calls fm2mt.pl itself and LOTS of changes to the actual docs 2012-04-05 18:01:23 +02:00			`for my $mkd (@save) {`
(mkdoc) make it do a little more post-mkdoc work 2012-03-26 01:54:21 +02:00			`$mkd =~ /^(?:.*\/)?([^\/]+)\.mkd$/;`
			`my $b = $1;`
Q: all doc stuff 2012-03-16 02:54:47 +01:00
(minor) add titles to rendered HTML docs 2012-04-26 13:03:26 +02:00			`my $css = $css_block;`
			`$css =~ s/%TITLE/$title{$b} \|\| $b/e;`

(mkdoc) make it do a little more post-mkdoc work 2012-03-26 01:54:21 +02:00			`open($fh, ">", "../html/$b.html")`
			`and print $fh $css`
			`and close $fh;`
Q: all doc stuff 2012-03-16 02:54:47 +01:00
(mkdoc) make it do a little more post-mkdoc work 2012-03-26 01:54:21 +02:00			my $mkt = `cat $mkd`;
			`$mkt =~ s/^(#+) #(\S+) /$1 <a name="$2"><\/a> /mg;`
(mkdoc) allow internal [[TOC]] again 2012-04-08 03:55:24 +02:00			`$mkt =~ s/^\[\[TOC\]\]/$ct{$b}/mg;`
(mkdoc) make it do a little more post-mkdoc work 2012-03-26 01:54:21 +02:00			`open($fh, "\|-", "$MKD >> ../html/$b.html")`
document overhaul - explicit 'list' gives way to mindmap, ... - 'fm2mt.pl' to produce master-toc.mkd from the mindmap - mkdoc no longer ignores master-toc.mkd, calls fm2mt.pl itself and LOTS of changes to the actual docs 2012-04-05 18:01:23 +02:00			`and print $fh $mkt, "\n\n", $mf`
(mkdoc) make it do a little more post-mkdoc work 2012-03-26 01:54:21 +02:00			`and close $fh;`
			`}`
Q: all doc stuff 2012-03-16 02:54:47 +01:00			`}`

			`__DATA__`

(minor) add titles to rendered HTML docs 2012-04-26 13:03:26 +02:00			`<head>`
			`<title>%TITLE</title>`
			`<style>`
CSS text-color specified... ...so it is readable for people who use black bg browsers 2012-04-05 15:12:40 +02:00			`body { background: #fff; text-color: #000; margin-left: 40px; font-size: 0.9em; font-family: sans-serif; max-width: 800px; }`
			`h1 { background: #ffb; text-color: #000; margin-left: -30px; border-top: 5px solid #ccc; }`
			`h2 { background: #ffb; text-color: #000; margin-left: -20px; border-top: 3px solid #ddd; }`
			`h3 { background: #ffb; text-color: #000; margin-left: -10px; }`
			`h4 { background: #ffb; text-color: #000; }`
			`code { font-size: 1.1em; background: #ddf; text-color: #000; }`
			`pre { margin-left: 2em; background: #ddf; text-color: #000; }`
			`pre code { font-size: 1.1em; background: #ddf; text-color: #000; }`
(minor) add titles to rendered HTML docs 2012-04-26 13:03:26 +02:00			`</style>`
			`</head>`
Q: all doc stuff 2012-03-16 02:54:47 +01:00
			`<p style="text-align:center">`
			`<a href="master-toc.html">master TOC</a>`
			`\|`
			`<a href="index.html">main page</a>`
			`\|`
			`<a href="index.html#license">license</a>`
			`</p>`
(some docfixes) 2012-04-19 03:03:36 +02:00			`<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>`