Skip to content

Self-contained markdown compiler generating self-contained HTML documents

License

Notifications You must be signed in to change notification settings

h3rald/hastyscribe

Folders and files

NameName
Last commit message
Last commit date

Latest commit

718da2f · Sep 12, 2014

History

87 Commits
Sep 12, 2014
Sep 12, 2014
Aug 1, 2014
Aug 7, 2014
Jul 19, 2014
Aug 1, 2014
Aug 7, 2014
Aug 7, 2014
Aug 7, 2014
Jul 19, 2014
Aug 7, 2014
Sep 12, 2014

Repository files navigation

HastyScribe

HastyScribe is a simple command-line program able to convert 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, along with all the needed web fonts
  • It is built on top of Discount, which means that besides standard markdown you also get:
    • strikethrough
    • automatic Table of Contents generation
    • 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-style docuemnt headers
  • It automatically embeds any referenced local image via data URI
  • It has supports for text snippets

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 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 or Mac OS X) from the vendor folder of the HastyScribe repository or build your own.

If you choose to build your own:

  1. Clone the discount repository.

  2. In the directory containing the 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
    

Tip: If you are on Windows, you can compile Discount using MinGW.

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

  1. Download and install Nimrod.
  2. Clone the HastyScribe repository.
  3. Put your libmarkdown.a file in the vendor directory.
  4. Run nimrod c hastyscribe.nim

About

Self-contained markdown compiler generating self-contained HTML documents

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published