Skip to content

Commit

Permalink
a very simple bit of tutorial
Browse files Browse the repository at this point in the history
  • Loading branch information
efficacy committed Sep 8, 2011
1 parent 4995db5 commit d23d8ce
Show file tree
Hide file tree
Showing 6 changed files with 69 additions and 2 deletions.
2 changes: 2 additions & 0 deletions TODO.txt
@@ -0,0 +1,2 @@

+ add support for non-html matrkup (e.g wiki, markdown, etc.)
Binary file modified dist/sitegrinder.jar
Binary file not shown.
28 changes: 27 additions & 1 deletion src/main/docs/input/index.tract
@@ -1,3 +1,29 @@
page.title=Home

Welcome to Stringtree Site Grinder!
<p>
Stringtree Site Grinder is a tool for managing web sites.
It aims to eliminate repetitive typing and copy/paste to let you focus on useful and attractive content.
</p>

<h2>Instant Tutorial</h2>

<h3>Create a very simple "hello, world" site</h3>
<ol>
<li>Create a new directory for this tutorial</li>
<li>Create two directories in your tutorial folder named <tt>input</tt> and <tt>output</tt></li>
<li>Create a file in your <tt>input</tt> directory named <tt>index.tpl</tt></li>
<li>Add some HTML text to the new file, such as: <pre>
&lt;html&gt;&lt;head&gt;&lt;title&gt;Index&lt;/title&gt;&lt;/head&gt;&lt;body&gt;
Hello from Stringtree Site Grinder
&lt;/body&gt;&lt;/html&gt;
</pre></li>
</ol>

<h3>"Grind" it using the command-line tool</h3>
<ol>
<li>Open a command prompt in the tutorial directory you created above</li>
<li>Copy the sitegrinder.jar file into your directory</li>
<li>Enter <tt>java -jar sitegrinder.jar input output</tt><li>
<li>A new file <tt>index.html</tt> will appear in the <tt>output</tt> directory</li>
<li>Open the file in a web browser to see your new web page :)</li>
</ol>
29 changes: 28 additions & 1 deletion src/main/docs/output/index.html
Expand Up @@ -2,5 +2,32 @@
<body><div id="navbar">
<b>Home</b> <a href="contact.html">Contact Us</a>
</div>
Welcome to Stringtree Site Grinder!</body>
<p>
Stringtree Site Grinder is a tool for managing web sites.
It aims to eliminate repetitive typing and copy/paste to let you focus on useful and attractive content.
</p>

<h2>Instant Tutorial</h2>

<h3>Create a very simple "hello, world" site</h3>
<ol>
<li>Create a new directory for this tutorial</li>
<li>Create two directories in your tutorial folder named <tt>input</tt> and <tt>output</tt></li>
<li>Create a file in your <tt>input</tt> directory named <tt>index.tpl</tt></li>
<li>Add some HTML text to the new file, such as: <pre>
&lt;html&gt;&lt;head&gt;&lt;title&gt;Index&lt;/title&gt;&lt;/head&gt;&lt;body&gt;
Hello from Stringtree Site Grinder
&lt;/body&gt;&lt;/html&gt;
</pre></li>
</ol>

<h3>"Grind" it using the command-line tool</h3>
<ol>
<li>Open a command prompt in the tutorial directory you created above</li>
<li>Copy the sitegrinder.jar file into your directory</li>
<li>Enter <tt>java -jar sitegrinder.jar input output</tt><li>
<li>A new file <tt>index.html</tt> will appear in the <tt>output</tt> directory</li>
<li>Open the file in a web browser to see your new web page :)</li>
</ol>
</body>
</html>
6 changes: 6 additions & 0 deletions tmp/contact.html
@@ -0,0 +1,6 @@
<html><head><title>Stringtree Site Grinder: Contact Us</title></head>
<body><div id="navbar">
<a href="index.html">Home</a> <b>Contact Us</b>
</div>
How to contact us</body>
</html>
6 changes: 6 additions & 0 deletions tmp/index.html
@@ -0,0 +1,6 @@
<html><head><title>Stringtree Site Grinder: Home</title></head>
<body><div id="navbar">
<b>Home</b> <a href="contact.html">Contact Us</a>
</div>
Welcome to Stringtree Site Grinder!</body>
</html>

0 comments on commit d23d8ce

Please sign in to comment.