README.md
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 |
# HastyScribe _HastyScribe_ is a simple command-line program able to convert [markdown](http://daringfireball.net/projects/markdown) files into HTML files. ## Usage **hastyscribe** _filename.md_ [ **\--notoc** ] ## FAQs ### Why is _HastyScribe_ different from other markdown converters? Because: * It is a cross-platform, self-contained executable file * It comes with its own stylesheet, which is automatically embedded into every HTML document * It is built on top of [Discount](http://www.pell.portland.or.us/~orc/Code/discount/), which means that besides standard markdown you also get: * strikethrough * automatic Table of Contents generation * [SmartyPants](http://daringfireball.net/projects/smartypants/) substitutions * paragraph centering * image sizes * definition lists * alphabetic lists * pseudo-protocols to generate `span` tags with arbitrary CSS classes, `abbr` tags, and anchors * class blocks * tables * fenced code blocks * [Pandoc](http://johnmacfarlane.net/pandoc/)-style docuemnt headers ### What can I use it for? _HastyScribe_ is best suited to produce standalone, mainly-textual documents such as meeting notes, project status documents, and articles. ### What language is _HastyScribe_ implemented in? HastyScribe is implemented in [Nimrod][nimrod], a very expressive language that compiles to C and is able to generate small, standalone and self-contained executable files. ### How do I build _HastyScribe_ from source? First of all you need a **libmarkdown.a** static library. You can either grab one precompiled (for Windows x64 or OSX x64) from the [vendor](https://github.com/h3rald/hastyscribe/blob/master/vendor) or build your own. If you choose to build your own: 1. Download/clone [Discount](https://github.com/Orc/discount) source code 2. In the directory containing Discount source code, run the following commands: ``` ./configure.sh --with-tabstops=2 --with-dl=both --with-id-anchor --with-github-tags --with-fenced-code --enable-all-features make ``` Note: If you are on Windows, you can compile it using [MinGW](http://www.mingw.org/). Once you have a **libmarkdown.a** static library for your platform: 1. Download and install [Nimrod][nimrod]. On OSX you can also <tt>brew install nimrod</tt> if you have [HomeBrew](http://brew.sh/) installed. 2. Download/clone HastyScribe. 3. Put your **libmarkdown.a** file in the **vendor** directory. 4. Run **osxbuild** (if you are on OSX) or **winbuild.bat** (if you are on windows) or the following: ``` nimrod --clibdir:vendor --clib:markdown c hastyscribe.nim ``` [nimrod]: http://nimrod-code.org/ |