# VLOOK

**Repository Path**: tailorxX/VLOOK

## Basic Information

- **Project Name**: VLOOK
- **Description**: VLOOK™ 是针对 Typora（跨平台 Markdown 编辑器）（跨平台 Markdown 编辑器）的主题包和增强插件（针对导出的 HTML 文件）
- **Primary Language**: JavaScript
- **License**: MIT
- **Default Branch**: master
- **Homepage**: https://madmaxchow.gitee.io/vlook
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 85
- **Created**: 2022-04-26
- **Last Updated**: 2022-04-26

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

Select language ❯  [🇬🇧 **English**](README-en.md)



---

# VLOOK™ ── 让你的 Markdown 有了新看(wán)法



# 好用实用的 Typora/Markdown 主题包 与 增强插件



![VLOOK™](https://cdn.jsdelivr.net/gh/MadMaxChow/VLOOKres/pic/vlook-mark-light.svg)

**[OSCHINA (开源中国)](https://www.oschina.net/p/vlook)、[Gitee (码云)](https://gitee.com/madmaxchow/VLOOK) 推荐的国产开源项目。**



[VLOOK™](https://github.com/MadMaxChow/VLOOK) 是针对 [Typora](https://www.typora.io)（跨平台 Markdown 编辑器）的 **主题包** 和 **增强插件**。



VLOOK™ 属于开源软件，遵从 **[MIT 许可证](#许可协议)**。



> **加入讨论：**
>
> - QQ群 ([**805502564**](https://qm.qq.com/cgi-bin/qm/qr?k=oB8wpFG_4SEMf1CL9qVy-jMw0CMfSwff&jump_from=webapi&)) 
> - Issues ([**Issues**](https://github.com/MadMaxChow/VLOOK/issues))
> - 邮件 (**maxchow@qq.com**)

---



![VLOOK™ ── 让你的 Markdown 有了新看(wán)法](https://cdn.jsdelivr.net/gh/MadMaxChow/VLOOKres/pic/vlook-screenshot-A00.png)

![让你的 Markdown 文档在自动化排版、可交互性上了 N 个台阶](https://cdn.jsdelivr.net/gh/MadMaxChow/VLOOKres/pic/vlook-screenshot-A01.png)

![内置多套原创文档主题 & 字体主题，一键切换！支持私人定制！](https://cdn.jsdelivr.net/gh/MadMaxChow/VLOOKres/pic/vlook-screenshot-A02.png)

![图片排版 plus：题注、高分屏、版式、Dark 模式适配反色/替换…](https://cdn.jsdelivr.net/gh/MadMaxChow/VLOOKres/pic/vlook-screenshot-A03.png)

![表格排版 plus：单元格合并、列格式、行分组、重复表头、自动编号…](https://cdn.jsdelivr.net/gh/MadMaxChow/VLOOKres/pic/vlook-screenshot-A04.png)

![索引、逐章、逐段三种导航模式，插图/表格/媒体/代码分类索引与搜索](https://cdn.jsdelivr.net/gh/MadMaxChow/VLOOKres/pic/vlook-screenshot-A05.png)

![火力全开的演示辅助～画中画、聚光灯、激光笔、表格十字光标、刮刮卡…](https://cdn.jsdelivr.net/gh/MadMaxChow/VLOOKres/pic/vlook-screenshot-A06.png)

![所有特性完美适配 Dark 模式，你的 Markdown 变得更拉风了](https://cdn.jsdelivr.net/gh/MadMaxChow/VLOOKres/pic/vlook-screenshot-A07.png)

![还有音频、视频、标签、引用折叠、高清插图、…30+特性等你开箱即用](https://cdn.jsdelivr.net/gh/MadMaxChow/VLOOKres/pic/vlook-screenshot-A08.png)

---



# 打赏

**若喜欢 VLOOK™ 的话，可以贡献一杯咖啡 :-)**

![打赏 VLOOK™](https://cdn.jsdelivr.net/gh/MadMaxChow/VLOOKres/pic/donate-wechat-light.png?mode=frame&darksrc=donate-wechat-dark.png&srcset=@2x&darksrcset=@2x)

---



# 简介

进一步了解 VLOOK™，[点击这里开始](https://madmaxchow.github.io/VLOOK/index.html)（[备用链接](https://madmaxchow.gitee.io/VLOOK/index.html)）

---

# 安装与使用

只需三步，即可开启全新的 Markdown 体验，[点击这里开始](https://madmaxchow.github.io/VLOOK/index.html#安装与使用)（[备用链接](https://madmaxchow.gitee.io/VLOOK/index.html#安装与使用)）

---

# 快速参考手册

VLOOK™ 通过持续**挖掘和扩展** Markdown 和 CSS，并结合文档的互联网化应用场景，在 **文档排版**、**内容导航**、**演示辅助**、**交互体验** 等方面提供了 **一致**、**简洁**、**友好** 的体验。

> - 有关 VLOOK™ 特性的详细介绍、样例及使用说明详见《VLOOK™ 快速参考手册》•• [点击这里开始](https://madmaxchow.github.io/VLOOK/guide.html)（[备用链接](https://madmaxchow.gitee.io/VLOOK/guide.html)）

> - 有关脚本化图表的详细介绍、样例及使用说明详见《脚本化图表参考指南》•• [点击这里开始](https://madmaxchow.github.io/VLOOK/chart.html)（[备用链接](https://madmaxchow.gitee.io/VLOOK/chart.html)）

# 私人定制主题

目前 VLOOK™ 项目已开放了主题的 **私人定制** 服务，定制样品示例如下：

![私人定制主题](https://cdn.jsdelivr.net/gh/MadMaxChow/VLOOKres/pic/vlook-theme-vip-demo.png)

（以上仅为效果仅为样品展示，非正式定制服务成品）

私人定制主题服务微信：**MaxChow**

---



# 字体主题

「**模板主题让文档颜值倍增，而字体则是文档气质担当！**」

VLOOK™ 提供了两套字体风格，可根据个人喜好进行选用。

> **小•清•新**
>
> 整体视觉为「**清新、简约、明快**」，主要采用无衬线的免费或开源的东亚和拉丁字体。
>
> ![字体风格_小清新](https://cdn.jsdelivr.net/gh/MadMaxChow/VLOOKres/pic/小清新@2x.png)

> **文•艺•范**
>
> 整体视觉为「**优雅、韵动、个性**」，主要采用衬线、无衬线的免费或开源的东亚和拉丁字体，多种字重进行**混搭组合**。
>
> ![字体风格_文艺范](https://cdn.jsdelivr.net/gh/MadMaxChow/VLOOKres/pic/文艺范@2x.png)

**因为 Windows / MacOS 系统默认不预装字体主题配套的字体包，VLOOK™ 目前可同时支持在线和本地两种使用方式。**
**若你的工作环境无法访问互联网，建议直接下载字体包并安装到本地，以获得最佳的视觉体验。**

![蓝奏云](https://cdn.jsdelivr.net/gh/MadMaxChow/VLOOKres/pic/lanzou.png?mode=logo&srcset=@2x) •• [下载字体 ▾](https://wwe.lanzoui.com/ieVDhj1aokj)

![百度网盘](https://cdn.jsdelivr.net/gh/MadMaxChow/VLOOKres/pic/baidupan.png?mode=logo&srcset=@2x) •• [下载字体 ▾](https://pan.baidu.com/s/1gH5Hj-X3-LCaOLtN0AxLLw)（提取码 `11ta`)

---



# 目录/文件说明

| 目录/文件 | 说明                         |
| ---------- | ---------------------------- |
| [ **docs** ] | VLOOK™ 快速参考手册、官网及在线服务相关文件 |
| [ **released** ] | 发布版本的主目录          |
|    ┠─ [ **demo** ] | 基于 VLOOK™ 主题的 Markdown 示例/模板文件 |
|    ┠─ [ **theme** ] | 主题文件                     |
|    ┖─ [ **plugin** ] | 插件主目录                |
|         ┠─ plugin_live.txt | 在线版本的插件 |
|         ┖─ plugin_standalone.txt | 离线版本的插件 |
| [ **src** ] | 源码目录                     |
|    ┠─ [ **dev** ] | 开发测试用文件 |
|    ┠─ [ **less** ] | 主题 CSS 文件的源文件 |
|    ┖─ [ **logo** ] | VLOOK™ 的 logo 资源 |