# 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**: 614 - **Forks**: 86 - **Created**: 2019-10-30 - **Last Updated**: 2026-02-02 ## Categories & Tags **Categories**: markdown-utils **Tags**: Markdown, Typora, 文档, Frontend, editor ## README Select language ❯ English • [**中文**](README.md) [![Latest Version](https://img.shields.io/github/v/release/MadMaxChow/VLOOK?style=for-the-badge&label=Release&labelColor=04B1CC&color=9A4EE6)](https://github.com/MadMaxChow/VLOOK/releases) [![Downloads](https://img.shields.io/github/downloads/MadMaxChow/VLOOK/total?style=for-the-badge&label=Downloads%20(since%20V28.1)&labelColor=04B1CC&color=9A4EE6)](https://github.com/MadMaxChow/VLOOK/releases) --- # VLOOK™ ── Give Your Markdown a New Perspective # VLOOK™ is an elegant and practical THEME PACKAGE × ENHANCEMENT PLUGIN for Typora/Markdown ![VLOOK™](https://vlook-doc.pages.dev/pic/vlook-mark-light.svg) [VLOOK™](https://github.com/MadMaxChow/VLOOK) is for [Typora](https://www.typora.io) (cross-platform Markdown editor) of the **THEME PACKAGE** and **ENHANCED PLUG-IN**. VLOOK™ is open source software and complies with the **[MIT license](#许可协议)**. Are you also tired of the monotonous layout and experience of Markdown documents? While maintaining the elegance of Markdown, VLOOK™ can also give a brand-new look to the documents you write. It provides a **consistent**, **concise**, and **user-friendly** experience in aspects such as **document layout**, **content marking**, **content navigation**, **presentation assistance**, and interactive experience. With just a few simple steps of installation and configuration, you can also have documents with cool themes, rich layouts, and a friendly interaction! > - It is also Typora - recognized and supported theme pack and enhanced plugin, for details: [Typora Support - Export](https://support.typora.io/Export/#example-export-using-vlook) > - [OSChina](https://www.oschina.net/p/vlook) recommended domestic open source products > - [AtomGit](https://atomgit.com/maxchou/VLOOK) **G-Star** Project ![star VLOOK](https://atomgit.com/MadMaxChow/VLOOK/star/badge.svg#icon) > > VLOOK - THEME PACKAGE × ENHANCEMENT PLUGIN for Typora/Markdown | Product Hunt Featured｜HelloGitHub --- > **Discussion and Communication** > > - [![X/Twitter](https://vlook-doc.pages.dev/pic/x.png)](https://x.com/MadMaxChow) [![YouTube](https://vlook-doc.pages.dev/pic/youtube.png)](https://www.youtube.com/@MadMaxChow) [![Medium](https://vlook-doc.pages.dev/pic/medium.png)](https://medium.com/@zmzusa) > - ✈️ Telegram Channel ([**vlook_markdown**](https://t.me/vlook_markdown "加入 Telegram 频道")) > - 📨 Email (**maxchow@qq.com**) > - 💬 QQ Group ([**805502564**](https://qm.qq.com/q/O0tNC6WBWe&)) # Donate > **Thanks for donate VLOOK™ (partial donors) ** > > **Peter**、**绿邃清幽**、**李导996**、**fanky**、**＊丽**、**杨琛**、**＊哦**、**＊豫**、**l＊a**、**＊o**、ocean、swingingroi、＊胡、K＊y、行川、＊药、＊山、＊魂、＊士、＊狗、＊R、＊Z、＊川、l＊n、＊朽、＊杰、A＊C、W＊l、＊山、J＊o、韩宗辉、＊星、一叶知秋、d＊、＊军、＊鹏、＊无、H＊t、＊二、＊宇、＊辉、＊秋、＊笑、＊心、整＊9、＊国、＊哥、乌拉、＊龙、远方眼前、＊雩、＊应、＊销、E＊y、… | **Your coffee
keeps VLOOK™ running ☕️** | **你的咖啡，能让 VLOOK™ 保持活力 ☕️** | | :----------------------------------------------------------: | :----------------------------------------------------------: | | [![打赏 VLOOK™](https://vlook-doc.pages.dev/pic/donate-paypal-light.png)](https://paypal.me/madmaxchow) | ![打赏 VLOOK™](https://vlook-doc.pages.dev/pic/donate-wechat-light.png)![打赏 VLOOK™](https://vlook-doc.pages.dev/pic/donate-alipay-light.png) | --- [![优雅好用的Typora-Markdown主题×插件VLOOK™，让你的文档有了新看法让你的文档有了新看法～-封面](https://github.com/user-attachments/assets/08b0386e-bdaf-4aa4-a4dc-a04dd800ed11)
📺 Click here to watch the introduction video](https://www.bilibili.com/video/BV1miDpY5ERh/?vd_source=ecc3f6f8f7d9fbfaa5745863cf7d6250) --- ![VLOOK™ ── 让你的 Markdown 有了新看(wán)法](https://vlook-doc.pages.dev/pic/vlook-screenshot-b01-en.png) ![VLOOK™ ── 让你的 Markdown 有了新看(wán)法](https://vlook-doc.pages.dev/pic/vlook-screenshot-b02-en.png) ![VLOOK™ ── 让你的 Markdown 有了新看(wán)法](https://vlook-doc.pages.dev/pic/vlook-screenshot-b03-en.png) --- # Introduction Learn more about VLOOK™, [click here to start](https://madmaxchow.github.io/VLOOK/index-en.html) ( [alternative link](https://vlook-doc.pages.dev/index-en.html) ) # How To Use You can start a brand **new Markdown experience** in just **3 steps**, [click here to start](https://madmaxchow.github.io/VLOOK/index-en.html#how-to-use) ( [alternative link](https://vlook-doc.pages.dev/index-en.html#how-to-use) ) --- # Blog ![Blogs selected for the "Zhihu • Sea Salt Project"](https://vlook-doc.pages.dev/pic/3rd-haiyan.png#logo#border) Blogs selected for the "**Zhihu • Sea Salt Project**" •• [Go go go](https://www.zhihu.com/people/maxchow/posts) --- # Samples [![Click to see ...](https://vlook-doc.pages.dev/pic/sample-a-api_spec-en.png)](https://madmaxchow.github.io/VLOOK/sample-a-api_spec.html?ws=off) [![Click to see ...](https://vlook-doc.pages.dev/pic/sample-a-to_do-en.png)](https://madmaxchow.github.io/VLOOK/sample-a-to_do.html?ws=off) [![Click to see ...](https://vlook-doc.pages.dev/pic/sample-a-img_text-en.png)](https://madmaxchow.github.io/VLOOK/sample-a-img_text.html?ws=off) [![Click to see ...](https://vlook-doc.pages.dev/pic/sample-a-board-en.png)](https://madmaxchow.github.io/VLOOK/sample-a-routes.html?ws=off) [![Click to see ...](https://vlook-doc.pages.dev/pic/sample-a-quiz-en.png)](https://madmaxchow.github.io/VLOOK/sample-a-board.html?ws=off) [![Click to see ...](https://vlook-doc.pages.dev/pic/sample-a-routes-en.png)](https://madmaxchow.github.io/VLOOK/sample-a-quiz.html?ws=off) --- # Quick Reference Manual For detailed introduction, samples and instructions of VLOOK™ features, please refer to "VLOOK™ Quick Reference Manual": • **Basic** • [View](https://madmaxchow.github.io/VLOOK/guide-en.html) ([alternative link](https://vlook-doc.pages.dev/guide-en.html)) ▲ **Advanced** ▲ [View](https://madmaxchow.github.io/VLOOK/guide2-en.html) ([alternative link](https://vlook-doc.pages.dev/guide2-en.html)) ★ **Exploration** ★ [View](https://madmaxchow.github.io/VLOOK/guide3-en.html) ([alternative link](https://vlook-doc.pages.dev/guide3-en.html)) > For detailed introduction, samples and usage instructions of scripted charts, please refer to "Scripted Charts Reference Guide"••• [View](https://madmaxchow.github.io/VLOOK/chart.html) ([alternative link](https://vlook-doc.pages.dev/chart.html)) --- # Brand Merchandise ## Wallpaper ( The same style as the official theme, with references to **Common Grammar** and **Color Codes** ) ![VLOOK™ Wallpaper](https://vlook-doc.pages.dev/pic/VLOOK-wallpaper-preview.png) Choose the required resolution version: - [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) - [3840 × 2160](https://vlook-doc.pages.dev/pic/VLOOK-wallpaper-3840x2160.png) ## Physical Products ( The same style as the official theme, with references to **Common Grammar** and **Color Codes** ) ![Mouse Pad](https://vlook-doc.pages.dev/pic/pad_mouse-25x30-preview.png) 【 **[I Want - Mouse Pad](https://m.tb.cn/h.hZv7kfL?tk=Q2KVVJAuOVI)** 】 ![Desk Pad (Keyboard & Mouse Pad)](https://vlook-doc.pages.dev/pic/pad_desk-30x70-preview.png) 【 **[I Want - Desk Pad (Keyboard & Mouse Pad)](https://m.tb.cn/h.hZv7kfL?tk=Q2KVVJAuOVI)** 】 --- # Premium Services ## Theme Customization Service The "**Private Customization Service**" for Themes is now open! Here are some reference cases for private customization. [![定制主题](https://vlook-doc.pages.dev/pic/vlook-theme-vip-demo.gif)](https://madmaxchow.github.io/VLOOK/vip-en.html) 【 **More Custom Theme Showcase** •• [**Learn More**](https://madmaxchow.github.io/VLOOK/vip-en.html) 】 ## Plugin Feature Customization Services For more personalized needs in document layout, interaction, and publishing, we offer custom plugin feature development~ 【 [**Learn More**](https://madmaxchow.github.io/VLOOK/vip-en.html#contact-us) 】 ## Typesetting and Editing Services ![Docment Typesetting, Content Revision, Knowledge Base Construction, Publishing Guidance, Website Hosting](https://vlook-doc.pages.dev/pic/vlook-te-en@2x.png) Based on the content and audience of your document, fully utilize the numerous features of Typora + VLOOK™, to provide services like **Docment Typesetting**, **Content Revision**, **Knowledge Base Construction**, **Publishing Guidance**, **Website Hosting**. **Introduction to More Value-Added Services** •• [**Learn More**](https://madmaxchow.github.io/VLOOK/vip-en.html) --- # Directory / File Description | Directory / File | Description | | ---------- | ---------------------------- | | [ **docs** ] | VLOOK™ Quick Reference Manual, official website and online service related documents | | [ **released** ] | Home directory of the release version | |    ┠─ [ **demo** ] | VLOOK™ Home page | |    ┠─ [ **themes** ] | Theme files | |    ┠─ [ **samples** ] | Recommend sample documents | |    ┖─ [ **plugin** ] | Plugin home directory | |         ┠─ [ **lang** ] | Language package for Typora export HTML option | |         ┠─ plugin_live.txt | Online version of Plug-in | |         ┖─ plugin.txt | Local version Plug-in | | [ **src** ] | Source directory | |    ┠─ [ **dev** ] | Develop and test files | |    ┠─ [ **less** ] | The source file of the theme CSS file | |    ┖─ [ **logo** ] | VLOOK™ logo resource | # Star History [![Star History Chart](https://api.star-history.com/svg?repos=MadMaxChow/VLOOK&type=Date)](https://star-history.com/#MadMaxChow/VLOOK&Date)