{"id":13559702,"url":"https://github.com/Inlyne-Project/inlyne","last_synced_at":"2025-04-03T15:30:50.050Z","repository":{"id":53849825,"uuid":"521682591","full_name":"Inlyne-Project/inlyne","owner":"Inlyne-Project","description":"Introducing Inlyne, a GPU powered yet browserless tool to help you quickly view markdown files in the blink of an eye.","archived":false,"fork":false,"pushed_at":"2024-05-10T04:11:40.000Z","size":3141,"stargazers_count":979,"open_issues_count":40,"forks_count":28,"subscribers_count":5,"default_branch":"main","last_synced_at":"2024-05-11T10:42:29.373Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Inlyne-Project.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-08-05T15:09:52.000Z","updated_at":"2024-05-21T04:42:43.347Z","dependencies_parsed_at":"2024-04-04T04:26:54.011Z","dependency_job_id":"00c18467-3d00-4a2d-aafc-7a42df21145b","html_url":"https://github.com/Inlyne-Project/inlyne","commit_stats":{"total_commits":131,"total_committers":6,"mean_commits":"21.833333333333332","dds":"0.23664122137404575","last_synced_commit":"37666d81e2b1691cc8d05ba83dff9173e09f7765"},"previous_names":["inlyne-project/inlyne","trimental/inlyne"],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Inlyne-Project%2Finlyne","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Inlyne-Project%2Finlyne/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Inlyne-Project%2Finlyne/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Inlyne-Project%2Finlyne/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Inlyne-Project","download_url":"https://codeload.github.com/Inlyne-Project/inlyne/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246933366,"owners_count":20857050,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-01T13:00:31.469Z","updated_at":"2025-04-03T15:30:45.361Z","avatar_url":"https://github.com/Inlyne-Project.png","language":"Rust","readme":"\u003ch1 align=\"center\"\u003eInlyne - a GPU powered, browserless, markdown + html viewer\u003c/h1\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003c!-- Crates.io --\u003e\n  \u003ca href=\"https://crates.io/crates/inlyne\"\u003e\n    \u003cimg src=\"https://img.shields.io/crates/v/inlyne.svg\" alt=\"crates.io\" /\u003e\n  \u003c/a\u003e\n  \u003c!-- Codecov.io --\u003e\n  \u003ca href=\"https://codecov.io/github/Inlyne-Project/inlyne\"\u003e\n    \u003cimg src=\"https://codecov.io/github/Inlyne-Project/inlyne/graph/badge.svg?token=PAQUKH5JOV\" alt=\"codecov.io\" /\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n```bash\ninlyne README.md --theme dark/light\n```\n\n\u003cp align=\"center\"\u003e\n\u003cimg src=\"https://raw.githubusercontent.com/trimental/inlyne/v0.4/assets/img/example.png\" width=\"800\"/\u003e\n\u003c/p\u003e\n\n## About\n\nMarkdown files are a wonderful tool to get formatted, visually appealing, information to people in a minimal way.\nExcept 9 times out of 10 you need an entire web browser to quickly open a file...\n\nIntroducing **Inlyne**, a GPU powered yet browserless tool to help you quickly\nview markdown files in the blink of an eye 👀.\n\n## Installation\n\n`inlyne` is already present in a handful of different package repos.\nInstallation should be mostly painless as _most_ things come pre-bundled.\n\n[![Packaging status](https://repology.org/badge/vertical-allrepos/inlyne.svg?exclude_unsupported=1)](https://repology.org/project/inlyne/versions)\n\n### Building from Source\n\nThere are a small handful of dependencies needed to build `inlyne` from source.\nNamely\n\n1. `cargo` with a somewhat recent Rust toolchain\n   [(the relevant docs)](https://www.rust-lang.org/learn/get-started)\n2. A C-compiler\n3. (On Linux) Development libraries for `fontconfig`, `xkbcommon`, and `wayland`\n   (when the `wayland` feature flag is set)\n\nFor instance on Ubuntu `gcc` covers 2. and `libfontconfig-dev`,\n`libxkbcommon-dev` and `libwayland-dev` would cover 3.\n\n## Features\n\nOver time the features of this application will continue to grow. However there are a few\ncore features that will remain at the heart of the project.\n\n- **Browserless** - People shouldn't need electron or chrome to quickly view markdown files in a repository.\n- **GPU Powered** - Thanks to the [WGPU Project](https://github.com/gfx-rs/wgpu) rendering can and will be done\nas much on the GPU as we can get away with.\n- **Basic HTML Rendering** - HTML is used in almost all project markdown files, thus having the bare minimum html to\nsupport common use cases is necessary, but don't expect forms and buttons.\n- **Live Code Change** - Inlyne will monitor your markdown file for any write modifications and automatically refresh\nthe document where you left off. It's designed to work seamlessly and allow you to make edits on the fly.\n\n## What does it support?\n\n#### Tables\n| Super cool tables | For organising data|\n|-------------------|--------------------|\n| Favourite band    | Nickleback         |\n\n#### Sizable images\n\u003cimg src=\"https://i.redd.it/hwurhp7crzf81.png\" width = \"300\" align=\"center\"\u003e\u003c/img\u003e\n\n#### Code Blocks (with syntect highlighting)\n```rust\n// Code thats drawing this text\nlet bounds = (screen_size.0 - pos.0 - DEFAULT_MARGIN, screen_size.1);\nself.glyph_brush.queue(\u0026text_box.glyph_section(*pos, bounds));\n```\n\n#### Lists and Links\n\n\n\u003col\u003e\n    \u003cli\u003e\u003ca href=\"https://github.com/trimental/inlyne\"\u003eInlyne\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"https://github.com/gfx-rs/wgpu\"\u003eWGPU Project\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"https://github.com/nical/lyon\"\u003eLyon Project\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"https://github.com/rust-windowing/winit\"\u003eWinit Project\u003c/a\u003e\u003c/li\u003e\n\u003c/ol\u003e\n\n#### Tasklists\n\n- [x] Watch Game of Thrones\n- [ ] Feed the cat\n\n#### Hideable sections\n\u003cdetails\u003e\n\u003csummary\u003eClick me to show text\u003c/summary\u003e\n\nYou weren't supposed to see this!\n\u003c/details\u003e\n\n#### Alignment\n\u003cp align=\"left\"\u003eText/Image..\u003c/p\u003e\n\u003cp align=\"center\"\u003ealignment..\u003c/p\u003e\n\u003cp align=\"right\"\u003e:)\u003c/p\u003e\n\n#### Quote Blocks\n\n\u003e “Optimism is an occupational hazard of programming: feedback is the treatment. “ Kent Beck\n\n#### Text Effects\n\n\u003csmall\u003e\u003ci\u003e\u003cu\u003eAre these text effects ~~to~~ too **much**?\u003c/u\u003e\u003c/i\u003e Theres no such thing\u003c/small\u003e\n\n## Configuration\n\nUse `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](https://crates.io/crates/dirs) configuration folder for your respective OS:\n\n- Linux: `/home/alice/.config/inlyne/inlyne.toml`\n- Windows: `C:\\Users\\Alice\\AppData\\Roaming\\inlyne\\inlyne.toml`\n- Mac: `/Users/Alice/Library/Application Support/inlyne/inlyne.toml`\n\nCheckout `inlyne.default.toml` for an example configuration.\n\n## FAQ\n\n\n**_Is this a html markdown or html renderer?_**\n\nAll markdown files are converted to html thanks to [comrak](https://github.com/kivikakk/comrak) and rendered from there. So technically its a markdown converter and html renderer.\n\nHowever for obvious complexity reasons, inlynes only going to support enough\nhtml to get by rendering 95% of markdown files such as `\u003cbr\u003e`, `\u003ch1\u003e`, `\u003cimg\u003e`.. etc. \n\nUnforuntately things like `\u003cform\u003e` and every single css style isn't going to be in scope\n\n**_Why not use a browser or Visual Studio Code?_**\n\nYou definitely can! And it'll probably do a lot more accurate job at rendering it. \n\nHowever 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.\n\n## Contributing\n\nSend your PRs! Send your issues! Everything will help :)\n\n## License\n\nAny code that you can in this repository, you can copy under the MIT license.\n\n[MIT License](https://github.com/trimental/inlyne/blob/master/LICENSE)\n","funding_links":[],"categories":["Rust","Others"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FInlyne-Project%2Finlyne","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FInlyne-Project%2Finlyne","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FInlyne-Project%2Finlyne/lists"}