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 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 |
[](https://nimble.directory/pkg/hastyscribe)   # HastyScribe _HastyScribe_ is a simple command-line program able to convert [markdown](http://daringfireball.net/projects/markdown) files into HTML files. ## Usage **hastyscribe** _filename-or-glob-expression_ **[** _\<options\>_ **]** Where: - _filename-or-glob-expression_ is a valid file or [glob](<http://en.wikipedia.org/wiki/Glob_(programming)>) expression that will be compiled into HTML. - The following options are supported: - **\-\-field/<field>=<value>** causes HastyScribe to set a custom field to a specific value. - **\-\-notoc** causes HastyScribe to output HTML documents _without_ automatically generating a Table of Contents at the start. - **\-\-user-css=<file>** causes HastyScribe to insert the contents of the specified local file as a CSS stylesheet. - **\-\-user-js=<file>** causes HastyScribe to insert the contents of the specified local file as a Javascript script. - **\-\-output-file=<file>** causes HastyScribe to write output to a local file (Use [\-\-output-file=-](class:opt) to output to standard output). - **\-\-watermark=<file>** causes HastyScribe to embed and display an image as a watermark throughout the document. - **\-\-fragment** causes HastyScribe to output just an HTML fragment instead of a full document, without embedding any image, font or stylesheet. - **\-\-dump=all|styles|fonts** causes HastyScribe to dump all resources/stylesheets/fonts to the current directory. - **\-\-help** causes HastyScribe to display the usage information and quit. ## FAQs ### Why is _HastyScribe_ different from other markdown converters? Because: - It is a cross-platform, self-contained executable file. - It can generate standalone HTML files. - It comes with its own stylesheet, which is automatically embedded into every HTML document, along with all the needed web fonts. - It is built on top of [Discount][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 document headers - It automatically embeds any referenced image as data URI. - It has supports for text snippets, custom fields, and substitution macros. ### What can I use it for? _HastyScribe_ is best suited to produce self-contained documents such as essays, meeting notes, project status documents, and articles. ### What language is _HastyScribe_ implemented in? HastyScribe is implemented in [Nim][nim], 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? 1. Download and install [Nim][nim]. 2. Download and build [Nifty][nifty], and put it somewhere in your $PATH. 3. Clone the HastyScribe [repository](https://github.com/h3rald/hastyscribe). 4. Navigate to the HastyScribe repository local folder. 5. Run **nifty install** to download HastyScribe's dependencies. - Note: Some users may need to install libmarkdown2-dev 6. Run **nifty build discount** to build the Discount markdown library. 7. Run **nim c -d:release hastyscribe.nim**. ### Quick Installation ```sh nimble install nifty && sudo apt install libmarkdown2-dev && nimble install hastyscribe ``` If you are using another operating system without apt you can install libmarkdown2 [here](https://launchpad.net/debian/+source/discount) [nim]: http://nim-lang.org/ [nifty]: https://github.com/h3rald/nifty [discount]: http://www.pell.portland.or.us/~orc/Code/discount/ |