https://github.com/jesselawson/tinymd
The TinyMD Markdown compiler built in "Getting Started with Rust"
https://github.com/jesselawson/tinymd
Last synced: about 2 months ago
JSON representation
The TinyMD Markdown compiler built in "Getting Started with Rust"
- Host: GitHub
- URL: https://github.com/jesselawson/tinymd
- Owner: jesselawson
- License: mit
- Created: 2022-06-09T05:50:30.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-03-08T04:12:51.000Z (about 2 years ago)
- Last Synced: 2025-02-05T22:36:49.543Z (3 months ago)
- Language: Rust
- Size: 4.88 KB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# TinyMD, a tiny Markdown compiler
This is the TinyMD compiler that you build in the free online
book [Getting Started with Rust](https://jesselawson.github.io/getting-started-with-rust). It understands basic first-level
headings and paragraphs only, and leaves room for improvement.
## Usage
1. Clone this repo:
```
$ git clone https://www.github.com/jesselawson/tinymd.git
```
2. Build from source:
```
$ cd tinymd && cargo build
```
3. Run with the included Markdown file (or your own):
```
$ cargo run hello.md
```
## Contributing
This repository must match the code content in [Getting Started with Rust](https://jesselawson.github.io/getting-started-with-rust),
so code parity between this repo and the book is paramount.
Any PR to this repo will require a PR to the book, and possibly
a content update.