_VLOOK™
Let Your Markdown Have A New Perspective^Interaction
──
Introduction
V23.0 is the Latest


MAX°孟兆
COPYRIGHT © 2016-2024. MAX°DESIGN.

选择语言 ❯ 🇨🇳 简体中文

What is VLOOK™

A DOMESTICALLY DEVELOPED OPEN-SOURCE PRODUCT RECOMMENDED BY Open Source China.

VLOOK™ is a THEME PACK and ENHANCEMENT PLUGIN for Typora¹, a cross-platform Markdown editor that targets exported HTML files.

VLOOK™ is an open-source software that follows the MIT License.

EditorTyporaV1.8.3+_Gy　LicenseMIT_Rd　Supported OSWindows / macOS / Linux_Bu

Code hosting: 　　

Agreement

VLOOK™ is open source software and complies with the following open source agreements:

License Agreement of VLOOK™

1
MIT License
2
Copyright (c) 2016-2024 MAX°DESIGN | Max Chow
3
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:
4
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
5
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.

What is Markdown?

• In 2004, John Gruber created Markdown , a type of writing specifically for the Internet Text markup language . With Markdown, you only need to insert a small number of markup symbols in the writing process, and you can easily typeset (for example, set the title, bold, list, quote, etc.);

• Markdown documents are based on Plain text format storage , which means that they can be opened with almost any text editor. At the same time, it can be exported to rich text documents with typesetting, HTML web pages, etc. through the Markdown editor.Pure, concise, easy to use and flexible, Are the reasons why people like Markdown;

• The current standardization project of Markdown is CommonMark .

60 seconds to learn, 10 minutes to learn Markdown grammar in depth

1. RECOMMANDED_T2! Flavored the Markdown GitHub (GFM) Syntax Reference: Typora the currently used standard in detail ;

2. Standardized CommonMark grammar reference: 60 seconds to learn Markdown grammar , 10 minutes to learn Markdown in depth .

Prepared For

If you also have one or more of the following needs or pain points, you can safely try the Markdown-based document solution for document editing, publishing, and management. The recommended combination is Typora + VLOOK™:

• Use Markdown to write documents, but there are more requirements for the Markdown editor, or the typesetting and interaction of the HTML output

• For the written document, hope ???Unified template and output_T1 , and best ???Change theme any time_T2

• I hope I only pay attention to the writing of the content of the document, and the tedious work of typesetting hopes to be ableautomationFinish

• RduceIn terms of software tools such as documents (such as Word) and graphics (such as Visio)Purchase expenditure, Or these software typesettingOperation feels bored

• Need supportCross-platform,Cross-terminalHow to browse and publish documents

• The output documents can provide interactive auxiliary tools (such as catalog outline, spotlight, laser pointer, footnotes, etc.) when reading, reviewing, and demonstrating

💡 Do you know?

This document is created by Typora and using the VLOOK™ plug-in! AMAZING!!!

_Bn!

Donate

If you like VLOOK™, you can contribute a cup of coffee :-)

PayPal@madmaxchow_Cy!

感谢打赏支持 VLOOK™ 的客官（部分名单）：

＊丽、一＊秋、＊军、＊鹏、李＊6、＊无、H＊t、＊二、f＊y、＊宇、＊琛、＊辉、＊秋、＊笑、＊豫、l＊a、＊心、整＊9、＊国、＊拉、＊龙、＊应、＊销、＊哦、E＊y、……

Quick Start

VLOOK™ continues to explore and expand Markdown and CSS, and at the same time combines the Internet-based application scenarios of documents~

In the document layout , content navigation , presentation aid , interactive experience provided and other aspects of the consistent , concise , and friendly experience.

° LAYOUT

With the support of VLOOK™ theme and plug-ins, you have a new understanding and application of the automatic typesetting ability of the Markdown editor (only supports Typora for now).

In addition to the ability for rich document formatting and content identification, based on the HTML format, static documents can also "come to life" with you.

Learn more

_Vn!

° NAVIGATION

VLOOK ™ provides tools for document contents, chapters, figures, tables, and multimedia to provide multiple forms of navigation, rapid positioning, and content organization to improve and improve the browsing experience and efficiency of published HTML files.

No extra action, focus on document writing. Automatic integration is completed when you click export~ Learn more

_Bu!

° PRESENTATION & PUBLICATION

VLOOK™ uniquely provides powerful presentation and publishing aids, making Typora + VLOOK a more productive Markdown document solution.

Very suitable for on-site and remote presentation aids, turn on Turbo mode for your documents~

Learn more

_Og!

° THEME & not MISC.

" Humans have always been visual animals. It is a kind of virtue, a kind of power, and a kind of belief to let the eyes feel pleasure and beauty when reading by themselves or others. "

　　　　—— MAX°孟兆

Learn more

_Lm!

Click here to browse more VLOOK™ topics

How To Use

You can start a brand new Markdown experience in just 3 steps 1.Download and Configure > 2.Install the Theme Package > 3.Configure Export Options

Make your Markdown a new perspective^Interaction!

Download and Configure

Step1. Download the Plug-in

1. Download the latest version from the homepage of VLOOK™

   1. via GitHub

   2. via Gitee

_Gn

Step2. Install Typora

1. Download and install the latest version of Typora ;

2. Enter the configuration Typora ▸ Settings ▸ Markdown;

3. Enable all options under "Markdown Extended Syntax", "Code Blocks". See the figure below for details:

_Gn

Install Fonts (optional)

Download and install the VLOOK™ theme matching font pack•• See "Font Themes" for details.

_Gn

Typora ▸ 偏好设置 ▸ Markdown

Install the Theme Package

Step1. Install the Theme

1. The released\theme all CSS files are copied to Typora theme directory;

2. Where is the theme directory? You can navigate to this directory by clicking Settings ▸ Appearance ▸ Open Theme Directory.

_Og

Step2. Select Theme

1. Restart Typora;

2. Click the Theme menu, select to Vlook * any topic can be in the form of naming.

_Og

Start Writing from the Template

It is recommended to create your own Markdown document based on the document template of the VLOOK™ specification, so that you can get started faster.

_Og

Where are the template files?

1. All md type files in the directory released/demo

   1. Standard template: VLOOK-Document-Template.md

   2. No cover template: VLOOK-Document-Template-nocover.md

   3. Document library template: VLOOK-Document-Template-doc_lib.md

2. You can also download the document templates directly from the project homepage ( alternative link )

Configure Export Options

Configure export setting

1. Start Typora and enter "Preferences";

2. Click "Export", add configuration (select HTML template), and name the configuration VLOOK .

_Cy

Install Meta Tag

1. Open the meta tag file: released\plugin\meta.txt ( alternate link );

2. Select and copy all contents;

3. Paste to "Append in <head />".

_Cy

Install the Plugin

1. Open the plug-in file: released\plugin\plugin.txt ( alternate link );

2. Select and copy all contents;

3. Paste to "Append in <body />".

_Cy

One-click export via VLOOK

1. Open the md file conforming to the VLOOK™ specification;

2. Click File ▸ Export ▸ VLOOK to export.

_Cy

Typora ▸ 偏好设置 ▸ 导出

Supplement

Online version plug-in

The above configuration method is an offline plug-in. The complete plug-in code is integrated with HTML files. It is suitable for situations where an intranet or no network is required when browsing documents, but it is not convenient to update plug-ins in real time and switch template themes online .

At present, VLOOK supports the online version of plug-in. You can refer to the above method to add a new "export configuration" (it is recommended to name the configuration VLOOK (live)).

The online version of the plugin file is: released\plugin \ plugin_live.txt , or directly open the online version of plugin_live.txt ( alternative link )

_Og!

How to update to latest version ?

To upgrade the old version of vlook to the latest version, repeat step 1 above to download the latest release version, and press steps 2 and 3 to update the corresponding "theme" and "export configuration".

_Cy!

Recommend compatible browser !

In order to ensure the best user experience, it is strongly recommended to use the following browsers to access:

Chrome　　 Edge　　 Firefox

_Bu

If you have any suggestions and needs, please feel free to give feedback~

The End