4 releases
0.1.3 | Sep 1, 2024 |
---|---|
0.1.2 | Aug 22, 2024 |
0.1.1 | Aug 21, 2024 |
0.1.0 | Aug 20, 2024 |
#135 in GUI
1MB
4K
SLoC
🌋 Igneous-md
The simple and lightweight markdown viewer written in rust
Igneous-md is a gfm compatible markdown viewer with a focus of staying lightweight and minimal.
Features
- Syntax highlighting similar to GitHub using highlight.js
- Standalone markdown viewer outside browser
- Switching of stylesheets on the fly
- Ability to add custom CSS
- Export generated HTML
- Works offline
To-do
-
Fix bugs
-
Create packages
-
Write tests
-
Add default css / examples
-
Add syntax highlighting
-
Move from
fetch
to websockets -
Export HTML
-
Add docs
Usage
igneous-md --path path/to/file.md
For more information see docs.md
How does it work?
Igneous-md works by running a lightweight server in the background, to which any number of clients may connect to. This means you can view your markdown in the provided viewer, or if you prefer in the browser.
Attribution
Many thanks to all the people, who have created/contributed to technology used in the creation this project.
License
This project is licensed under either of
at your option.
Dependencies
~44MB
~1M SLoC