# VLOOK
**Repository Path**: madmaxchow/VLOOK
## Basic Information
- **Project Name**: VLOOK
- **Description**: VLOOK™ 是优雅好用的 Typora/Markdown 主题包和增强插件。
VLOOK™ is an elegant and practical theme package × enhancement plugin for Typora/Markdown.
- **Primary Language**: JavaScript
- **License**: MIT
- **Default Branch**: master
- **Homepage**: https://madmaxchow.github.io/VLOOK/
- **GVP Project**: No
## Statistics
- **Stars**: 608
- **Forks**: 85
- **Created**: 2019-10-30
- **Last Updated**: 2025-08-26
## Categories & Tags
**Categories**: markdown-utils
**Tags**: Markdown, Typora, 文档, Frontend, editor
## README
Select language ❯ [**English**](README-en.md) • 中文
[](https://github.com/MadMaxChow/VLOOK/releases) [&labelColor=04B1CC&color=9A4EE6)](https://github.com/MadMaxChow/VLOOK/releases)
---
# VLOOK™ ── 让你的 Markdown 有了新看(wán)法
# 优雅好用的 Typora/Markdown 主题包×增强插件
[VLOOK™](https://github.com/MadMaxChow/VLOOK) 是针对 [Typora](https://www.typora.io)（跨平台 Markdown 编辑器）的 **主题包** 和 **增强插件**。
VLOOK™ 属于开源软件（遵从 **[MIT 许可证](#许可协议)**）。
你是否也厌倦了 Markdown 文档千篇一律的排版和体验？VLOOK™ 在保持 Markdown 优雅的同时，还能让你编写的文档焕然一新。
在 **文档排版**、**内容标记**、**内容导航**、**演示辅助**、交互体验 等方面提供了 **一致**、**简洁**、**友好** 的体验。
只需简单几步的安装配置，你也可以拥有主题炫酷、排版丰富、交互友好的文档～
> - Typora 官方认可支持的主题包和增强插件，详见 [Typora Support - Export](https://support.typora.io/Export/#example-export-using-vlook)
> - [OSCHINA (开源中国)](https://www.oschina.net/p/vlook) 推荐的国产开源项目
>
> 
---
> **加入讨论与交流**
>
> - 💬 QQ 群 ([**805502564**](https://qm.qq.com/q/O0tNC6WBWe&))
> - ✈️ Telegram Channel ([**vlook_markdown**](https://t.me/vlook_markdown "加入 Telegram 频道"))
> - 📨 邮件 (**maxchow@qq.com**)
# 打赏
> **感谢打赏支持 VLOOK™ 的客官（部分名单）**
>
> **Peter**、**绿邃清幽**、**李导996**、**fanky**、**＊丽**、**杨琛**、**＊哦**、**＊豫**、**l＊a**、**＊o**、K＊y、行川、＊山、＊魂、＊狗、＊R、＊Z、＊川、l＊n、＊朽、＊杰、A＊C、W＊l、＊山、J＊o、韩宗辉、＊星、一叶知秋、d＊、＊军、＊鹏、＊无、H＊t、＊二、＊宇、＊辉、＊秋、＊笑、＊心、整＊9、＊国、＊哥、乌拉、＊龙、远方眼前、＊应、＊销、E＊y、…
| **若喜欢 VLOOK™ 的话，可以贡献一杯咖啡** | **I like VLOOK™, I donate a cup of coffee** |
| :----------------------------------------------------------: | :----------------------------------------------------------: |
|  | [](https://paypal.me/madmaxchow) |
---
[
📺 点击这里观看官宣视频](https://www.bilibili.com/video/BV1miDpY5ERh/?vd_source=ecc3f6f8f7d9fbfaa5745863cf7d6250)
---
---
# 简介
进一步了解 VLOOK™，[点击这里开始](https://madmaxchow.github.io/VLOOK/index.html)（[备用链接](https://vlook-doc.pages.dev/index.html)）
---
# 安装与使用
只需三步，即可开启全新的 Markdown 体验，[点击这里开始](https://madmaxchow.github.io/VLOOK/index.html#安装与使用)（[备用链接](https://vlook-doc.pages.dev/index.html#安装与使用)）
---
# 专题文章
入选「知乎 • 海盐计划」的专题文章 •• [点击前往看看](https://www.zhihu.com/people/maxchow/posts)
---
# 范例参考
[](https://madmaxchow.github.io/VLOOK/sample-a-api_spec.html?ws=off) [](https://madmaxchow.github.io/VLOOK/sample-a-to_do.html?ws=off) [](https://madmaxchow.github.io/VLOOK/sample-a-img_text.html?ws=off) [](https://madmaxchow.github.io/VLOOK/sample-a-routes.html?ws=off) [](https://madmaxchow.github.io/VLOOK/sample-a-board.html?ws=off) [](https://madmaxchow.github.io/VLOOK/sample-a-quiz.html?ws=off)
---
# 快速参考手册
有关 VLOOK™ 特性的详细介绍、样例及使用说明详见《VLOOK™ 快速参考手册》：
• **基础** • [点击这里开始](https://madmaxchow.github.io/VLOOK/guide.html)（[备用链接](https://vlook-doc.pages.dev/guide.html)）
▲ **进阶** ▲ [点击这里开始](https://madmaxchow.github.io/VLOOK/guide2.html)（[备用链接](https://vlook-doc.pages.dev/guide2.html)）
★ **探索** ★ [点击这里开始](https://madmaxchow.github.io/VLOOK/guide3.html)（[备用链接](https://vlook-doc.pages.dev/guide3.html)）
> 有关脚本化图表的详细介绍、样例及使用说明详见《脚本化图表参考指南》••• [点击这里开始](https://madmaxchow.github.io/VLOOK/chart.html)（[备用链接](https://vlook-doc.pages.dev/chart.html)）
# 品牌周边
## 墙纸
（与官方主题同款，附有 **常用语法**、**色号** 的参考）
选择需要的分辨率版本：
- [1336 × 768](https://vlook-doc.pages.dev/pic/VLOOK-wallpaper-1336x768.png)
- [1440 × 900](https://vlook-doc.pages.dev/pic/VLOOK-wallpaper-1440x900.png)
- [1920 × 1080](https://vlook-doc.pages.dev/pic/VLOOK-wallpaper-1920x1080.png)
- [2560 × 1440](https://vlook-doc.pages.dev/pic/VLOOK-wallpaper-2560x1440.png)
- [2560 × 1600](https://vlook-doc.pages.dev/pic/VLOOK-wallpaper-2560x1600.png)
---
## 实物周边
（与官方主题同款，附有 **常用语法**、**色号** 的参考）
【 **[我要选购 - 鼠标垫](https://m.tb.cn/h.hZv7kfL?tk=Q2KVVJAuOVI)** 】
【 **[我要选购 - 桌面垫（键盘 & 鼠标垫）](https://m.tb.cn/h.hZv7kfL?tk=Q2KVVJAuOVI)** 】
---
# 增值服务
## 主题定制服务
目前现已开放主题的「**定制服务**」，以下为部分定制案例参考：
[](https://madmaxchow.github.io/VLOOK/vip.html)
（针对高校的学生/教师，提供定制主题的教育优惠政策，具体请在定制需求中注明就读学校和身份）
【 **更多定制主题展示 •• [了解更多](https://madmaxchow.github.io/VLOOK/vip.html)** 】
## 插件功能定制服务
针对你更个性的文档排版、交互、发布等方面需要，提供插件功能的定制服务～
【 **[咨询沟通](https://madmaxchow.github.io/VLOOK/vip.html#咨询我们)** 】
## 排版编辑服务
针对你文档的内容、受众，充分应用 Typora + VLOOK 在 版式设计、内容标记、多文档组织、演示与出版辅助 等众多特性，提供 **文档排版**、**内容修订**、**知识库搭建**、**出版指导**、**站点托管**、**发布 HTML** 等服务。
【 **更多增值服务内容介绍 •• [了解更多](https://madmaxchow.github.io/VLOOK/vip.html)** 】
---
# 目录/文件说明
| 目录/文件 | 说明 |
| ---------- | ---------------------------- |
| [ **docs** ] | VLOOK™ 快速参考手册、官网及在线服务相关文件 |
| [ **released** ] | 发布版本的主目录 |
| ┠─ [ **docs** ] | VLOOK™ 快速参考手册 markdown 源文件 |
| ┠─ [ **themes** ] | 默认配套的主题文件 |
| ┠─ [ **samples** ] | 推荐的各种 Markdown 范例文档 |
| ┖─ [ **plugin** ] | 插件主目录 |
| ┠─ [ **lang** ] | 在导出配置中使用的语言包 |
| ┠─ meta.txt | Typora 导出 HTML 配置 `... ` 的内容 |
| ┠─ plugin_live.txt | 在线版本的插件 |
| ┖─ plugin.txt | Typora 导出 HTML 配置 `...