|Feb 20, 2024
|Feb 17, 2024
|Dec 2, 2023
|Nov 23, 2023
|Aug 21, 2022
#4 in Rendering
1,075 downloads per month
Inlyne - a GPU powered, browserless, markdown + html viewer
inlyne README.md --theme dark/light
Markdown files are a wonderful tool to get formatted, visually appealing, information to people in a minimal way. Except 9 times out of 10 you need an entire web browser to quickly open a file...
Introducing Inlyne, a GPU powered yet browserless tool to help you quickly view markdown files in the blink of an eye 👀.
To install just use
cargo install inlyne, almost everything comes pre-bundled (see Dependencies).
Alternatively you can install through various package managers.
fontconfig package from your distribution needs to be installed. See https://github.com/yeslogic/fontconfig-rs#dependencies.
Over time the features of this application will continue to grow. However there are a few core features that will remain at the heart of the project.
- Browserless - People shouldn't need electron or chrome to quickly view markdown files in a repository.
- GPU Powered - Thanks to the WGPU Project rendering can and will be done as much on the GPU as we can get away with.
- Basic HTML Rendering - HTML is used in almost all project markdown files, thus having the bare minimum html to support common use cases is necessary, but don't expect forms and buttons.
- Live Code Change - Inlyne will monitor your markdown file for any write modifications and automatically refresh the document where you left off. It's designed to work seamlessly and allow you to make edits on the fly.
What does it support?
|Super cool tables
|For organising data
Code Blocks (with syntect highlighting)
// Code thats drawing this text
let bounds = (screen_size.0 - pos.0 - DEFAULT_MARGIN, screen_size.1);
Lists and Links
- Watch Game of Thrones
- Feed the cat
Click me to show text
You weren't supposed to see this!
“Optimism is an occupational hazard of programming: feedback is the treatment. “ Kent Beck
Are these text effects
to too much? Theres no such thing
inlyne --help to see all the command line options. Some of which can be set permentantly by placing an
inlyne.toml file into a directory called
inlyne within the default dirs configuration folder for your respective OS:
inlyne.default.toml for an example configuration.
Is this a html markdown or html renderer?
All markdown files are converted to html thanks to comrak and rendered from there. So technically its a markdown converter and html renderer.
However for obvious complexity reasons, inlynes only going to support enough
html to get by rendering 95% of markdown files such as
Unforuntately things like
<form> and every single css style isn't going to be in scope
Why not use a browser or Visual Studio Code?
You definitely can! And it'll probably do a lot more accurate job at rendering it.
However wouldn't it be nice to have an application that can quickly open that one file in your vim setup? I'd like to think of this as the macOS preview or Adobe Acrobat of markdown.
Send your PRs! Send your issues! Everything will help :)
Any code that you can in this repository, you can copy under the MIT license.