# VLOOK
**Repository Path**: iscar/VLOOK
## Basic Information
- **Project Name**: VLOOK
- **Description**: VLOOK™ 是针对由 Typora（目前最好的跨平台 Markdown 编辑器，没有之一）导出的 HTML 文件进行增强的插件
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 0
- **Forks**: 86
- **Created**: 2020-07-22
- **Last Updated**: 2020-12-19
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
# 「 **VLOOK™ ── 让你的 Markdown 有了新看法** 」
**开源中国（[OSChina.net](https://www.oschina.net/p/vlook)）推荐的国产开源产品。**
[VLOOK™](https://github.com/MadMaxChow/VLOOK) 是针对由 [Typora](https://www.typora.io)[^Typora]（目前最好的跨平台 Markdown 编辑器，没有之一）导出的 HTML 文件进行增强的插件。
VLOOK™ 也许是目前最好的 Markdown 增强插件之一，也是**开源中国（[OSChina.net](https://www.oschina.net/p/vlook)）推荐的国产开源产品。**
VLOOK™ 属于开源软件，遵从 **[MIT 许可证](#许可协议)**。
**QQ交流群：805502564**
---
---
# 内置多套高颜值实用的主题
VLOOK™ 已为你内置了多套原创、独具风格的主题样式，能满足日常大多不同的应用场景和视觉偏好：
- **Hope 海洋之心**：[预览 ＞](https://madmaxchow.github.io/VLOOK/theme-hope.html)
- **Joint 榫卯**：[预览 ＞](https://madmaxchow.github.io/VLOOK/theme-joint.html)
- **Geek 极邃**：[预览 ＞](https://madmaxchow.github.io/VLOOK/theme-geek.html)
- **Fancy 慕幻**：[预览 ＞](https://madmaxchow.github.io/VLOOK/theme-fancy.html)
- **Thinking 静思**：[预览 ＞](https://madmaxchow.github.io/VLOOK/theme-thinking.html)
---
## 主题私人定制服务
目前 VLOOK™ 项目也现已开放了主题的 **私人定制** 服务，定制样品示例如下：
（以上仅为效果仅为定制样品示例，非正式定制服务成品）
主题私人定制服务微信：**MaxChow**
---
## 快速参考手册
**以下网页都是由 Typora 和 VLOOK™ 共同编辑和生成的，所有的功能特性和样式你都能直接体验。**
• 有关 VLOOK™ 特性的详细介绍、样例及使用说明详见《[VLOOK™ 快速参考手册](https://madmaxchow.github.io/VLOOK/index.html)》，[国内链接](https://madmaxchow.gitee.io/vlook/index.html)
• 有关脚本化图表的详细介绍、样例及使用说明详见《[脚本化图表参考指南](https://madmaxchow.github.io/VLOOK/chart.html)》，[国内链接](https://madmaxchow.gitee.io/vlook/chart.html)
---
## 特性清单
VLOOK™ 充分挖掘和扩展了 Markdown 和 Typora 的语法和功能，并结合现代网络化的文档编辑和出版中涉及的文档的 **格式排版**、**文档导航**、**演示辅助**、**内容交互** 等方面的需求，为你提供基于 Markdown 的文档编辑、文档发布、文档阅读者提供 **一致**、**简洁**、**友好** 的体验。
| VLOOK™ 的特性及简介 |
| ------------------------------------------------------------ |
| **一、排版增强** |
| **封面、封底**
配合主题样式，让你用 Markdown 写的文档也能焕发专业气质 |
| **多主题样式**
让你的文档尽显个性，同时提供主题定制服务 |
| **标题、插图、表格、表格行支持自动编号**
“0”配置，跟 Word 说 ByeBye 吧～ |
| **自动生成插图、表格、代码块的题注**
OMG！配合插图、表格的自动编号，高效高颜值！还有独特的双题注～ |
| **表格单元格合并**
这个是用 Markdown 人的真痛点，在这时为你提供了优雅的解决方法 |
| **表格列格式设置**
Markdown 的表格也能快速设置列的格式（如加粗、高亮、斜体、下划线），同样为你提供了优雅的解决方法 |
| **彩虹标签**
可自定义多个配色的标签、双标签，让你的 Markdown 文档排版更专业、更标准化 |
| **mermaid 样式优化**
全面深度优化 mermaid 图表，并提供补丁修正其跨平台的兼容性问题 |
| **图片反色、增加边缘空白**
可指定在 Dark 模式时反色，还能增加边缘空白，让图片的呈现更和谐、阅读体验更佳 |
| **统一多级列表自动编号**
将多级有序、无序列表的编号进行了统一，以更聚焦内容的结构化 |
| **任务列表支持自动编号**
让任务列表和多级列表的自动编号两者兼得 |
| **二、文档导航** |
| **大纲导航**
最为熟悉和常用的文档导航方式，支持折叠 |
| **逐章导航**
在长文档中特别好用，随时眯一眼就知道当前章节、上/下章节是什么了 |
| **逐段导航**
这个很 GEEK，可以通过键盘按文档的逐段进行浏览，习惯用 VI / VIM 的人应该会欢呼！ |
| **插图导航**
让你快速在快速浏览文档的所有插图，并能直接跳到文档中对应的位置 |
| **三、演示辅助** |
| **聚光灯**
太COOL了！在投影时可以让大家快速聚焦在关键内容上了 |
| **表格十字光柱**
方便你与大家讨论长表格、大表格时，快速聚焦指定单元格，及对应的行和列 |
| **在新标签打开插图、表格、代码块**
在长文档中的来回翻页查看插图、表格、代码示例是很崩溃的事，现在你可以让它们在浏览器的不同标签中显示了 |
| **四、内容互动** |
| **支持音频、视频**
你的 Markdown 文档从此可以看视频、听音频了，音频还支持迷你模式，应用的潜力等你来发挥～ |
| **代码块增强**
在这你会发现连闷骚的代码都透着动感，高亮当行、复制～ |
| **引用内容可设置为折叠**
引用内容很长很多？现在可以指定是否默认收起，读者点击才展示引用内容……在 VLOOK™ 的加持下，这里都不是事 |
| **长内容自动折叠**
长图、长表格、长代码会占用太多屏幕空间？现在可以统统自动折叠，静待你的二维展开指令 |
| **文档内容检查与优化**
文档中的页内链接、图片链接失效了，现在 VLOOK™ 会悄悄告诉你的 |
| **更友好的脚注**
用 Markdown 也可以像 Kindle 那样以弹窗方式来看脚注 |
| **五、视觉与交互** |
| **Dark 模式**
这个不用多说了，懂的人都会喜欢。也可手动切换回标准的 Light 模式 |
| **字体风格选择**
AMAZING! 不同的字体风格为你的文档带来不同的调性～ |
| **更美观的公式**
让你的各种公式长得与 VLOOK™ 的不同主题更搭 |
| **打印样式适配**
使用 VLOOK™ 提供的打印功能，确保文档样式适合商务办公场景下的打印输出 |
| **快捷键操作**
支持键盘快捷键操作，又可以再装个逼了～ |
| **跨平台支持**
能自适应在 PC 、平板、手机上进行浏览 |
| **自动识别链接类型**
自动识别对文档的内部链接、外部链接，鼠标在链接上悬停时通过不同的角标图示进行区分 |
| **七语种界面**
界面提示说明、题注前缀等内容，均支持：**简/繁/英/法/俄/日/韩**（依赖于浏览器的当前语言设置） |
环境要求：Typora（macOS版 V0.9.9.31+ / Win版 V0.9.83+）
---
# 第1步：下载、配置
- 访问官方主页下载最新发布版本：[GitHub (主站)](https://github.com/MadMaxChow/VLOOK/releases) [OSChina (备用)](https://www.oschina.net/p/vlook)
- 下载并安装 [Typora](https://www.typora.io) ，启动后进入「偏好设置」，启用一些建议的选项，详细如下图：
# 第2步：应用主题
+ 将`released\theme`下所有CSS文件复制至 Typora 的主题目录（ Typora「偏好设置」中点击「外观 - 打开主题目录」定位到该目录）；
+ 重启 Typora ，点击菜单`主题`，选择以`vlook-*`形式命名的主题，即可启用对应的 VLOOK™ 主题样式；
+ 可基于`released`下的`文档模板-Template.md` 为模板来创建你自己的 Markdown 文档。
# 第3步：植入插件
+ 在 Typora 中将 Markdown 文件导出为`HTML`文件；
+ 打开文件`released\VLOOK-plugin-for-Typora.txt`，全选所有内容，并复制；
+ 用纯文件编辑器，如：记事本、[Visual Studio Code](https://code.visualstudio.com/)，打开该导出的 HTML 文件；
+ 搜索「****」之后：
```
← ← ← ← ← 将「VLOOK-plugin-for-Typora.txt」文件的内容粘贴于此！
...
```
+ 保存，大吉大利。
> 强烈建议使用 Chrome、Firefox、Edge 浏览器访问
---
# 字体
支持 **衬线** 与 **非衬线** 两套字体风格，可根据个人喜好进行切换，后续将会引入更多字体风格。
衬线与非衬线分别优先使用开源的 **思源黑体** 和 **思源宋体**，建议下载安装获得最佳的视觉体验。
- 思源黑体 / Noto Sans（[常规体](https://github.com/googlefonts/noto-cjk/blob/master/NotoSansCJKsc-Regular.otf)、[粗体](https://github.com/googlefonts/noto-cjk/blob/master/NotoSansCJKsc-Bold.otf)）
- 思源宋体 / Noto Serif（[常规体](https://github.com/googlefonts/noto-cjk/blob/master/NotoSerifCJKsc-Regular.otf)、[粗体](https://github.com/googlefonts/noto-cjk/blob/master/NotoSerifCJKsc-Bold.otf)）
---
# 打赏
**若喜欢 VLOOK™ 的话，可以请 Max 喝杯咖啡：**
---
# 目录说明
| 目录 | 说明 |
| ---------- | ---------------------------- |
| ┠─ [**docs**] | VLOOK™ 快速参考手册及相关文档 |
| ┠─ [**released**] | 发布版本的主目录 |
| ┠─ [**demo**] | 基于 VLOOK™ 主题的 Markdown 示例文件 |
| ┠─ [**logo**] | VLOOK™ 的 Logo |
| ┠─ [**theme**] | 主题文件 |
| ┠─ Font.txt | 推荐的字体说明及下载地址 |
| ┠─ VLOOK-plugin-for-Typora.txt | VLOOK™ 插件 |
| ┖─ 文档模板-Template.md | VLOOK™ 文档模板，用来创建属于你自己的 Markdown 文档 |
| ┠─ [**src**] | 源码目录 |
| ┠─ [**dev**] | 开发测试用文件 |
| ┠─ [**less**] | 主题 CSS 文件的源文件 |
| ┖─ [**misc**] | 杂项文件，包括图标源文件、产品原型、主题图形素材设计源文件等 |