Skip to content

Latest commit

 

History

History
43 lines (29 loc) · 1005 Bytes

README.md

File metadata and controls

43 lines (29 loc) · 1005 Bytes

fleck - Markdown-parser

Fleck is intended for outputting standalone html from a markdown source.

Feature overview:

  • allmost all the markdown features (some have bugs, some are missing, don't @ me)
  • syntax highlighting
  • custom alert blockquotes
  • watch mode for recompiling the html if the source changed
  • live-preview in the browser for recompiling the html and reloading the tab if the source changed
  • escape html elements
  • rendering of latex equations

Install

From source

git clone https://github.com/xnacly/fleck
cd fleck
go build

From release

Until a release is ready please build from source.

Using fleck:

Read more about fleck's usage here

  • Follow the guide above for installing fleck
  • Run fleck from the cli on a Markdown file of your choice, for example the README of this project:
fleck README.md
  • View the output: Readme.png