doc/HastyScribe_UserGuide.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 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 |
% HastyScribe User Guide % Fabio Cevasco % - ## Overview [](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). In other words, all documents created by HastyScribe are constituted by only one [.HTML](class:ext) file, for easy distribution. ### Rationale 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. 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. {{hs}}: * 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). * takes care of styling your documents properly, making sure they look good on your desktop and even on small screens, ready to be distributed. * 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. ### Key Features #### Standard Markdown {{hs}} supports standard {{md}} for formatting text. Markdown is a lightweight markup language created by John Gruber, and used on many web sites and programs to enable users to write HTML code _without actually writing HTML tags_. > %tip% > Tip > > You can learn about Markdown syntax in the [Syntax Reference](#Syntax.Reference) section of this document. Alternatively, you can also read the original [Markdown syntax page][md-syntax] on John Gruber's blog, Daring Fireball. #### Discount Extensions 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: * format blocks of texts to create [notes](#Notes) and [sidebars](#Sidebars) * style text using CSS classes * create definition lists and alphabetical lists #### Text Snippets 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)). #### Custom Fields {{hs}} also supports [fields](#Fields) to easily include things like the current date or time, but also custom values specified as command-line parameters. #### Image (and font) Embedding {{hs}} only produces single HTML files. With _no dependencies_: * By default, the HastyScribe, FontAwesome, Source Sans Pro, and Source Code Pro fonts are automatically embedded. * All referenced images (both local and remote) are automatically embedded using the {{datauri -> [data URI scheme](http://en.wikipedia.org/wiki/Data_URI_scheme)}}. #### FontAwesome Icons [FontAwesome][fa] icons can be used in [badges](#Badges) or simply to customize text. [](class:fa-thumbs-up) #### Notes, tips, warnings, sidebars and badges > %sidebar% > About notes etc. > > HastyScribe has built-in [tips](#Tips), [notes](#Notes), [warnings](#Warnings), [sidebars](#Sidebars), like this one. [...and this is a comment badge.](class:draftcomment) #### Responsive Design All HTML documents created by {{hs}} are responsive and can be viewed perfectly on small devices. #### Printed Media Support {{hs}}'s stylesheet contains styles that are specific for printed media. This means that if you try to print an HTML file generated by {{hs}} it will paginate properly and it will display headers and footers (with page numbers). ## Getting Started ### Downloading Pre-built Binaries The easiest way to get {{hs}} is by downloading one of the prebuilt binaries from the [Github Release Page][release]: * [HastyScribe for Mac OS X (x64)]({{release}}{{$version}}/hastyscribe_v{{$version}}_macosx_x64.zip) -- Compiled on OS X Yosemite (LLVM CLANG 6.0) * [HastyScribe for Windows (x64)]({{release}}{{$version}}/hastyscribe_v{{$version}}_windows_x64.zip) -- Cross-compiled on OS X Yosemite (MinGW-w64 GCC 4.8.2) * [HastyScribe for Windows (x86)]({{release}}{{$version}}/hastyscribe_v{{$version}}_windows_x86.zip) -- Cross-compiled on OS X Yosemite (MinGW-w64 GCC 4.8.2) * [HastyScribe for Linux (x86)]({{release}}{{$version}}/hastyscribe_v{{$version}}_linux_x86.zip) -- Cross-compiled on OS X Yosemite (GNU GCC 4.8.1) * [HastyScribe for Linux (ARM)]({{release}}{{$version}}/hastyscribe_v{{$version}}_linux_arm.zip) -- Cross-compiled on OS X Yosemite (GNU GCC 4.8.2) ### Installing using Nimble If you already have [Nim][nim] installed on your computer, you can simply run [nimble install hastyscribe](class:cmd) ### Building from Source You can also build HastyScribe from source, if there is no pre-built binary for your platform. First of all you need a [libmarkdown.a](class:file) static library. You can either grab one precompiled (Windows or Mac OS X) from the [vendor]({{repo -> https://github.com/h3rald/hastyscribe}}/blob/master/vendor) folder of the {{hs}} repository or build your own. If you choose to build your own: 1. Clone the discount [repository](https://github.com/Orc/discount). 2. In the directory containing the Discount source code, run the following commands: > %terminal% > ./configure.sh \-\-with-tabstops=2 \-\-with-dl=both \-\-with-id-anchor \-\-with-github-tags \-\-with-fenced-code \-\-enable-all-features > > make > %tip% > Tip > > If you are on Windows, you can compile Discount using [MinGW-w64](http://mingw-w64.yaxm.org/doku.php). Once you have a [libmarkdown.a](class:file) static library for your platform: 1. Download and install [Nim][nim]. 2. Clone the HastyScribe [repository](https://github.com/h3rald/hastyscribe). 3. Put your [libmarkdown.a](class:file) file in the [vendor](class:dir) directory. 4. Run [nim c hastyscribe.nim](class:cmd) ## Usage {{hs}} is a command-line application that can compile one or more Markdown files into one or more HTML files with the same name(s). ### Command Line Syntax [hastyscribe](class:cmd) _filename-or-glob-expression_ **[** [_<options\>_](class:opt) **]** 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: * [\-\-notoc](class:opt) causes {{hs}} to output HTML documents _without_ automatically generating a Table of Contents at the start. * [\-\-user-css=<file\>](class:opt) causes {{hs}} inserts the contents of the specified local file as a CSS stylesheet. * [\-\-output-file=<file\>](class:opt) causes {{hs}} to write output to a local file (Use [\-\-output-file=-](class:opt) to output to standard output). ### Linux/OSX Examples Executing {{hs}} to compile [my_markdown_file.md](class:file) within the current directory: > %terminal% > ./hastyscribe my\_markdown\_file.md Executing {{hs}} to compile all [.md](class:ext) files within the current directory: > %terminal% > ./hastyscribe \*.md ### Windows Examples Executing {{hs}} to compile [my_markdown_file.md](class:file) within the current directory: > %terminal% > hastyscribe.exe my\_markdown\_file.md Executing {{hs}} to compile all [.md](class:ext) files within the current directory: > %terminal% > hastyscribe.exe \*.md > %tip% > Tip > > You can also drag a Markdown file directly on [hastyscribe.exe](class:kwd) to compile it to HTML. ## Syntax Reference ### Document Headers {{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 ~~~ % HastyScribe User Guide % Fabio Cevasco % - ~~~ > %warning% > Important > > * The order of the document headers is significant. > * If you want to use the current date, enter [% -](class:kwd) in the third line. ### Snippets If you want to reuse a few words or even entire blocks of texts, you can use {{hs}}'s snippets. A snippet definition is constituted by an identifier, followed by an arrow (->), followed by some text -- all wrapped in double curly brackets. The following definition creates a snippet called [test](class:kwd) which is transformed into the text "This is a test snippet.". <code>\{\{test -> This is a test snippet.\}\}</code> Once a snippet is defined _anywhere_ in the document, you can use its identifier wrapped in double curly brackets (<code>\{\{test}\}\}</code> in the previous example) anywhere in the document to reuse the specified text. > %note% > Remarks > > * It doesn't matter where a snippet is defined. Snippets can be used anywhere in the document, before or after their definition. > * When a document is compiled, both snippets _and snippets definitions_ are evaluated their body text. ### Fields Besides user-defined snippets, {{hs}} also support fields, which can be used to insert current time and date information in a variety of formats: > %responsive% > Source | Output > --------------------------------------------|---------------------- > <code>\{\{$timestamp\}\}</code> | {{$timestamp}} > <code>\{\{$date\}\}</code> | {{$date}} > <code>\{\{$full-date\}\}</code> | {{$full-date}} > <code>\{\{$long-date\}\}</code> | {{$long-date}} > <code>\{\{$medium-date\}\}</code> | {{$medium-date}} > <code>\{\{$short-date\}\}</code> | {{$short-date}} > <code>\{\{$short-time\}\}</code> | {{$short-time}} > <code>\{\{$short-time-24\}\}</code> | {{$short-time-24}} > <code>\{\{$time\}\}</code> | {{$time}} > <code>\{\{$time-24\}\}</code> | {{$time-24}} > <code>\{\{$day\}\}</code> | {{$day}} > <code>\{\{$short-day\}\}</code> | {{$short-day}} > <code>\{\{$month\}\}</code> | {{$month}} > <code>\{\{$short-month\}\}</code> | {{$short-month}} > <code>\{\{$year\}\}</code> | {{$year}} > <code>\{\{$short-year\}\}</code> | {{$short-year}} > <code>\{\{$weekday\}\}</code> | {{$weekday}} > <code>\{\{$weekday-abbr\}\}</code> | {{$weekday-abbr}} > <code>\{\{$month-name\}\}</code> | {{$month-name}} > <code>\{\{$month-name-abbr\}\}</code> | {{$month-name-abbr}} > <code>\{\{$timezone\}\}</code> | {{$timezone}} > <code>\{\{$timezone-offset\}\}</code> | {{$timezone-offset}} Additionally, you can define your own custom fields via command-line parameters, using the [--field/](class:arg) dynamic parameter, like this: > %terminal% > hastyscribe my-document.md --field/product:HastyScribe --field/version:1.2.0 In this case it will be possible to access the <kwd>product</kwd> and <kwd>product</kwd> fields within [my-document.md](class:file) using <code>\{\{$product\}\}</code> and <code>\{\{$version\}\}</code>. ### Inline Formatting The following table lists all the most common ways to format inline text: > %responsive% > Source | Output > ----------------------------------------------------|-------------------- > `**strong emphasis**` or `__strong emphasis__` | __strong emphasis__ > `*emphasis*` or `_emphasis_` | *emphasis* > `~~deleted text~~` | ~~deleted text~~ > `<ins>inserted text<ins>` | <ins>inserted text</ins> > ```code` `` | `code` > `[HTML](abbr:Hypertext Markup Language)` | [HTML](abbr:Hypertext Markup Language) > `<kbd>CTRL</kbd>+<kbd>C</kbd>` | <kbd>CTRL</kbd>+<kbd>C</kbd> > `<mark>marked</mark>` | <mark>marked</mark>. > `Sample output: <samp>This is a test.</samp>` | Sample output: <samp>This is a test.</samp> > `Set the variable <var>test</var> to 1.` | Set the variable <var>test</var> to 1. > `<q>This is a short quotation</q>` | <q>This is a short quotation</q> > `<cite>Hamlet</cite>, by William Shakespeare.` | <cite>Hamlet</cite>, by William Shakespeare. > `A [.md](class:ext) file` | A [.md](class:ext) file > `[my_markdown_file.md](class:file) file` | [my_markdown_file.md](class:file) file > %tip% > Tip > > The [kwd](class:kwd), [opt](class:kwd), [file](class:kwd), [dir](class:kwd), [arg](class:kwd), [tt](class:kwd) and [cmd](class:kwd) are all rendered as inline monospace text. [kwd](class:kwd) and [ext](class:ext) are also rendered in bold. #### SmartyPants Substitutions Special characters can be easily entered using some special character sequences. {{hs}} supports all the sequences supported by [Discount][discount]: * <code>`` text‘’</code> → “text”. * `"double-quoted text"` → “double-quoted text” * `'single-quoted text'` → ‘single-quoted text’ * `don't` → don’t. as well as anything-else’t. (But foo'tbar is just foo'tbar.) * `it's` → it’s, as well as anything-else’s (except not foo'sbar and the like.) * `(tm)` → ™ * `(r)` → ® * `(c)` → © * `1/4th` → 1/4th. Same goes for 1/2 and 3/4. * `...` or `. . .` → … * `---` → — * `--` → – * `A^B` becomes A^B. Complex superscripts can be enclosed in brackets, so `A^(B+2)` → A^(B+2). #### Icons {{hs}} bundles the [FontAwesome][fa] icon font. To prepend an icon to text you can use Discount's _class:_ pseudo-protocol, and specify a valid [fa-*](class:kwd) (non-alias) class. Examples: > %responsive% > Source | Output > -----------------------------------------|------------ > `[a paper plane](class:fa-paper-plane)` | [ a paper plane](class:fa-paper-plane) > `[Galactic Empire](class:fa-empire)` | [ Galactic Empire](class:fa-empire) > `[Rebel Alliance](class:fa-rebel)` | [ Rebel Alliance](class:fa-rebel) > %tip% > Tip > > See the [FontAwesome Icon Reference][fa-icons] for a complete list of all CSS classes to use for icons (aliases are not supported). #### Badges 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: [Genoa, Italy](class:geo) produces the following result: [Genoa, Italy](class:geo) {{hs}} currently supports the following badges: > %responsive% > Class | Badge | Class | Badge > ---------------------|------------------------------|-------------------------------------------- > `todo` | [](class:todo) |`user` | [](class:user) > `fixme` | [](class:fixme) |`tag` | [](class:tag) > `deadline` | [](class:deadline) |`tags` | [](class:tags) > `draftcomment` | [](class:draftcomment) |`attachment` | [](class:attachment) > `urgent` | [](class:urgent) |`bug` | [](class:bug) > `verify` | [](class:verify) |`geo` | [](class:geo) > `project` | [](class:project) |`eur` | [](class:eur) > `red-circle` | [](class:red-circle) |`gbp` | [](class:gbp) > `yellow-circle` | [](class:yellow-circle) |`usd` | [](class:usd) > `green-circle` | [](class:green-circle) |`rub` | [](class:rub) > `gray-circle` | [](class:gray-circle) |`jpy` | [](class:jpy) > `star` | [](class:star) |`btc` | [](class:btc) > `heart` | [](class:heart) |`try` | [](class:try) > `square` | [](class:square) |`krw` | [](class:krw) > `check` | [](class:check) |`inr` | [](class:inr) > `lock` | [](class:lock) |`danger` | [](class:danger) > `unlock` | [](class:unlock) |`question` | [](class:question) > `email` | [](class:email) |`website` | [](class:website) > `phone` | [](class:phone) |`fax` | [](class:fax) > `tm` | [](class:tm) |`reg` | [](class:reg) > `copy` | [](class:copy) |`red-flag` | [](class:red-flag) > `green-flag` | [](class:green-flag) |`yellow-flag` | [](class:yellow-flag) > `story` | [](class:story) |`feature` | [](class:feature) > `add` | [](class:add) |`remove` | [](class:remove) > `time` | [](class:time) |`date` | [](class:date) > `html5` | [](class:html5) |`css3` | [](class:css3) > `apple` | [](class:apple) |`windows` | [](class:windows) > `linux` | [](class:linux) |`android` | [](class:android) > `idea` | [](class:idea) |`link` | [](class:link) > `chrome` | [](class:chrome) |`firefox` | [](class:firefox) > `ie` | [](class:ie) |`opera` | [](class:opera) > `safari` | [](class:safari) |`sticky` | [](class:sticky) #### HastyScribe Logo To display the {{hs}} logo, use the [hastyscribe](class:kwd) class, like this: `[](class:hastyscribe)` → [](class:hastyscribe) #### Links > %responsive% > Source | Output > ----------------------------------------|------------ > `[H3RALD](https://h3rald.com/)` | [H3RALD](https://h3rald.com/) > `[H3RALD](https://h3rald.com/ "H3RALD")`| [H3RALD](https://h3rald.com/ "H3RALD") > `<https://h3rald.com>` | <https://h3rald.com> Additionally, you can define placeholders for URLs and link titles, like this: `[h3rald]: https://h3rald.com/ "Fabio Cevasco's Web Site"` And use them in hyperlinks (note the usage of square brackets instead of round brackets): `[H3RALD][h3rald]` > %sidebar% > Link Icons > > {{hs}} automatically adds an envelope icon to email links, an arrow icon to links to external web sites, and logo icons to links to well-known web sites: > > * [h3rald@h3rad.com](mailto:h3rald@h3rald.com) > * [@h3rald](https://twitter.com/h3rald) > * [fabiocevasco](http://it.linkedin.com/in/fabiocevasco) ### Block-level Formatting #### Headings Headings can be specified simply by prepending [#](class:kwd)s to text, as follows: ~~~ # Heading 1 ## Heading 2 ### Heading 3 #### Heading 4 ##### Heading 5 ###### Heading 6 ~~~ > %note% > Note > > If you use [Document Headers](#Document.Headers), A [H1](class:kwd) is used for the title of the {{hs}} document. Within the document, start using headings from [H2](class:kwd). #### Tables {{hs}} supports [PHP Markdown Extra][pme] table syntax using pipes and dashes. {{input-text}} ~~~ Column Header 1 | Column Header 2 | Column Header 3 ----------------|-----------------|---------------- Cell 1,1 | Cell 1,2 | Cell 1, 3 Cell 2,1 | Cell 2,2 | Cell 2, 3 Cell 3,1 | Cell 3,2 | Cell 3, 3 ~~~ {{output-text}} Column Header 1 | Column Header 2 | Column Header 3 ----------------|-----------------|---------------- Cell 1,1 | Cell 1,2 | Cell 1, 3 Cell 2,1 | Cell 2,2 | Cell 2, 3 Cell 3,1 | Cell 3,2 | Cell 3, 3 > %note% > Note > > Multi-row cells are not supported. If you need more complex tables, use HTML code instead. > %sidebar% > Responsive Tables > > To make tables responsive, put them in a _responsive_ block, like in the previous example. The [responsive](class:kwd) class causes a table not to shrink and makes it scrollable horizontally on small devices. #### Block Quotes Block quotes can be created simply by prepending a [>](class:kwd) to a line, and they can be nested by prepending additional [>](class:kwd)s. {{input-text}} ~~~ > This is a block quote. > > This is a nested quote. ~~~ {{output-text}} > This is a block quote. > > This is a nested quote. #### Code Blocks To format a block of source code, indent it by at least four spaces. Here's the result: proc encode_image_file*(file, format): string = if (file.existsFile): let contents = file.readFile return encode_image(contents, format) else: echo("Warning: image '"& file &"' not found.") return file Alternatively, you can also use Github-style fenced blocks, by adding three tildes (~~~) before and after the source code. > %warning% > Warning > > {{hs}} does not support syntax highlighting for code blocks. To do so, it would require Javascript and {{hs}} is currently kept purposedly "Javascript-free". #### Images {{input-text -> The following HastyScribe Markdown code:}} ~~~ ![HastyScribe Logo](../assets/images/hastyscribe.png =221x65) ~~~ {{output-text -> Produces the following output:}} ![HastyScribe Logo](../assets/images/hastyscribe.png =221x65) > %tip% > Tip > > You can use URL placeholders for images as well, exactly like for links. > %warning% > Limitations on automatic image download > > {{hs}} will attempt to download all HTTP image links. Note that: > > * If no response is received within 5 seconds, the download will be aborted. > * Connecting through a proxy is currently not supported. > * To download an image via HTTPS, you must explicitly recompile {{hs}} with [-d:ssl](class:kwd) and OpenSSL must be installed on your system. > > If {{hs}} is unable to download an image, it will leave it linked. #### Lists ##### Unordered Lists {{input-text}} ~~~ * An item * Another item * And another... ~~~ {{output-text}} * An item * Another item * And another... ##### Ordered Lists {{input-text}} ~~~ 1. First item 2. Second item 3. Third item ~~~ {{output-text}} 1. First item 2. Second item 3. Third item > %tip% > Tip > > You don't have to write numbers in order -- any number followed by a dot will do. ##### Alphabetical Lists {{input-text}} ~~~ a. First item b. Second item c. Third item ~~~ {{output-text}} a. First item d. Second item c. Third item > %tip% > Tip > > You don't have to write letters in order -- any letter followed by a dot will do. ##### Unstyled Lists {{input-text}} ~~~ > %unstyled% > * An item > * Another item > * And another... ~~~ {{output-text}} > %unstyled% > * An item > * Another item > * And another... ##### Nested Lists To create a list within a list, simply indent the whole nested list with four space. {{input-text}} ~~~ * This is a normal list * Another item * A nested unordered list * Another item * Back in the main list a. A nested alphabetical list b. Another item ~~~ {{output-text}} * This is a normal list * Another item * A nested unordered list * Another item * Back in the main list a. A nested alphabetical list b. Another item ##### Definition Lists In some cases you may want to write a list of terms and their corresponding definitions. You could use an ordinary unordered list, but semantically speaking the _proper_ type of list to use in this case is a definition list. {{input-text}} ~~~ unordered list : A list for unordered items. Also called _bulleted list_. ordered list : A list for ordered items. Also called _numbered list_. alphabetical list : Technically speaking just an ordered list, but formatted with letters instead of numbers definition list : A list of terms and definitions. ~~~ {{output-text}} unordered list : A list for unordered items. Also called _bulleted list_. ordered list : A list for ordered items. Also called _numbered list_. alphabetical list : Technically speaking just an ordered list, but formatted with letters instead of numbers definition list : A list of terms and definitions. Alternatively, you can write the above definition list as follows: ~~~ =unordered list= A list for unordered items. Also called _bulleted list_. =ordered list= A list for ordered items. Also called _numbered list_. =alphabetical list= Technically speaking just an ordered list, but formatted with letters instead of numbers =definition list= A list of terms and definitions. ~~~ #### Class Blocks ##### Notes [Discount][discount] supports the definition of _class blocks_: [div](class:kwd)s with a class attribute. The syntax is very similar to the one used for [block quotes](#Block.Quotes), with the addition of the class name wrapped in [%](class:kwd)s on the first line. In {{hs}}, this syntax is used to produce notes, [tips](#Tips), [warmings](#Warnings), [sidebars](#Sidebars) and [terminal sessions](#Terminal.Sessions). {{input-text}} ~~~ > %note% > Note > > This is a note. ~~~ {{output-text}} > %note% > Note > > This is a note. ##### Tips Tips are used for optional information that can help the user in some way. {{input-text}} ~~~ > %tip% > Tip > > This is a tip. ~~~ {{output-text}} > %tip% > Tip > > This is a tip. ##### Warnings Warnings are used for important information the user should not overlook. {{input-text}} ~~~ > %warning% > Warning > > This is a warning or an important note. ~~~ {{output-text}} > %warning% > Warning > > This is a warning or an important note. ##### Sidebars Sidebars are used for digressions and asides. {{input-text}} ~~~ > %sidebar% > This is a _sidebar_ > > Although not always placed on the side of the page, _sidebars_ contain additional content and asides. ~~~ {{output-text}} > %sidebar% > This is a _sidebar_ > > Although not always placed on the side of the page, _sidebars_ contain additional content and asides. ##### Terminal Sessions Terminal sessions are used to display commands entered in a terminal, in sequence, without displaying their output. {{input-text}} ~~~ > %terminal% > > cd src > > ./configure > > make && sudo make install ~~~ {{output-text}} > %terminal% > > cd src > > ./configure > > make && sudo make install If commands must be executed as a super-user, use the [terminal-su](class:kwd) class instead: {{input-text}} ~~~ > %terminal-su% > > shutdown -h now ~~~ {{output-text}} > %terminal-su% > > shutdown -h now ## Credits HastyScribe is powered by the following open source software (see [LICENSE.md]({{repo}}/blob/master/LICENSE.md) for licensing details): * The wonderful [Discount][discount] C library, used to parse markdown code. * The ...awesome [FontAwesome][fa] font, used for all the icons. * The beautiful [Mr Bedfort][sudtipos] font, used as the base for the {{hs}} logo. * The neat [Source Sans Pro](https://store1.adobe.com/cfusion/store/html/index.cfm?event=displayFontPackage&code=1959) and [Source Code Pro](http://store1.adobe.com/cfusion/store/html/index.cfm?event=displayFontPackage&code=1960) fonts, used for all standard text. Special thanks to: * Philip Wernersbach and Joshua Ellis, for contributing to {{hs}}. * Andreas Rumpf, creator of the amazing [Nim][nim] programming language, used to implement {{hs}}. * Ethan Lai, developer of the handy [Koala](http://koala-app.com/) app, used to compile all the LESS code into CSS. -> ![Creative Commons Attribution-Noncommercial-No Derivative Works 3.0 Unported License](../assets/images/by-nc-nd_3.0.png) <- [nim]: http://nim-lang.org/ [df]: https://daringfireball.net/projects/markdown/ [discount]: http://www.pell.portland.or.us/~orc/Code/discount/ [pandoc]: http://johnmacfarlane.net/pandoc/ [md-syntax]: https://daringfireball.net/projects/markdown/syntax [fa]:http://fortawesome.github.io/Font-Awesome/ [fa-icons]:http://fortawesome.github.io/Font-Awesome/icons/ [pme]:http://michelf.com/projects/php-markdown/extra/ [sudtipos]:http://www.sudtipos.com/ [release]:{{release -> https://github.com/h3rald/hastyscribe/releases/download/v}} |