Skip to content

Commit 3c27470

Browse files
committed
Fixed small bug in image generation
1 parent ccfae8c commit 3c27470

File tree

4 files changed

+9
-52
lines changed

4 files changed

+9
-52
lines changed

README.md

+6-51
Original file line numberDiff line numberDiff line change
@@ -2,26 +2,14 @@
22
<center>
33
<img src="https://github.com/imatix/gitdown/raw/master/images/README_1.png" alt="1">
44
</center>
5-
/----------------------------------------------------------\+\
6-
|/---------------------------------------------------------/||
7-
|| /--+ +------+ +------\ /----\/+ +\ +\ +\ /------\ ||
8-
|| \-\| \--\/--/ |+----\| |/---/|| || || || |/----\| ||
9-
|| || || || || || || || || || || || ||
10-
|| +---\ || || || || || || || || || || || ||
11-
|| \--\| || || \/ || || || || || || || || ||
12-
|| || || || /-----/| |\----/| |\--/\--/| || || ||
13-
|| || \/ \/ +------/ \------/ \--------/ +/ \+ ||
14-
|\-----/|+--------------------------------------------------/|
15-
\-------/+---------------------------------------------------/
16-
[/diagram]
175

186
<A name="toc1-17" title="Welcome To Gitdown" />
197
Welcome To Gitdown
208
==================
219

2210
Gitdown is a simple tool for writing documentation hosted on a github repository. It uses [ditaa][] to convert ascii diagrams into images, and produces [markdown][] documents that can be uploaded to your repository along with code. I made Gitdown so that we could write technical white papers and user guides as plain text (including diagrams) and publish them with a single "git push" command. Gitdown is a simpler version of the tool we use to maintain the [ØMQ][zeromq] [Guide][zguide].
2311

24-
Gitdown is written and maintained by Pieter Hintjens. Please use the issue [tracker][] for all comments and errata. This document was published on Thursday March, 2011 at 20:11:14, and generated by the magic of Gitdown from README.txt.
12+
Gitdown is written and maintained by Pieter Hintjens. Please use the issue [tracker][] for all comments and errata. This document was published on Thursday March, 2011 at 22:41:04, and generated by the magic of Gitdown from README.txt.
2513

2614
This is version 2011.03.24 of Gitdown. Changelog:
2715

@@ -33,6 +21,11 @@ This is version 2011.03.24 of Gitdown. Changelog:
3321
Contents
3422
--------
3523

24+
&emsp;<a href="#toc2-37">License</a>
25+
&emsp;<a href="#toc2-46">Installation and Use</a>
26+
&emsp;<a href="#toc2-71">How it Works</a>
27+
&emsp;<a href="#toc2-126">Gitdown Syntax Summary</a>
28+
&emsp;<a href="#toc2-186">Markdown Syntax Summary</a>
3629

3730
<A name="toc2-37" title="License" />
3831
License
@@ -79,44 +72,6 @@ The Gitdown workflow is:
7972
<center>
8073
<img src="https://github.com/imatix/gitdown/raw/master/images/README_2.png" alt="2">
8174
</center>
82-
+-------------------+
83-
| me.txt |
84-
+-------------------+
85-
| Text file in +---> Saved in git as source
86-
| Gitdown format |
87-
+---------+---------+
88-
|
89-
|
90-
+----------------------------+
91-
| |
92-
v v
93-
+---------+---------+ +---------+---------+
94-
| me.md | | images.html |
95-
+-------------------+ +-------------------+
96-
| Markdown output | | Temporary HTML |
97-
| cFDA| | to feed Ditaa |
98-
+---------+---------+ +---------+---------+
99-
| |
100-
| |
101-
| v
102-
| +---------+---------+
103-
: | |
104-
References | Ditaa |
105-
| | {o}|
106-
| +---------+---------+
107-
| |
108-
| |
109-
| v
110-
| +---------+---------+
111-
| | images/me_nnn.png |
112-
+----------------->+-------------------+
113-
| Image files |
114-
| cFDA|
115-
+-------------------+
116-
117-
118-
Figure # - Gitdown workflow
119-
[/diagram]
12075

12176
1. You edit a text file that contains text and diagrams in a single document.
12277
2. You process this document with Gitdown to give a Markdown document plus a number of images in an images subdirectory.

bin/gitdown

+3-1
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,9 @@ $symbols {"BRANCH"} = "master";
6666

6767
$imgpath = "";
6868

69-
foreach (@input) {
69+
$line = 0;
70+
while ($line < @input) {
71+
$_ = $input [$line++];
7072
if (/^\./) {
7173
# Process directive
7274
if (/^\.set\s+(\w+)=(.*)\s*/) {

images/README_1.png

0 Bytes
Loading

images/README_2.png

0 Bytes
Loading

0 commit comments

Comments
 (0)