https://github.com/rawnly/tinymd
Dead simple markdown compiler, written in Rust 🦀
https://github.com/rawnly/tinymd
Last synced: 7 months ago
JSON representation
Dead simple markdown compiler, written in Rust 🦀
- Host: GitHub
- URL: https://github.com/rawnly/tinymd
- Owner: rawnly
- Created: 2021-05-23T16:59:00.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2021-05-23T20:56:39.000Z (about 5 years ago)
- Last Synced: 2024-12-28T09:43:26.530Z (over 1 year ago)
- Language: Rust
- Homepage: https://rawnly.github.io/tinymd/
- Size: 14.6 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# TinyMD
> Project inspired to [Jesse Lawson rust guide](https://jesselawson.org/rust/getting-started-with-rust-by-building-a-tiny-markdown-compiler).
## Usage
Install the latest release from the [releases page](https://github.com/rawnly/tinymd/releases/latest)
```sh
$ tinymd
```
## Language support
This compiler is intended to be as simple as possible. Right now supports just a few markdown features:
- Headings (h1 to h6)
- Bold
- Underline
- Italic
- Code blocks
- Code word
Example output of this README: [README.html](README.html)
## To Do
- [x] Links and Images.
- [ ] Nested bold and italics.
- [ ] Tables (really?)
### Caveats
it currently doesn't support nested **bold** or *italic* such as
```md
This is **some *nested* italic-bold**
```