Inlyne - 一个由GPU驱动、无需浏览器、markdown + html查看器

inlyne README.md --theme dark/light

关于

Markdown文件是一种将格式化、视觉上吸引人的信息以最小方式呈现给人们的优秀工具。但是，9成情况下，你需要一个完整的网页浏览器来快速打开文件...

介绍 Inlyne，一个由GPU驱动且无需浏览器的工具，助您迅速查看markdown文件 👀。

安装

inlyne 已存在于几个不同的软件包仓库中。安装应该非常简单，因为 大多数 事情都预先打包。

从源码构建

构建 inlyne 需要一些依赖项。具体来说

1. cargo 与一个相对较新的 Rust 工具链 (相关文档)
2. C 编译器
3. (在Linux上) fontconfig、xkbcommon 和 wayland 的开发库（当设置 wayland 功能标志时）

例如，在Ubuntu上，gcc 覆盖了2，而 libfontconfig-dev、libxkbcommon-dev 和 libwayland-dev 则涵盖了3。

特性

随着时间的推移，该应用程序的特性将继续增长。然而，有一些核心特性将始终是该项目的核心。

• 无需浏览器 - 人们不需要electron或chrome来快速查看存储库中的markdown文件。
• GPU驱动 - 多亏了 WGPU项目，渲染将尽可能在GPU上完成。
• 基本HTML渲染 - 几乎所有的项目markdown文件都使用HTML，因此支持常见用例的HTML是必要的，但不要期望有表单和按钮。
• 实时代码更改 - Inlyne会监视您的markdown文件中的任何写入修改，并自动刷新您离开的地方的文档。它旨在无缝工作，并允许您即时进行编辑。

它支持什么？

表格

大尺寸图片

代码块（带有语法高亮）

// Code thats drawing this text
let bounds = (screen_size.0 - pos.0 - DEFAULT_MARGIN, screen_size.1);
self.glyph_brush.queue(&text_box.glyph_section(*pos, bounds));

列表和链接

1. Inlyne
2. WGPU项目
3. Lyon项目
4. Winit项目

任务列表

• 观看权力的游戏
• 喂猫

可隐藏部分

对齐

文本/图片...

对齐...

:)

引用块

“乐观是编程的职业病：反馈是治疗方法。” - Kent Beck

文本效果

这些文本效果是否太多？ 没有这样的事情

配置

使用inlyne --help查看所有命令行选项。其中一些可以通过在默认的dirs配置文件夹中的inlyne目录内放置一个inlyne.toml文件来永久设置

• Linux: /home/alice/.config/inlyne/inlyne.toml
• Windows: C:\Users\Alice\AppData\Roaming\inlyne\inlyne.toml
• Mac: /Users/Alice/Library/Application Support/inlyne/inlyne.toml

查看inlyne.default.toml以获取示例配置。

常见问题解答

这是HTML markdown还是HTML渲染器？

所有markdown文件都通过comrak转换为HTML并从那里渲染。所以从技术上讲，它是一个markdown转换器和HTML渲染器。

然而，由于明显的复杂性原因，Inlyne仅支持足够的HTML来渲染95%的markdown文件，例如<br>、<h1>、<img>等等。

不幸的是，像<form>和每个单独的CSS样式都不在范围内

为什么不使用浏览器或Visual Studio Code？

当然可以！它可能还会在渲染方面做得更准确。

但是，有一个可以快速打开您vim设置中那个文件的程序不是很好吗？我想把它看作是macOS预览或Adobe Acrobat的markdown版本。

贡献

发送您的PR！发送您的问题！一切都将有所帮助 :)

许可证

您可以在本存储库中找到的任何代码，您都可以在MIT许可证下复制。

MIT许可证