Permalink
Browse files

updated docs

  • Loading branch information...
1 parent 217f717 commit 9ef4509d5b6ed80f9a2bc61f82ac4c9453573ffd @zuckschwerdt committed Mar 13, 2009
Showing with 92 additions and 42 deletions.
  1. +0 −42 README
  2. +48 −0 README.md
  3. +44 −0 asciidoc-test.txt
View
42 README
@@ -1,42 +0,0 @@
-AsciiDoc TextMate bundle
-========================
-
-This is a TextMate bundle for AsciiDoc, see http://www.methods.co.nz/asciidoc/
-
-It's got some basic commands and snippets working. The language grammar is a mess and not really doing anything useful right now.
-
-Commands and Snippets
----------------------
-
-Commands:
-
- - Preview
- - Convert Document
- - Typeset as PDF
- - Show Documentation
-
-Snippets:
-
- - Bold
- - Italic
- - Quoted
- - Superscript
- - Subscript
-
-Installation
-------------
-
-To install via Git:
-
- cd ~/"Library/Application Support/TextMate/Bundles/"
- git clone git://github.com/zuckschwerdt/asciidoc.tmbundle.git "AsciiDoc.tmbundle"
- osascript -e 'tell app "TextMate" to reload bundles'
-
-Source can be viewed or forked via GitHub: http://github.com/zuckschwerdt/asciidoc.tmbundle/tree/master
-
-Author
-------
-
-Christian Zuckschwerdt
-
-Enjoy.
View
@@ -0,0 +1,48 @@
+AsciiDoc TextMate bundle
+========================
+
+This is a TextMate bundle for AsciiDoc, see [the website](http://www.methods.co.nz/asciidoc/)
+
+It's got some basic commands and snippets working. Accessible by shortcuts and tab expansion.
+The language grammar features the very basics only. I.e. some structure and markup higlighting.
+Output is available as *preview* (TextMate window), rendered *HTML* and *PDF* (pdflatex required).
+
+Commands and Snippets
+---------------------
+
+Commands:
+
+ - Preview
+ - Convert Document
+ - Typeset as PDF
+ - Show Documentation
+
+Snippets:
+
+ - Bold
+ - Italic
+ - Quoted
+ - Superscript
+ - Subscript
+ - Headings (try `Ctrl-Cmd-T h1`)
+ - Tab expansion for blocks (try `== TAB`)
+
+Installation
+------------
+
+To install via Git:
+
+ cd ~/"Library/Application Support/TextMate/Bundles/"
+ git clone git://github.com/zuckschwerdt/asciidoc.tmbundle.git "AsciiDoc.tmbundle"
+ osascript -e 'tell app "TextMate" to reload bundles'
+
+Also be sure to have asciidoc itself and maybe LaTeX around.
+
+Source can be viewed or forked via [GitHub](http://github.com/zuckschwerdt/asciidoc.tmbundle/tree/master).
+
+Author
+------
+
+Christian Zuckschwerdt
+
+Enjoy.
View
@@ -1,6 +1,50 @@
AsciiDoc TextMate Bundle -- Test Document
=========================================
+Optional Author Name <optional@author.email>
+Optional version, optional date
+:Author: AlternativeWayToSetOptional Author Name
+:Email: <AlternativeWayToSetOptional@author.email>
+:Date: AlternativeWayToSetOptional date
+:Revision: AlternativeWayToSetOptional version
+
+.Attributes
+There a lot of predefined attributes in AsciiDoc, Author is {author} Version is {revision} plus you can add your own {attributename}.
+
+[[id]]
+Block with id
+
+(C) copyright, (TM) trademark, (R) registered trademark,
+-- em dash, ... ellipsis, -> right arrow, <- left arrow, => right
+double arrow, <= left double arrow.
+
+forced +
+line break
+
+page break
+<<<
+
+ruler
+'''''
+
+normal, _italic_, *bold*, +mono+, #unquoted#.
+Unconstrained**bold**Unconstrained
+Unconstrained__italic__Unconstrained
+Unconstrained++mono++Unconstrained
+Unconstrained##Unquoted##Unconstrained
+
+``quoted'', ^super^, ~sub~.
+
+Command: `ls -al`
+
+Path: '/some/filez.txt', '.b'
+
+Escaped: \{qwe} and +++{qwe}+++
+and also \_italic_, +++_italic_+++, $$<b>normal</b>$$
+
+Red [red]+++`sum_(i=1)\^n i=(n(n+1))/2`$+++ AsciiMathML formula
+
+
//////////////////////////
CommentBlock
//////////////////////////

0 comments on commit 9ef4509

Please sign in to comment.