Skip to content

Commit e8f82b6

Browse files
committed
Minor changes
1 parent d168e76 commit e8f82b6

5 files changed

+64
-70
lines changed

LICENSE.md

-6
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,6 @@ ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
7272

7373
### MIT License
7474

75-
~~~
7675
Permission is hereby granted, free of charge, to any person obtaining a copy of
7776
this software and associated documentation files (the "Software"), to deal in
7877
the Software without restriction, including without limitation the rights to
@@ -89,18 +88,14 @@ FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
8988
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
9089
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
9190
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
92-
~~~
9391

9492
### Open Font License
9593

96-
~~~
9794
This Font Software is licensed under the SIL Open Font License, Version 1.1.
9895
This license is copied below, and is also available with a FAQ at:
9996
http://scripts.sil.org/OFL
10097

101-
-----------------------------------------------------------
10298
SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
103-
-----------------------------------------------------------
10499

105100
PREAMBLE
106101
The goals of the Open Font License (OFL) are to stimulate worldwide
@@ -184,4 +179,3 @@ INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
184179
DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
185180
FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
186181
OTHER DEALINGS IN THE FONT SOFTWARE.
187-
~~~

README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -45,21 +45,21 @@ First of all you need a **libmarkdown.a** static library. You can either grab on
4545

4646
If you choose to build your own:
4747

48-
1. Download/clone [Discount](https://github.com/Orc/discount) source code
49-
2. In the directory containing Discount source code, run the following commands:
48+
1. Clone the discount [repository](https://github.com/Orc/discount).
49+
2. In the directory containing the Discount source code, run the following commands:
5050

5151
```
5252
./configure.sh --with-tabstops=2 --with-dl=both --with-id-anchor --with-github-tags --with-fenced-code --enable-all-features
5353
5454
make
5555
```
5656

57-
Note: If you are on Windows, you can compile it using [MinGW](http://www.mingw.org/).
57+
Tip: If you are on Windows, you can compile Discount using [MinGW](http://www.mingw.org/).
5858

5959
Once you have a **libmarkdown.a** static library for your platform:
6060

6161
1. Download and install [Nimrod][nimrod].
62-
2. Download/clone the HastyScribe [repository](https://github.com/h3rald/hastyscribe).
62+
2. Clone the HastyScribe [repository](https://github.com/h3rald/hastyscribe).
6363
3. Put your **libmarkdown.a** file in the **vendor** directory.
6464
4. Run **nixbuild** (if you are on OSX, Linux or other UNIX-like operating systems) or **winbuild.bat** (if you are on Windows)
6565

doc/HastyScribe_UserGuide.htm

+29-29
Large diffs are not rendered by default.

doc/HastyScribe_UserGuide.md

+29-29
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,21 @@
44

55
## Overview
66

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).
88

99
In other words, all documents created by HastyScribe are constituted by only one [.HTML](class:ext) file, for easy distribution.
1010

1111
### Rationale
1212

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.
1414

1515
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.
1616

1717
{{hs}}:
1818

1919
* 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.
2222

2323
### Key Features
2424

@@ -33,26 +33,26 @@ Sometimes you just want to write your document in markdown, and get a full HTML
3333
3434
#### Discount Extensions
3535

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:
3737

38-
* format blocks of texts to create [notes](#Notes) and [sidebar](#Sidebars)
38+
* format blocks of texts to create [notes](#Notes) and [sidebars](#Sidebars)
3939
* style text using CSS classes
4040
* create definition lists and alphabetical lists
4141

4242
#### Text Snippets
4343

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)).
4545

4646
#### Image (and font) Embedding
4747

4848
{{hs}} only produces single HTML files. With _no dependencies_:
4949

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.
5151
* All referenced local images are automatically embedded using the {{datauri -> [data URI scheme](http://en.wikipedia.org/wiki/Data_URI_scheme)}}.
5252

5353
#### FontAwesome Icons
5454

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)
5656

5757
#### Notes, tips, warnings, sidebars and badges
5858

@@ -73,40 +73,40 @@ All HTML documents created by {{hs}} are responsive and can be viewed perfectly
7373

7474
The easiest way to get {{hs}} is by downloading one of the prebuilt binaries from the [Github Release Page][release]:
7575

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
7878

7979
### Building from Source
8080

8181
You can also build HastyScribe from source, if there is no pre-built binary for your platform.
8282

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.
8484

8585
If you choose to build your own:
8686

87-
1. Download/clone [Discount](https://github.com/Orc/discount) source code
88-
2. In the directory containing Discount source code, run the following commands:
87+
1. Clone the discount [repository](https://github.com/Orc/discount).
88+
2. In the directory containing the Discount source code, run the following commands:
8989

9090
> %terminal%
9191
> ./configure.sh --with-tabstops=2 --with-dl=both --with-id-anchor --with-github-tags --with-fenced-code --enable-all-features
9292
>
9393
> make
9494
95-
> %note%
96-
> Note
95+
> %tip%
96+
> Tip
9797
>
98-
> 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/).
9999
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:
101101

102102
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)
106106

107107
## Usage
108108

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).
110110

111111
### Command Line Syntax
112112

@@ -150,7 +150,7 @@ Executing {{hs}} to compile all [.md](class:ext) files within the current direct
150150

151151
### Document Headers
152152

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
154154

155155
~~~
156156
% HastyScribe User Guide
@@ -175,7 +175,7 @@ The following definition creates a snippet called [test](class:kwd) which is tra
175175

176176
[\{\{test -> This is a test snippet.\}\}](class:tt)
177177

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.
179179

180180
> %note%
181181
> Remarks
@@ -202,8 +202,8 @@ The following table lists all the most common ways to format inline text:
202202
> `Set the variable <var>test</var> to 1.` | Set the variable <var>test</var> to 1.
203203
> `<q>This is a short quotation</q>` | <q>This is a short quotation</q>
204204
> `<cite>Hamlet</cite>, by William Shakespeare.` | <cite>Hamlet</cite>, by William Shakespeare.
205-
> `A [.md](class:ext)` file | A [.md](class:ext) file
206-
> `[my_markdown_file.md](class:file)` file | [my_markdown_file.md](class:file) file
205+
> `A [.md](class:ext) file` | A [.md](class:ext) file
206+
> `[my_markdown_file.md](class:file) file` | [my_markdown_file.md](class:file) file
207207
208208
> %tip%
209209
> Tip
@@ -225,7 +225,7 @@ Special characters can be easily entered using some special character sequences.
225225
* `(tm)` &rarr;
226226
* `(r)` &rarr; ®
227227
* `(c)` &rarr; ©
228-
* `1/4th` &rarr; ¼th. Same goes for for 1/4 (¼), 1/2 (½), 3/4ths (¾ths), and 3/4 (¾).
228+
* `1/4th` &rarr; 1/4th. Same goes for 1/2 and 3/4.
229229
* `...` or `. . .` &rarr;
230230
* `---` &rarr;
231231
* `--` &rarr;
@@ -252,7 +252,7 @@ Examples:
252252
253253
#### Badges
254254

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:
256256

257257
[Genoa, Italy](class:geo)
258258

@@ -319,7 +319,7 @@ And use them in hyperlinks (note the usage of square brackets instead of round b
319319

320320
#### Headings
321321

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:
323323

324324
~~~
325325
# Heading 1

winbuild.bat

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
@echo off
2-
nimrod c -l=-lmarkdown -l=-L$PWD/vendor hastyscribe.nim
3-
cp hastyscribe.exe build/win/hastyscribe.exe
2+
nimrod c -l=-lmarkdown -l=-L%~dp0\vendor hastyscribe.nim
3+
cp hastyscribe.exe build\win\hastyscribe.exe

0 commit comments

Comments
 (0)