https://github.com/xnacly/fleck
A minimal, configurable and highly optimized markdown2html compiler, supports macros, watch mode, syntax highlighting, latex math and live preview
https://github.com/xnacly/fleck
html macros markdown markdown-parser markdown-to-html
Last synced: about 2 months ago
JSON representation
A minimal, configurable and highly optimized markdown2html compiler, supports macros, watch mode, syntax highlighting, latex math and live preview
- Host: GitHub
- URL: https://github.com/xnacly/fleck
- Owner: xNaCly
- License: mit
- Created: 2023-04-01T16:34:19.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2023-08-10T05:41:14.000Z (almost 2 years ago)
- Last Synced: 2025-03-31T04:03:52.010Z (3 months ago)
- Topics: html, macros, markdown, markdown-parser, markdown-to-html
- Language: Go
- Homepage:
- Size: 6.96 MB
- Stars: 13
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# fleck - Markdown-parser
- [Documentation](./doc/Readme.md)
_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
```bash
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](./doc/Usage.md)
- Follow the guide [above](#install) for installing fleck
- Run `fleck` from the cli on a Markdown file of your choice, for example the README of this project:
```bash
fleck README.md
```
- View the output:
