You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: doc/HastyScribe_UserGuide.md
+29-29
Original file line number
Diff line number
Diff line change
@@ -4,21 +4,21 @@
4
4
5
5
## Overview
6
6
7
-
[](class:hastyscribe) is a self-contained command-line {{mdlink -> [Markdown][df]}} compiler that can create single-file HTML documents. All documents created by {{hs -> HastyScribe}} use well-formed HTML and embed all stylesheets, fonts, and images that are necessary to display them in any (modern) browser.
7
+
[](class:hastyscribe) is a self-contained {{mdlink -> [Markdown][df]}} compiler that can create single-file HTML documents. All documents created by {{hs -> HastyScribe}} use well-formed HTML and embed all stylesheets, fonts, and images that are necessary to display them in any (modern) browser (don't even try to display them in IE8 or lower).
8
8
9
9
In other words, all documents created by HastyScribe are constituted by only one [.HTML](class:ext) file, for easy distribution.
10
10
11
11
### Rationale
12
12
13
-
There are plenty of programs and services that can convert {{mdlink}} into HTML but they are typically either too simple --they convert {{md -> markdown}} code into an HTML fragment-- or too complex --they produce a well-formed document, but they require too much configuration, install additional software dependencies.
13
+
There are plenty of programs and services that can convert {{mdlink}} into HTML but they are typically either too simple --they convert {{md -> markdown}} code into an HTML fragment-- or too complex --they produce a well-formed document, but they require too much configuration, or the installation of additional software dependencies.
14
14
15
15
Sometimes you just want to write your document in markdown, and get a full HTML file out, ready to be distributed, ideally with no dependencies (external stylesheets or images) --that's where {{hs}} comes in.
16
16
17
17
{{hs}}:
18
18
19
19
* lets you focus on content and keeps things simple, while giving you all the power of {{disclink -> [Discount][discount]}}-enriched {{md}} (plus some more goodies).
20
-
* takes care of styling your documents properly, making sure they look good on your desktop and even on small screens, so that they are ready to be distributed.
21
-
* is a single, small executable file, with no dependencies.
20
+
* takes care of styling your documents properly, making sure they look good on your desktop and even on small screens, ready to be distributed.
21
+
* is a single, small executable file, with no dependencies. To be fair, it's about 1MB in size when compiled for OSX -- but that's only because the {{hs}} executable embeds all the fonts and stylesheets it needs to produce documents.
22
22
23
23
### Key Features
24
24
@@ -33,26 +33,26 @@ Sometimes you just want to write your document in markdown, and get a full HTML
33
33
34
34
#### Discount Extensions
35
35
36
-
Standard markdown is great, but sometimes you wish it had a few more features, like tables or fenced codeblocks perhaps. The good news is that under the hood {{hs}} uses {{disclink}}, a markdown compiler library written in C that extends markdown with a few useful extensions, which allow you to:
36
+
Standard markdown is great, but sometimes you wish it had a few more features, like tables or fenced code blocks perhaps. The good news is that under the hood {{hs}} uses {{disclink}}, a markdown compiler library written in C that extends markdown with a few useful extensions, which allow you to, for example:
37
37
38
-
* format blocks of texts to create [notes](#Notes) and [sidebar](#Sidebars)
38
+
* format blocks of texts to create [notes](#Notes) and [sidebars](#Sidebars)
39
39
* style text using CSS classes
40
40
* create definition lists and alphabetical lists
41
41
42
42
#### Text Snippets
43
43
44
-
Although not part of neither {{md}} nor Discount, {{hs}} allows you to create text [snippets](#Snippets) to reuse content. Useful when you have to use a sentence or a formatted block of text over and over in a document, or shorten long words (like the word {{hs}} in this document [](class:fa-smile-o)).
44
+
Although not part of neither {{md}} nor Discount, {{hs}} allows you to create text [snippets](#Snippets) to reuse content. Useful when you have to use a sentence or a formatted block of text over and over in a document, or shorten long words (like the word _{{hs}}_ in this document [](class:fa-smile-o)).
45
45
46
46
#### Image (and font) Embedding
47
47
48
48
{{hs}} only produces single HTML files. With _no dependencies_:
49
49
50
-
* By default, the HastyScribe, FontAwesome, Source Sans Pro, and Source Code Pro font are automatically embedded.
50
+
* By default, the HastyScribe, FontAwesome, Source Sans Pro, and Source Code Pro fonts are automatically embedded.
51
51
* All referenced local images are automatically embedded using the {{datauri -> [data URI scheme](http://en.wikipedia.org/wiki/Data_URI_scheme)}}.
52
52
53
53
#### FontAwesome Icons
54
54
55
-
[FontAwesome][fs] icons can be used in [badges](#Badges) or simply to customize text. [](class:fa-thumbs-up)
55
+
[FontAwesome][fa] icons can be used in [badges](#Badges) or simply to customize text. [](class:fa-thumbs-up)
56
56
57
57
#### Notes, tips, warnings, sidebars and badges
58
58
@@ -73,40 +73,40 @@ All HTML documents created by {{hs}} are responsive and can be viewed perfectly
73
73
74
74
The easiest way to get {{hs}} is by downloading one of the prebuilt binaries from the [Github Release Page][release]:
75
75
76
-
*[HastyScribe for Mac OSX (x64)]({{release}}/hastyscribe.osx-x64) -- Compiled on OSX Mavericks
77
-
*[HastyScribe for Windows (x64)]({{release}}/hastyscribe.win-x64) -- Compiled on Windows 7
76
+
*[HastyScribe for Mac OSX (x64)]({{release}}/hastyscribe_v1.0_osx_x64.zip) -- Compiled on OSX Mavericks
77
+
*[HastyScribe for Windows (x64)]({{release}}/hastyscribe_v1.0_win_x64.zip) -- Compiled on Windows 7
78
78
79
79
### Building from Source
80
80
81
81
You can also build HastyScribe from source, if there is no pre-built binary for your platform.
82
82
83
-
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]({{repo -> https://github.com/h3rald/hastyscribe}}/blob/master/vendor) folder of the {{hs}} repository or build your own.
83
+
First of all you need a [libmarkdown.a](class:file) static library. You can either grab one precompiled (for Windows x64 or OSX x64) from the [vendor]({{repo -> https://github.com/h3rald/hastyscribe}}/blob/master/vendor) folder of the {{hs}} repository or build your own.
> If you are on Windows, you can compile it using [MinGW](http://www.mingw.org/).
98
+
> If you are on Windows, you can compile Discount using [MinGW](http://www.mingw.org/).
99
99
100
-
Once you have a **libmarkdown.a** static library for your platform:
100
+
Once you have a [libmarkdown.a](class:file) static library for your platform:
101
101
102
102
1. Download and install [Nimrod][nimrod].
103
-
2.Download/clone the HastyScribe [repository]({{repo}}).
104
-
3. Put your **libmarkdown.a** file in the **vendor** directory.
105
-
4. Run **nixbuild** (if you are on OSX, Linux or other UNIX-like operating systems) or **winbuild.bat** (if you are on Windows)
103
+
2.Clone the HastyScribe [repository](https://github.com/h3rald/hastyscribe).
104
+
3. Put your [libbmarkdown.a](class:file) file in the [vendor](class:dir) directory.
105
+
4. Run [nixbuild](clasS:cmd) (if you are on OSX, Linux or other UNIX-like operating systems) or [winbuild.bat](class:cmd) (if you are on Windows)
106
106
107
107
## Usage
108
108
109
-
{{hs}} is a command-line application that can compile one or more [.md](class:ext) or [.markdown](class:ext) files into one or more HTML file with the same name(s).
109
+
{{hs}} is a command-line application that can compile one or more [.md](class:ext) or [.markdown](class:ext) files into one or more HTML files with the same name(s).
110
110
111
111
### Command Line Syntax
112
112
@@ -150,7 +150,7 @@ Executing {{hs}} to compile all [.md](class:ext) files within the current direct
150
150
151
151
### Document Headers
152
152
153
-
{{hs}} supports [Pandoc][pandoc]-style Document Headers, as implemented by the [Discount][discount] library. Basically, you can specify the title of the document, author and date as the first three lines of the document, prepending each with a [%](class:kwd), like this
153
+
{{hs}} supports [Pandoc][pandoc]-style Document Headers, as implemented by the [Discount][discount] library. Basically, you can specify the title of the document, author and date as the first three lines of the document, prepending each with a [%](class:kwd), like this
154
154
155
155
~~~
156
156
% HastyScribe User Guide
@@ -175,7 +175,7 @@ The following definition creates a snippet called [test](class:kwd) which is tra
175
175
176
176
[\{\{test -> This is a test snippet.\}\}](class:tt)
177
177
178
-
Once a snippet is defined _anywhere_ in the document, you can use its identifier wrapped in double curly brackets (\{\{test}\}\) anywhere in the document to reuse the specified text.
178
+
Once a snippet is defined _anywhere_ in the document, you can use its identifier wrapped in double curly brackets (\{\{test}\}\} in the previous example) anywhere in the document to reuse the specified text.
179
179
180
180
> %note%
181
181
> Remarks
@@ -202,8 +202,8 @@ The following table lists all the most common ways to format inline text:
202
202
> `Set the variable <var>test</var> to 1.` | Set the variable <var>test</var> to 1.
203
203
> `<q>This is a short quotation</q>` | <q>This is a short quotation</q>
204
204
> `<cite>Hamlet</cite>, by William Shakespeare.` | <cite>Hamlet</cite>, by William Shakespeare.
205
-
> `A [.md](class:ext)` file | A [.md](class:ext) file
*`1/4th`→¼th. Same goes for for 1/4 (¼), 1/2 (½), 3/4ths (¾ths), and 3/4 (¾).
228
+
*`1/4th`→1/4th. Same goes for 1/2 and 3/4.
229
229
*`...` or `. . .`→ …
230
230
*`---`→ —
231
231
*`--`→ –
@@ -252,7 +252,7 @@ Examples:
252
252
253
253
#### Badges
254
254
255
-
Badges are normally just shorthands for [Icons](#Icons)(also in different colors). To add a _badge_ to some inline text, use the corresponding class among those listed in the following table. For example, the following code:
255
+
Badges are normally just shorthands for [Icons](#Icons)formatted with different colors. To add a _badge_ to some inline text, use the corresponding class among those listed in the following table. For example, the following code:
256
256
257
257
[Genoa, Italy](class:geo)
258
258
@@ -319,7 +319,7 @@ And use them in hyperlinks (note the usage of square brackets instead of round b
319
319
320
320
#### Headings
321
321
322
-
Headings can be specified simply by prepending [#](class:kwd)s, as follows:
322
+
Headings can be specified simply by prepending [#](class:kwd)s to text, as follows:
0 commit comments