/VLOOK

Enhanced plug-in for HTML exported by Typora

Primary LanguageCSSMIT LicenseMIT

概况

VLOOK™ 是针对由 Typora(目前最好的跨平台 Markdown 编辑器,没有之一)导出的 HTML 文件进行增强的插件。VLOOK™ 为开源软件,遵从 MIT 许可证。 VLOOK 插件主要包括:

  • 排版增强:针对 Typora 编辑模式,以及导出的 HTML 文件增加更实用、美观的文档排版与样式;
  • 功能增强:针对导出的 HTML 文件提供文档导航、评审演示、插图浏览、内容交互、信息缺失检测等功能。

有关 VLOOK 特性的详细介绍、样例及使用说明详见《VLOOK 快速参考手册
有关脚本化图表的详细介绍、样例及使用说明详见《脚本化图表 for Markdown


应用主题

  • released\theme下所有 CSS 文件复制至 Typora 的主题目录( Typora「偏好设置」中点击「外观 - 打开主题目录」定位到该目录);
  • 进入 Typora 的偏好设置,启用 Markdown 语法扩展下的所有选项(如:公式、上标、下标、高亮、图表等);
  • 重启 Typora,点击菜单主题,选择以vlook-*形式命名的主题,即可启用对应的 VLOOK 样式主题。

主题定制服务

  • 请加微信:MaxChow

应用插件

  • 在 Typora 中将 Markdown 文件导出为HTML文件;
  • 打开文件released\VLOOK-TOOLBOX 插件.txt,全选所有内容,并复制;
  • 用纯文件编辑器(如:记事本、VS Code)打开该导出的 HTML 文件;
  • 搜索「<body 」,并将复制的内容粘贴到 body 标签的「>」之后:
    <body ...>
    ← ← ← ← ← 复制的「VLOOK-TOOLBOX 插件」内容粘贴于此!
    ...
    </body>
    
  • 保存,大吉大利。

强烈建议使用 Chrome 或 Firefox 浏览器查看


字体

VLOOK 优先显示开源的思源黑体和思源宋体,建议下载安装获得更好的视觉体验;


打赏

若喜欢 VLOOK™ 的话,可以请 Max 喝杯咖啡:
微信支付


目录说明

  1. docs:VLOOK 快速参考手册及相关文档
  2. released:发布版的主目录
    • theme:主题文件
  3. demo:基于 VLOOK 主题的示例文件
  4. src:源码目录
    • dev:开发测试用示例文件
    • less:主题 CSS 文件的源文件
    • misc:杂项文件,包括图标源文件、产品原型、主题图形素材设计源文件等

Overview

VLOOK is a plugin for enhancements to HTML files exported by Typora. Includes two major features: Layout Enhancements and Feature Enhancements:

  • Layout enhancements: Provides more user-friendly, beautiful document layout and style for the Typora editing mode and exported HTML files;
  • Feature enhancement: Provides convenient reading accessibility functions such as document navigation, illustration browsing, content interaction, and validity detection for exported HTML files.

VLOOK™ is open source software and is compliant with the MIT license.

Detailed description of the features, as well as instructions for use, can be found in the "VLOOK Quick Reference Manual".