开源**(OSChina.net)推荐的国产开源产品。
VLOOK™ 是针对由 Typora(目前最好的跨平台 Markdown 编辑器,没有之一)导出的 HTML 文件进行增强的插件。
VLOOK™ 为开源软件,遵从 MIT 许可证。
QQ交流群:805502564
- 针对 VLOOK 内置多套优化的主题样式(在导出 HTML 通过 Typora 的「主题」菜单选择名称以 VLOOK 打头的主题);
- 所有主题的文档导出为 HTML 后,都支持
Light (明亮)
与Dark (黑暗)
模式; - 提供主题的私人定制服务,定制样品如下:
- 主题私人定制服务微信:MaxChow
VLOOK™ 针对 Markdown 的短板,以及在实际众多的文档排版、导航、演示、交互需求中寻找平衡点,为 Markdown 的编辑者和阅读者提供了更好的使用体验。
特性分类 | 特性说明 |
---|---|
排版增强 | 封面、封底 配合主题样式,让你用 Markdown 写的文档也能焕发专业气质 |
.. | 多主题样式 让你的文档尽显个性,同时提供主题定制服务 |
.. | 标题、插图、表格、表格行支持自动编号 “0”配置,跟 Word 说 ByeBye 吧~ |
.. | 自动生成插图、表格的题注 OMG!配合插图、表格的自动编号,高效高颜值!还有独特的双题注~ |
.. | 表格单元格合并 这个是用 Markdown 人的真痛点,在这时为你提供了优雅的解决方法 |
.. | 表格列格式设置 Markdown 的表格也能快速设置列的格式(如加粗、高亮、斜体、下划线),同样为你提供了优雅的解决方法 |
.. | 彩虹标签 可自定义多个配色的标签、双标签,让你的 Markdown 文档排版更专业、更标准化 |
.. | mermaid 样式优化 全面深度优化 mermaid 图,并提供补丁修正其跨平台的兼容性问题 |
.. | 统一多级列表自动编号 将多级有序、无序列表的编号进行了统一,以更聚焦内容的结构化 |
.. | 任务列表支持自动编号 让任务列表和多级列表的自动编号两者兼得 |
文档导航 | 大纲导航 最为熟悉和常用的文档导航方式,支持折叠 |
.. | 逐章导航 在长文档中特别好用,随时眯一眼就知道当前章节、上/下章节是什么了 |
.. | 逐段导航 这个很 GEEK,可以通过键盘按文档的逐段进行浏览,习惯用 VI / VIM 的人应该会欢呼! |
.. | 文档插图浏览器 让你快速在快速浏览文档的所有插图,并能直接跳到文档中对应的位置 |
演示辅助 | 聚光灯模式 太COOL了!在投影时可以让大家快速聚焦在关键内容上了(S激活,⇧ Shift调节大小) |
.. | 表格十字光标 方便你与大家讨论长表格、大表格时,快速聚焦指定单元格,及对应的行和列 |
.. | 在新标签打开插图、表格、代码块 在长文档中的来回翻页查看插图、表格、代码示例是很崩溃的事,现在你可以让它们在浏览器的不同标签中显示了 |
内容互动 | 代码块增强 在这你会发现连闷*的代码都透着动感,高亮当行、复制~ |
.. | 引用内容可设置为折叠 引用内容很长很多?现在可以指定是否默认收起,读者点击才展示引用内容……在 VLOOK 的加持下,这里都不是事 |
.. | 长内容自动折叠 长图、长表格、长代码会占用太多屏幕空间?现在可以统统自动折叠,静待你的二维展开指令 |
.. | 文档内容检查 文档中的页内链接、图片链接失效了,现在 VLOOK 会悄悄告诉你的 |
.. | 更友好的脚注查看方式 用 Markdown 也可以像 Kindle 那样以弹窗方式来看脚注 |
视觉与交互 | Dark 模式 这个不用多说了,懂的人都会喜欢。也可手动切换回标准的 Light 模式 |
.. | 多字体样式 AMAZING! 不同的字体风格为你的文档带来不同的调性~ |
.. | 更美观的公式 让你的各种公式长得与 VLOOK 的不同主题更搭 |
.. | 打印样式适配 使用 VLOOK 提供的打印按钮,确保打印输出的文档样式保持与日常文档更接近 |
.. | 快捷键操作 支持键盘快捷键操作,又可以再装个逼了~ |
.. | 七语种界面 界面提示说明、题注前缀等内容,均支持:简/繁/英/法/俄/日/韩(依赖于浏览器的当前语言设置) |
环境要求:VLOOK V9.5+,Typora mac版 V0.9.9.31+ / Win版 V0.9.83+
* 提示 *
以下网页都是由 Typora 和 VLOOK 共同编辑和生成的,所有的功能特性和样式你都能直接体验。
有关 VLOOK 特性的详细介绍、样例及使用说明详见《VLOOK 快速参考手册》,国内链接
有关脚本化图表的详细介绍、样例及使用说明详见《脚本化图表 for Markdown》,国内链接
- 访问官方主页下载最新发布版本:GitHub (主站) OSChina (备用)
- 下载并安装 Typora ,启动后进入「偏好设置」,启用一些建议的选项,详细如下图:
- 将
released\theme
下所有CSS文件复制至 Typora 的主题目录( Typora「偏好设置」中点击「外观 - 打开主题目录」定位到该目录); - 重启 Typora ,点击菜单
主题
,选择以vlook-*
形式命名的主题,即可启用对应的 VLOOK 主题样式; - 可基于
VLOOK\3-demo\VLOOK-Template 文档模板.md
来创建你自己的文档,VLOOK\3-demo
目录下也有本文档的 Markdown 源文件。
- 在 Typora 中将 Markdown 文件导出为
HTML
文件; - 打开文件
released\VLOOK-TOOLBOX 插件.txt
,全选所有内容,并复制; - 用纯文件编辑器,如:记事本、Visual Studio Code,打开该导出的 HTML 文件;
- 搜索「<body 」,并将复制的内容粘贴到body标签的「>」之后:
<body ...> ← ← ← ← ← 复制的「VLOOK-TOOLBOX 插件」内容粘贴于此! ... </body>
- 保存,大吉大利。
强烈建议使用 Chrome 或 Firefox 浏览器查看
VLOOK 优先显示开源的思源黑体和思源宋体,建议下载安装获得更好的视觉体验;
目录 | 说明 |
---|---|
VLOOK | |
└ 2-released | 发布版的主目录 |
└ theme | 主题文件 |
└ 3-demo | 基于 VLOOK 主题的示例、模板文件 |
└ 4-src | 源码目录 |
└ dev | 开发测试用示例文件 |
└ less | 主题 CSS 文件的源文件 |
└ misc | 杂项文件,包括图标源文件、产品原型、主题图形素材设计源文件等 |
└ docs | VLOOK 快速参考手册及相关文档 |
VLOOK ™ is a plugin that enhances HTML files exported by Typora (currently the best cross-platform Markdown editor, none of them).
VLOOK ™ is open source software and is under the MIT license.
VLOOK ™ targets Markdown's shortcomings, and finds a balance among the actual numerous document layout, navigation, presentation, and interaction needs, providing a better experience for Markdown editors and readers.
For detailed introduction, examples and instructions on VLOOK features "VLOOK Quick Reference Manual".
For detailed introduction, examples and instructions on scripted charts, please refer to "Scripted Charts for Markdown"