1 Star 0 Fork 80

MelodyJerry / VLOOK

forked from MAX°孟兆 / VLOOK 
加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
MIT

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

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

开源中国(OSChina.net)推荐的国产开源产品。

VLOOK™

VLOOK™ 是针对 Typora(跨平台 Markdown 编辑器)的 主题包增强插件

VLOOK™ is a Theme Pack and Enhanced Plug-in for Typora.

VLOOK™ 也许是目前最好的 Markdown 增强插件之一,也是开源中国(OSChina.net)推荐的国产开源产品。

VLOOK™ 属于开源软件,遵从 MIT 许可证

加入 VLOOK™ 官方Q群:805502564


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

让你的 Markdown 文档在自动化排版、可交互性上了 N 个台阶

内置多套原创文档主题 & 字体主题,一键切换!支持私人定制!

图片排版 plus:题注、高分屏、版式、Dark 模式适配反色/替换…

表格排版 plus:单元格合并、列格式、行分组、重复表头、自动编号…

索引、逐章、逐段三种导航模式,插图/表格/媒体/代码分类索引与搜索

火力全开的演示辅助~画中画、聚光灯、激光笔、表格十字光标、刮刮卡…

所有特性完美适配 Dark 模式,你的 Markdown 变得更拉风了

还有音频、视频、标签、引用折叠、高清插图、…30+特性等你开箱即用


打赏

若喜欢 VLOOK™ 的话,可以贡献一杯咖啡 :-)
打赏 VLOOK™

THANKS TO DONATE


快速参考手册

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

  • 有关 VLOOK™ 特性的详细介绍、样例及使用说明详见《VLOOK™ 快速参考手册》••• GitHub •• Gitee
  • 有关脚本化图表的详细介绍、样例及使用说明详见《脚本化图表参考指南》••• GitHub •• Gitee

如何使用

Step 1•下载与配置

  1. 下载插件:
    1. 从 VLOOK™ 在 GitHubGitee 的主页下载最新发布的版本
    2. 也可直接在项目主页中下载主题文件备用链接
  2. 安装字体:(可选)
    1. 下载并安装 VLOOK™ 主题配套字体包 •• 详见「字体主题
  3. 安装 Typora:
    1. 下载并安装 Typora 的最新版本
    2. 启动 Typora 并进入「偏好设置」,启用「Markdown 扩展语法、代码块」下的所有选项。详见下图:

开启「Typora▸偏好设置▸Markdown」相关选项

Step 2•安装并选择主题

  1. 安装主题:
    1. released\theme下所有 CSS 文件复制至 Typora 的主题目录
    2. 主题目录在哪?可通过「偏好设置」中点击「外观▸打开主题目录」定位到该目录
  2. 选用主题:
    1. 重启 Typora
    2. 点击「主题」菜单,选择以Vlook-*形式命名的任意主题即可
  3. 编写文档:
    1. 建议基于 VLOOK™ 规范的文档模板来创建你自己的 Markdown 文档,这样能更快上手
    2. 模板文件在哪?
      1. 在目录released下的文件「VLOOK-Document-Template.mdVLOOK-Document-Template_nocover.md
      2. 也可直接在项目主页中下载文档模板备用链接

Step 3•应用插件

进入「Typora▸偏好设置▸导出」进行配置

  1. 配置导出选项安装 Typora:
    1. 启动 Typora 并进入「偏好设置
    2. 点击「导出」,添加配置(选择 HTML 模板),并将配置命名为VLOOK
  2. 安装插件代码:
    1. 打开插件文件:released\plugin\plugin.txt,或直接打开线上版本的 plugin.txt备用链接
    2. 全选里面的所有内容,并复制
    3. 回到 VLOOK 的导出配置界面中,在<body />中添加,将内容粘贴至下方的文本框内即可
  3. 一键导出:
    1. 打开符合 VLOOK™ 规范的 md 文件
    2. 点击「文件▸导出▸VLOOKVLOOK (live)」即可
在线版插件

以上配置方式为离线插件,完整的插件代码与 HTML 文件集成,适合浏览文档时须在内网或无网络的情况,但不便于实时更新插件和在线切换模板主题等。

目前 VLOOK 支持提供在线版插件方式,可参考以上方式增加新的「导出配置」即可(建议配置命名为VLOOK (live))。

在线版的插件文件为:released\plugin\plugin-live.txt,或直接打开线上版本的 plugin-live.txt备用链接

选择合适的浏览器

强烈建议使用以下浏览器进行访问:

Google Chrome  Microsoft Edge(Chromium)  Mozilla Firefox


私人定制主题

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

私人定制主题

(以上仅为效果仅为样品展示,非正式定制服务成品)

私人定制主题服务微信:MaxChow


字体主题

模板主题让文档颜值倍增,而字体则是文档气质担当!

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

小•清•新

整体视觉为「清新、简约、明快」,主要采用无衬线的免费或开源的东亚和拉丁字体。

字体风格_小清新

文•艺•范

整体视觉为「优雅、韵动、个性」,主要采用衬线、无衬线的免费或开源的东亚和拉丁字体,多种字重进行混搭组合

字体风格_文艺范

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

蓝奏云 •• 下载字体▾

百度网盘 •• 下载字体▾(提取码11ta)


目录说明

目录 说明
[ docs ] VLOOK™ 快速参考手册、官网及在线服务相关文件
[ released ] 发布版本的主目录
   ┠─ [ demo ] 基于 VLOOK™ 主题的 Markdown 示例/模板文件
   ┠─ [ theme ] 主题文件
   ┖─ [ plugin ] 插件主目录
        ┠─ plugin_live.txt 在线版本°插件
        ┖─ plugin_standalone.txt 离线版本°插件
[ src ] 源码目录
   ┠─ [ dev ] 开发测试用文件
   ┠─ [ less ] 主题 CSS 文件的源文件
   ┖─ [ logo ] VLOOK™ 的 logo 资源
MIT License Copyright (c) 2016-2021 MAX°DESIGN | Max Chow Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

简介

VLOOK™ 是针对 Typora(跨平台 Markdown 编辑器)(跨平台 Markdown 编辑器)的主题包和增强插件(针对导出的 HTML 文件) 展开 收起
JavaScript
MIT
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
JavaScript
1
https://gitee.com/melodyjerry/VLOOK.git
git@gitee.com:melodyjerry/VLOOK.git
melodyjerry
VLOOK
VLOOK
master

搜索帮助