Permalink
Browse files

Added Markdown notes.

  • Loading branch information...
1 parent b57760f commit ad8e271f1ceccfba9f988011f51756fcff93e114 @Aupajo committed Dec 30, 2010
Showing with 34 additions and 35 deletions.
  1. +34 −35 README.markdown
View
@@ -1,60 +1,59 @@
-h1. Human Textile Reference
+# Human Markdown Reference
-The Human Textile Reference is a set of short, easy to understand HTML pages you can include in any project that uses Textile.
+The Human Markdown Reference is a set of short, easy to understand HTML pages you can include in any project that uses Markdown.
-*Important:* This is not designed to be a complete reference. Just a quick guide for the layman.
-
-You can view a demo on the "labs page":http://labs.metanation.com/human-textile-reference/.
+**Important:** This is not designed to be a complete reference. Just a quick guide for the layman.
It's perfect for including as a pop-up help window next to your textarea.
-h2. Notes
+## Reference Sections
+
+The reference sections include:
+
+* Text formatting
+* Links and images
+* Headings
+* Lists
+* Special
-h3. Size
+## Notes
-It's extremely lightweight; one HTML file, one minified CSS file, two images. If your web server has GZip compression switched on it should total 2.2KB.
+### Size
-h3. JavaScript
+It's extremely lightweight; one HTML file, one minified CSS file, two images. If your web server has GZip compression switched on it should total 2.3KB.
+
+### JavaScript
The guide uses JavaScript to toggle the different categories. If the browser's JavaScript is disabled, every category will be shown expanded, which is fine.
It uses jQuery 1.4.4 from the Google's AJAX CDN (the request should be a cache hit, so you'll incur no extra wait time).
-h3. Sass
+### Sass
-Included stylesheet is compiled using "Sass":http://sass-lang.com/. If you want to make modifications, alter @sass/textile-reference.css@. You can output the compressed version with:
+Included stylesheet is compiled using [Sass](http://sass-lang.com/). If you want to make modifications, alter `sass/markdown-reference.css`. You can output the compressed version with:
-<pre>
-<code>
-sass sass/textile-reference.scss textile-reference/stylesheets/textile-reference.css -t compressed
-</code>
-</pre>
+ sass sass/markdown-reference.scss markdown-reference/stylesheets/markdown-reference.css -t compressed
-If you're developing, you can use Sass' @--watch@ option.
+If you're developing, you can use Sass' `--watch` option.
-h2. How To Use
+## How To Use
-Clone the repository or "download":http://github.com/Aupajo/human-textile-reference/downloads.
+Clone the repository or [download](http://github.com/Aupajo/human-markdown-reference/downloads).
-Copy the @textile-reference/@ directory to your project.
+Copy the `markdown-reference/` directory to your project.
Add a help link to the reference:
-h3. HTML Snippet
+### HTML Snippet
+
+
+ You can format your text using
+ <a href="markdown-reference/index.html"
+ onclick="window.open(this.href,'markdown_reference','height=400,width=600,scrollbars=1'); return false;">Markdown</a>.
+ </code>
-<pre>
-<code>
-You can format your text using
-<a href="textile-reference/index.html"
- onclick="window.open(this.href,'textile_reference','height=400,width=600,scrollbars=1'); return false;">Textile</a>.
-</code>
-</pre>
-h3. Rails Snippet
+### Rails Snippet
-<pre>
-<code>
- You can format your text using
- <%= link_to 'Textile', 'textile-reference/index.html', :popup => ['textile_reference', 'height=400,width=600,scrollbars=1'] %>
-</code>
-</pre>
+ You can format your text using
+ <%= link_to 'Markdown', 'markdown-reference/index.html', :popup => ['markdown_reference', 'height=400,width=600,scrollbars=1'] %>

0 comments on commit ad8e271

Please sign in to comment.