[ PDF LOG ]
Guide ▲ Advanced - VLOOK™ - Elegant and Practical Typora Theme & Plugin

Donate°CodeCode Block StylesCopy Code ContentCopy Code ExampleCopy Code Block ExampleCode Block Wrapping LayoutCaption & Auto-numbering°Button & LinkKeyboard KeysButton LinkText ButtonIcon + Text ButtonCard-Style LinkCross-reference°Cover & Back CoverSmall CoverLarge CoverMinimal Document Cover ExampleExample of this document's cover contentExample of this document's back cover content°ColumnsList ColumnsTwo-column List ExampleThree-column List ExampleFour-column List ExampleFive-column List ExampleList Columns Nested Within Blockquote Columns ExampleBlockquote ColumnsSingle-line Two-column Blockquote Example (No Subtitles)Single-line Two-column Blockquote ExampleSingle-line Three-column Blockquote ExampleSingle-line Four-column Blockquote ExampleSingle-line Five-column Blockquote ExampleBlockquote Columns Nested Within Blockquotes ExampleBlockquote Columns (Within Lists)GitHub Style Alert ColumnsExample of GSA Nested in Blockquotes°CaptionHow to Set Caption?Image Caption & Auto-numberingTable Caption & Auto-numberingCode Block Caption & Auto-numberingMultimedia Caption & Auto-numberingMermaid Chart Caption & Auto-numberingMath Formula Caption & Auto-numbering°Tab GroupSimple ExampleMulti-type Content Tab GroupsBlockquote Tab GroupsGitHub Style Alert Tab Groups°Content MarkingGitHub Style AlertBelow are examples with richer formatting contentTagSingle-level TagMulti-level TagTag LinkProgress BarBreadcrumbsScratch CardScratch Card ExamplesPhonetic NotationSuperscript Phonetic NotationPhonetic Example-1Phonetic Example-2Code-style Phonetic NotationPhonetic Example-1Phonetic Example-2°MermaidMermaid Style Optimization & ExtensionMermaid FlowchartMermaid Class DiagramMermaid Mind MapMermaid's Sequence DiagramMermaid Caption & Auto-numbering°FormulaMore Practical & Beautiful FormulaInline Mixed Formula°MultimediaStreaming PlatformsBilibili VideosDouyin VideosTencent VideoStandard VideosAudioStandard Player ExampleMini Player ExampleExample of Embedding an <audio> TagCaptions and Automatic Numbering

Select language ❯ 🇨🇳 简体中文

Donate

Thanks to donors who supported VLOOK™ (partial list) / Thanks for donate VLOOK™ (partial donors)

PeterPuOgRd绿邃清幽CyBuAq李导996CyBuAqfankyCyBuAq*丽CyBuAq杨琛CyBuAq*哦GnBn*豫GnBnl*aGnBn*oGnBn、C*r、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

Donate VLOOK™

Se

Your coffee ☕️ keeps VLOOK™ running

Donate VLOOK™

Gn

°Code

Code Block Styles

VLOOK™ themes provide the following style enhancements for code blocks


  • Directly display the code block language, support current-line highlighting, and integrated display while editing Mermaid diagrams

  • Support adding background textures to code blocks through Custom Themes

Copy Code Content

Markdown FansQFor code and code blocks generated by Markdown, hope to copy content with one click~

VLOOKAT2 VLOOK™ automatically enhances Markdown code blocks, supporting current line highlighting, copying all code, and adapting to Dark Mode!

Availability ••• Editing× Not SupportedGy Export HTML✓ SupportedGn

Copy Code Example

Click this code to copy its content

Copy Code Block Example

tab

VLOOK™ Code Block Example_Programming Language: C++_

Tip

It is recommended to enable line numbers for code blocks in Typora for a better experience.

Enable method: 「Typora ▸ Preferences ▸ Markdown ▸ Code Blocks ▸ Show line numbers」

Code Block Wrapping Layout

Availability ••• Editing× Not SupportedGy Export HTML✓ SupportedGn

Code blocks wrap automatically by default, and can be switched to non-wrapping mode as needed.

Tip

After exporting to HTML, you can manually switch the "Wrapping Layout" via the code block Content Assistant.

Caption & Auto-numbering

About code block caption and auto-numbering

Relevant content see here ❯❯

 


For feedback: Feedback via Email Feedback via QQ Feedback via Telegram

°Button & Link

Keyboard Keys

Availability ••• Editing✓ SupportedGn Export HTML✓ SupportedGn

VLOOK™ theme supports <kbd> tag, and VLOOK™ provides button styles closer to physical keyboards, examples:

 


Q W E R T 1 2 3 4 5

A S D F G < > ? + -

ESC Enter ⌘ command ⌥ option

⌃ Ctrl Alt ⇧ Shift          

Tip

Suitable for software manuals, training documents, making shortcut key instructions more intuitive and clear.

Markdown FansQButton are essential for interactive web documents, hope Markdown documents can keep up

VLOOKAT2 By enhancing Typora's existing <kbd> feature, you can implement various styles of button link - let's get started!

Availability ••• Editing✓ SupportedGn Export HTML✓ SupportedGn

Text Button

VLOOK™ implements "text links" to "button link" conversion, and provides three button styles~

For example with this text link:



■ Standard Button

Just wrap the text with <kbd>

□ Secondary Button

Set the "standard button" to italic

🌈 Super Button

Set the "standard button" to index-en.mdbold

 

Centered when standalone

Centered when standalone

Centered when standalone

Centered when standalone Centered when standalone

Centered when standalone Centered when standalone Centered when standalone](https://github.com/MadMaxChow/VLOOK)**

Tip

To avoid "center alignment", just add a plain space before or after~

Icon + Text Button

Besides text-only buttons, images of any size can be added as button icons.
You can then set the desired icon layout for display.

tab

Text + Image/Icon

Directly insert "image URL" inside <kbd> of above "text button":

  • Markdown: [<kbd>VLOOK ![](xxx.svg)</kbd>]

  • Effect:

VLOOK VLOOK VLOOK

Icon Only

Replace text content in "text button" with "image URL":

  • Markdown: [<kbd>![](xxx.svg)</kbd>]

  • Effect:

 

Important

For images in button to automatically adapt colors to button styles (effective after HTML export), recommend using svg format and set as "Image Silhouette".

Availability ••• While Editing ✓ SupportedGn Exported HTML ✓ SupportedGn

Markdown Fan QWants to present multiple different links, brief descriptions, and icons in a clean and elegant card layout within Markdown documents

VLOOK AT2 Just flexibly combine the previously mentioned Blockquote Subtitles / Columns, Paragraph Underline, Image Icon Styles, and Button Link as needed~

 

Here’s an example of a three-column link card layout:



°Document Layout

This is a simple description of the link

This is a text link

°Document Layout

This is a simple description of the link

This is a text link

°Document Layout

This is a simple description of the link

This is a text link

 


°Document Layout

Card Subtitle 1

This is a summary description of the link target. This is a summary description of the link target.

Standard Button link

°Document Layout

Card Subtitle 2

This is a summary description of the link target. This is a summary description of the link target.

Secondary Button link

 


°Document Layout

Card Subtitle

This is a summary description of the link target with emphasis style

Super Button link

Cross-reference

Availability ••• Editing× Not SupportedGy Export HTML✓ SupportedGn

 

In-document anchor links, including sections and various Captions, support displaying referenced prefix information (such as section numbers and caption numbers). The example effects are shown below:

 


For feedback: Feedback via Email Feedback via QQ Feedback via Telegram

°Cover & Back Cover

Markdown FansQHow to make Markdown documents support covers and back covers (like this document's cover and back cover)? VLOOKAT2 After applying VLOOK™'s "Template Theme", using standard Markdown syntax can make documents support covers and back covers by following VLOOK™ conventions.

 

Currently, two cover styles are available: "Small Cover" and "Large Cover". Choose the one that best fits your needs:


What's "Small" Cover?

Best suited for short documents or informal publishing scenarios and does not include a back-cover layout.

The cover used in this document is the "Small Cover". You can return to the start of this document to view the effect.

T1

What's "Large" Cover?

Ideal for longer documents or more formal publishing scenarios, and provides an optional back-cover layout.

The cover used in the introduction document is the "Large Cover". You can open this link to view the effect.

T1!

Small Cover

Availability ••• Editing× Not SupportedGy Export HTML✓ SupportedGn

 

  1. First, add a YAML Front Matter to the document via Typora > Paragraph > YAML Front Matter

  2. Then configure the cover-related fields inside the YAML section following standard YAML syntax. The settings will take effect after exporting to HTML.

( You can scroll to the very beginning of this document to directly preview the demo effect of the "small cover" )

The "Small Cover" supports the following YAML fields

Large Cover

Availability ••• Editing✓ SupportedGn Export HTML✓ SupportedGn

 


Activate "Cover"

Input a Level 6 heading at the index-en.mdvery beginning of the document

Example: ###### This is the cover title

Shortcut

Select text for cover content, then press Cmd / Control + 6

Tip

If there's YAML or [TOC] content, add it after them.

T1

Activate "Back Cover"

Input a Level 1 heading at the index-en.mdlast line of the document

Example: # This is the back cover message

Shortcut

Select text for back cover content, then press Cmd / Control + 1

T2

After successfully activating cover and back cover, corresponding entries will appear in Typora's outline panel for quick navigation.
Below are automatic formatting rules for specific information in "Cover":

tab

Title

Default format is title format, just input directly;

Can combine subscript and underline formats for "subtitle, secondary title":

  • Subtitle: <sub>Subtitle with spaces</sub> or ~Subtitle without spaces~

  • Secondary title: <u>This is the secondary title</u>

Document Type, Security Level

Use VLOOK™'s multi-level tag syntax:

  • *Security Level`Public*_~Gn~_

  • *Security Level`Internal*_~Og~_

  • *Security Level`Confidential*_~Rd~_

Author

Use Markdown "bold" format for "author info", automatically prefixed with By, or specify via Custom Theme

  • Example: **Author Name**

Copyright Info

Use Markdown "italic" format for "copyright info" (automatically reduces font size and bold)

  • Example: *(C)2020. All Rights Reserved*

 

Tip

How to add line breaks in cover/back cover?

Directly input HTML line break tag <br>.

tab

Minimal Document Cover Example
Example of this document's cover content
Example of this document's back cover content

 

If you want a more personalized cover and back cover design, you can subscribe to VLOOK™’s Custom Theme Service .

Explore More About VIP Themes


For feedback: Feedback via Email Feedback via QQ Feedback via Telegram

°Columns

"Columns" and "Tab Groups" are two very practical, widely applicable, and complementary typesetting features.
"Columns" meet the need to simultaneously display multiple sets of information in the same area, sharing display space, suitable when content is limited;
"Tab Groups" meet the need to alternately display multiple sets of information in the same area, occupying display space exclusively, suitable when content is abundant.

Markdown FansQMarkdown natively doesn't support column typesetting. Some users reluctantly use tables as substitutes, which remains uncomfortable~

VLOOKAT2 With VLOOK, you only need 1 action to instantly make your "blockquotes, lists, GitHub Style Alert" achieve column arrangement!

List Columns

Markdown FansQHope to display long lists in columns, but Markdown standards don't seem to support this practical typesetting method~

VLOOKAT2 By extending specific combinations of Markdown syntax, we can meet your flexible typesetting needs!

Availability ••• Editing✓ SupportedGn Export HTML✓ SupportedGn

 

Mainly suitable for column needs with subtitles, where content is organized via lists, e.g.: task boards, etc.

Syntax

Add a specified number of "horizontal dividers" --- before the "list" that needs column typesetting

  • Add 1 horizontal divider to enable "⬛︎ ⬛︎ Two-column" mode

  • Add 2 horizontal dividers to enable "⬛︎ ⬛︎ ⬛︎ Three-column" mode

  • Add 3 horizontal dividers to enable "⬛︎ ⬛︎ ⬛︎ ⬛︎ Four-column" mode

  • Add 4 horizontal dividers to enable "⬛︎ ⬛︎ ⬛︎ ⬛︎ ⬛︎ Five-column" mode

Column Syntax Example

Tip

After normal addition, corresponding column count prompts will automatically appear at the horizontal divider, e.g. "⬛︎ ⬛︎ 2 Columns of List ⬛︎ ⬛︎"

Two-column List Example

  1. List 1

    • This is list item 1-1

    • This is list item 1-2

  2. List 2

    1. This is list item 2-1

    2. This is list item 2-2

  3. List 3

    • This is list item 3-1

    • This is list item 3-2

    Blockquote within list

  4. List 4

    • This is list item 4-1

    • This is list item 4-2

Three-column List Example


Four-column List Example



Five-column List Example




List Columns Nested Within Blockquote Columns Example

  • List 1

    • This is list item 1-1

    • This is list item 1-2

  • List 2

    1. This is list item 2-1

    2. This is list item 2-2

Blockquote Columns

Markdown FansQHope to display blockquotes in columns, but Markdown standards don't seem to support this practical typesetting method~

VLOOKAT2 By extending specific combinations of Markdown syntax, we can meet your flexible typesetting needs!

Availability ••• Editing✓ SupportedGn Export HTML✓ SupportedGn

 

Mainly suitable for organizing similar content in blocks, where content isn't suitable for list-based organization.

Syntax

Add a specified number of "horizontal dividers" --- before the "blockquotes" that need column typesetting

  • Add 1 horizontal divider to enable "⬛︎ ⬛︎ Two-column" mode

  • Add 2 horizontal dividers to enable "⬛︎ ⬛︎ ⬛︎ Three-column" mode

  • Add 3 horizontal dividers to enable "⬛︎ ⬛︎ ⬛︎ ⬛︎ Four-column" mode

  • Add 4 horizontal dividers to enable "⬛︎ ⬛︎ ⬛︎ ⬛︎ ⬛︎ Five-column" mode

Column Blockquote Syntax Example

Tip

After normal addition, corresponding column count prompts will automatically appear at the horizontal divider, e.g. "⬛︎ ⬛︎ 2 Columns of Quote ⬛︎ ⬛︎

Single-line Two-column Blockquote Example (No Subtitles)

Column 1

Content of column 1

Column 2

Content of column 2

Single-line Two-column Blockquote Example

Two-column Subtitle 1

Column 1

Image embedded in blockquote column

Two-column Subtitle 2

Column 2

Image embedded in blockquote column

Single-line Three-column Blockquote Example


Three-column Subtitle 1

Row 1 Column 1

Three-column Subtitle 2

Row 1 Column 2

Three-column Subtitle 3

Row 1 Column 2



Three-column Subtitle 4

Row 1 Column 1

Three-column Subtitle 5

Row 1 Column 2

Three-column Subtitle 6

Row 1 Column 3

Single-line Four-column Blockquote Example



Four-column Subtitle 1

Row 1 Column 1

Button

Rd!

Four-column Subtitle 2

Row 1 Column 2

Button

Gn!

Four-column Subtitle 3

Row 1 Column 3

Button

Bu!

Four-column Subtitle 4

Row 1 Column 4

Button

Pu!

Single-line Five-column Blockquote Example




Five-column Subtitle 1

Row 1 Column 1

Button

Rd!

Five-column Subtitle 2

Row 1 Column 2

Button

Gn!

Five-column Subtitle 3

Row 1 Column 3

Button

Bu!

Five-column Subtitle 4

Row 1 Column 4

Button

Pu!

Five-column Subtitle 5

Row 1 Column 5

Button

Bn!

Blockquote Columns Nested Within Blockquotes Example

Blockquote Columns Nested Within Blockquotes



Nested Column 1 (Non-H6)

Row 1 Column 1

Button

Rd!

Nested Column 2 (Non-H6)

Row 1 Column 2

Button

Gn!

Nested Column 3 (Non-H6)

Row 1 Column 3

Button

Bu!

Nested Column 4

Row 1 Column 4

Button

Pu!

Gy

Blockquote Columns (Within Lists)

Markdown Fan Q "I’d like to display blockquotes in columns within a list, so the layout can be more flexible for column formatting."

VLOOK AT2 Just use the "Blockquote Columns" feature inside the list items!

Availability ••• Editing ✓ SupportedGn Export to HTML ✓ SupportedGn

 

(Before creating blockquote columns, remove the numbering from the list items.)

  1. List 1


    Blockquote Column (List) 1-1

    Blockquote Column (List) 1-2

  2. List 2



    Blockquote Column (List) 2-1

    Blockquote Column (List) 2-2

    Blockquote Column (List) 2-3

  3. List 3




    Blockquote Column (List) 3-1

    Blockquote Column (List) 3-2

    Blockquote Column (List) 3-3

    Blockquote Column (List) 3-4

GitHub Style Alert Columns

Availability ••• Editing✓ SupportedGn Export HTML✓ SupportedGn

 

Supports displaying GitHub Style Alert in columns, following the same familiar approach as "Blockquote Columns" above~

 


Note

Memo. Highlight information users should consider even when skimming

Tip

Tip. Optional information to help users achieve greater success



Important

Important. Information crucial for user success

Warning

Caution. Key content requiring immediate user attention due to potential risks

Caution

Warning/Prohibition. Potential negative consequences of an action

 

Example of GSA Nested in Blockquotes

Below is GitHub Style Alert:

Note

Highlights information that users should take into account, even when skimming. GitHub Style Alert

 


For feedback: Feedback via Email Feedback via QQ Feedback via Telegram

°Caption

Markdown FansQHow to add caption and auto-numbering to tables, illustrations, code blocks, etc. in documents like Word?

VLOOKAT2 With simple markup, you can add caption to tables, images, code blocks, formulas, etc., with auto-numbering like Table 1 Figure 2.3-2. Caption content also automatically serves as anchors for Cross-reference and jumping within documents~

 

Availability ••• Editing× Not SupportedGy Export HTML✓ SupportedGn

How to Set Caption?

tab

Set Caption: Method 1 (Images only)

For images, caption are primarily generated based on "image title" and "optional subtitle" in Markdown standard syntax.

MemoBu This method supports "dual captions", where "optional subtitle" content serves as the second caption.

Set Caption: Method 2

  • Caption content needs to index-en.mdoccupy a standalone paragraph, formatted as: first "italic", then "highlight"

  • Corresponding Markdown syntax: *==This is caption content==*

TipGn This method supports "dual captions".

Shortcut

Select content, then press Cmd/Ctrl + i for italic, then Cmd/Ctrl + ⇧ Shift + h for highlight

 

Note

  • When the format is correctly set during editing in Typora, visual indicators will be shown;

  • Captions and automatic numbering will not be generated automatically for tables, figures, code blocks, etc. They will only take effect after being configured according to Method 1 or Method 2 described above;

  • You can use the capnum option under Plugin Tuning Parameters to control whether automatic numbering for captions is enabled;

  • You can use the capgroup option under Plugin Tuning Parameters to control whether automatic caption numbering is grouped by the corresponding section.

 

tab

Dual Captions

The second caption appears below tables. index-en.mdSetting method:

  • Step 1 Complete first caption content via "Method 2" above;

  • Step 2 Add second caption content after first, wrapped in underscores _ ;

  • Corresponding Markdown syntax: *==First caption content_Second caption_==* .

Image Caption & Auto-numbering

Follow Markdown syntax for adding images: ![Image title](ImageURL "Optional subtitle")

  • Single caption: Image title serves as "Caption 1" content

  • Dual captions: Optional subtitle serves as "Caption 2" content (optional)

(Plugin prioritizes using above content as caption. If none, supports adding via "Method 2")

 

Dual-caption image example

Single-caption image example

 

Advanced Usage of Image Captions
  1. Do not display the image caption text, only show the caption category (e.g., Figure 1, Figure 2, etc.)

  2. Display the caption category even when no caption text is specified for the image

    • You can configure this by using the capblank option under Plugin Tuning Parameters to force the caption category to be shown when the caption text is empty.

Table Caption & Auto-numbering

Caption generated via "Method 2"

Column AColumn BColumn CColumn DColumn E
Cell contentCell contentCell contentCell contentCell content

Example: This is first caption content_This is second caption content_

Column AColumn BColumn CColumn DColumn E
Cell contentCell contentCell contentCell contentCell content
Cell contentCell contentCell contentCell contentCell content

Code Block Caption & Auto-numbering

  • Add caption via "Method 2" above

(Method 3) Italic+highlight code block caption_The best programming language PASCAL! No rebuttals accepted!_

Multimedia Caption & Auto-numbering

Mermaid Chart Caption & Auto-numbering

Math Formula Caption & Auto-numbering

 


For feedback: Feedback via Email Feedback via QQ Feedback via Telegram

°Tab Group

"Columns" and "Tab Groups" are two very practical, widely applicable, and complementary typesetting features.
"Columns" meet the need to simultaneously display multiple sets of information in the same area, sharing display space, suitable when content is limited;
"Tab Groups" meet the need to alternately display multiple sets of information in the same area, occupying display space exclusively, suitable when content is abundant.

Markdown FansQMarkdown natively doesn't support "Tab Group" typesetting, unable to leverage web interactivity~

VLOOKAT2 With VLOOK, freely specify continuous content (tables/illustrations/blockquotes/code blocks/GitHub Style Alert) to display as tab groups!

Availability ••• Editing× Not SupportedGy Export HTML✓ SupportedGn

 

Syntax

  • Before the first content in continuous content to be displayed as tab groups, add an empty line, input any content (e.g. tab), then format as:

    First "italic", then "superscript" (standalone paragraph)

  • Corresponding Markdown syntax: _^tab^_ or *^tab^*

Shortcut
  • Select content, then press Cmd/Ctrl + i for italic, then ⇧ Shift + 6 for highlight;

  • TipGn After exporting HTML, supports switching tabs via tab, ⇧ Shift + tab.

Important

  • When correctly formatted in Typora, visual prompts appear;

  • "Continuous content" refers to content uninterrupted by other types (e.g. headings, lists, empty lines, dividers);

  • To display caption category & numbering info on tabs, enable via parameter captab (see Plugin Tuning Parameters);

Simple Example

tab

Current Tab

This is the content corresponding to the current tab.

On Hover

This is the content corresponding to the tab when hovered.

Other Tabs

This is the content corresponding to other tabs.

Caution

This is the content of a GitHub Style Alert.

Multi-type Content Tab Groups

The following demonstrates how consecutive tables, illustrations, blockquotes, code blocks, videos, audio, formulas, and GitHub Style Alerts are presented in the form of "Tab Groups":

tab

Problem

Given a 0-indexed string s containing only digits 0-9. A string t is semi-repetitive if it has at most one pair of adjacent equal characters. Return the length of the longest semi-repetitive substring in s.

Tip

Optional information to help a user be more successful. Learn More

Python Example

Zoom to 40%

Inheritance
继承

Composition
组合

Aggregation
聚合

Association
关联

Link (Solid)

Dependency
依赖

Realization
实现

Link (Dashed)

*

*

n

1

«interface»

classA

+public attribute

-private attribute

#protected attribute

~package attribute

+public method()

-private method()

#protected method()

~package method()

classB

«enumeration»

classC

Rd

Bu

Gn

WHITE

BLACK

classD

classE

classF

classG

classH

classI

classJ

classK

classL

classM

classN

classO

classP

Column AColumn BColumn CColumn E
    
    

y=y(x,t)=Aeiθ(My Math - 11)=A(cosθ+isinθ)=A(cos(kxωt)+isin(kxωt))=Acos(kxωt)+iAsin(kxωt)(My Math - 12)=Acos(2πλx2πvλt)+iAsin(2πλx2πvλt)(My Math - 13)=Acos2πλ(xvt)+iAsin2πλ(xvt)

Note

  • Highlights information that users should take into account, even when skimming. Learn More

Online Video

Blockquote Tab Groups

When tab items or content are too long, horizontal scrolling is supported (also supports keyboard Tab / ⇧ Shift + Tab for switching):

tab

Markdown What is Markdown?

  • In 2004, John Gruber created Markdown Markdown, a text markup language specifically designed for web writing. Using Markdown, you only need to insert a small number of markup symbols during writing to easily format text (such as setting headings, bold, lists, blockquotes, etc.);

  • Markdown documents are stored in plain text format, which means they can be opened with almost any text editor. At the same time, they can be exported as formatted rich text documents, HTML web pages, etc. through Markdown editors. Pure, concise, easy to use, flexible are all reasons why people love Markdown.

Markdown

Markdown Standardization Project (CommonMark)

What is Github Flavored Markdown?

  • GitHub Flavored Markdown (GFM) is a popular markup language that adds some additional features to standard Markdown to better adapt to GitHub platform needs. These additional features include task list, automatic links, tables, etc.;

  • Typora currently mainly adopts this standard Details ❯

What is AsciiDoc?

  • AsciiDoc is a text format specification designed to solve the problem of book-scale writing, serving as an upgrade or alternative to Markdown;

  • Compared to Markdown, it supports more formats, including document attributes, setting authors, version information, syntax highlighting, tables, Include functionality, etc.;

  • AsciiDoc can be converted to various formats such as HTML5, DocBook, EPUB, PDF, etc. through the AsciiDoctor toolchain;

  • AsciiDoctor also provides template engines and performance improvements, making it suitable for scenarios requiring rich formats and custom output.

(The above information is generated by Baidu AI)

Why hasn't AsciiDoc become popular?

  • First, index-en.mdhigher learning cost. Although AsciiDoc supports more formats than Markdown, these features also increase its learning difficulty. For simple document writing, these features of AsciiDoc are not necessary, while simple documents like blogs tend to use Markdown with lower learning cost;

  • Second, index-en.mdrelatively limited functionality. Although it supports more formats, compared to Markdown, AsciiDoc's flexibility in specific scenarios is slightly insufficient. Markdown can achieve similar functionality through self-extended syntax or using HTML, while AsciiDoc requires more custom block syntax and extensibility, which may bring inconvenience in some cases;

  • Finally, index-en.mdlack of widespread community support. Although AsciiDoc has certain applications in specific fields (such as e-book production), its overall community and user base are relatively small, limiting its promotion and use in broader application scenarios.

(The above information is generated by Baidu AI)

GitHub Style Alert Tab Groups

The following shows GitHub Style Alert presented in "Tab Group" form while retaining highlighting styles:

tab

Note

  • Highlights information that users should take into account, even when skimming. Learn More

(Memo. Highlight information that users should also consider when browsing) Learn More Learn More

Tip

  1. Optional information to help a user be more successful. Learn More

(Tip. Optional information to help users achieve greater success) Learn More Learn More

Important

Crucial information necessary for users to succeed. Learn More

(Important. Information critical to user success) Learn More Learn More

Warning

Critical content demanding immediate user attention due to potential risks. Learn More

(Note. Key content requiring immediate user attention due to potential risks) Learn More Learn More

Caution

Negative potential consequences of an action. Learn More

(Warning/Prohibition. Potential negative consequences of actions) Learn More Learn More

 

Currently, 3 styles are available for “Tab Groups”. If you wish to specify a particular style, you can subscribe to VLOOK™’s Custom Theme Service .

Explore More About VIP Themes

°Content Marking

GitHub Style Alert

Markdown FansQDoes VLOOK™ theme support GitHub Style Alert? (Requires Typora1.8.3+ or higher version)」

VLOOKAT2 Has adapted and optimized in terms of typesetting styles, while supporting automatic matching of "information category names" in multilingual environments.

Availability ••• Editing✓ SupportedGn Export HTML✓ SupportedGn

GitHub Style Alert is primarily used in documents for reminders, notes, or emphasizing key information through specific typesetting styles, consisting of corresponding information category icons, names, content, etc.

 


VLOOK™ Optimizations for GSA

  • Provides multiple style options including "Regular, Flat, Emphasized", which can be specified through Custom Theme configuration;

  • Adapts styling for "text links, button, highlights" within to match the color scheme of corresponding information categories.


Below shows the "Flat" style example. For more style examples, please preview through VLOOK™'s preset Fancy, Geek, Hope, Joint, Solaris, Thinking themes.

Syntax

Input any of the following GitHub Style Alert category identifiers in the first line of a "blockquote" to enable automatic recognition and rendering:

[!NOTE] [!TIP] [!IMPORTANT] [!WARNING] [!CAUTION]

Reference Example

For more GitHub Style Alert information, see Typora Release Notes

 

Note

  • Highlights information that users should take into account, even when skimming. Learn More

Memo. Emphasizes information users should consider even while browsing) Learn More Learn More

 

Tip

  1. Optional information to help a user be more successful. Learn More

Tip. Optional information to help users achieve greater success Learn More Learn More

 

Important

Crucial information necessary for users to succeed. Learn More

Important. Information critical for user success) Learn More Learn More

 

Warning

Critical content demanding immediate user attention due to high risks. Learn More

Warning. Indicates a high-risk situation that requires the user's immediate attention) Learn More Learn More

 

Caution

Negative potential consequences of an action. Learn More

Caution. Indicates a potential negative consequence that requires care and attention.) Learn More Learn More

Below are examples with richer formatting content

Note

Memo. Highlight information that users should also consider when browsing.


This is Blockquote Subtitle 1

  • This is a task list item

  • This is unordered list item

  1. This is ordered list item

This is Collapsed Column 1

Note Code Block

This is text link, this is Button Link ❯

Tip

Tip. Optional information to help users achieve greater success.


This is Blockquote Subtitle 2

  • This is a task list item

  • This is unordered list item

  1. This is ordered list item

This is Collapsed Column 2

Tip Code Block

This is text link, this is Button Link ❯

Important

Important. Information critical to user success.


This is Blockquote Subtitle 3

  • This is a task list item

  • This is unordered list item

  1. This is ordered list item

This is Collapsed Column 3

Important Code Block

This is text link, this is Button Link ❯

Warning

Note. Key content requiring immediate user attention due to potential risks.


This is Blockquote Subtitle 4

  • This is a task list item

  • This is unordered list item

  1. This is ordered list item

This is Collapsed Column 4

Warning Code Block

This is text link, this is Button Link ❯

Caution

Warning/Prohibition. Potential negative consequences of actions.


This is Blockquote Subtitle 5

  • This is a task list item

  • This is unordered list item

  1. This is ordered list item

This is Collapsed Column 5

Caution Code Block

This is text link, this is Button Link ❯

Blockquote Embedded GSA

Note

NOTE

Tip

TIP

Important

IMPORTANT

Warning

WARNING

Caution

CAUTION

 

VLOOK™ also supports column layout for GitHub Style Alert

Content details ❯ GitHub Style Alert Columns

 


For feedback: Feedback via Email Feedback via QQ Feedback via Telegram

Tag

Markdown FansQWhen writing documents with Markdown, how can I highlight key content using modern visual elements like "tag"?

VLOOKAT2 Set the "inline code" content in Markdown (like `tag`) to "italic" to achieve beautiful and practical "tag" formatting!

Availability ••• Editing✓ SupportedGn Export HTML✓ SupportedGn

For example, these "single-level tag": this tagRd or that tagBu! can also be gradient tagT1T2

For example, these "multi-level tag": This is titleThis is contentBn Chemical formulaH₂Ois water💦Se, or like this EnabledlightGn lightDisabledGy

Continue reading below to see how this is achieved~

Single-level Tag

Single-level tag are the most basic form of tag without further classification or structure. They are simple and easy to use, typically used to identify specific common information.

For example VIPBnGd PendingRd Follow-up neededBu ImportantPu!

tab

Syntax

  • Wrap the text to be set as a tag with code symbols `, and set it to "italic"

  • Corresponding Markdown syntax: *`This is a tag`*

Shortcut

Select the text, then press Cmd / Control + i to set as italic, then press ` to automatically wrap

Tip

  • Supports adding preset color codes after the tag to specify index-en.mdcolors (supports regular/emphasized styles) or index-en.mdgradient colors. If not specified, defaults to T2 ;

  • To modify the default color code, use the "Plugin Adjustment Parameters" tag to specify.

tab

Tag (Regular Style) Preset Color Codes and Examples

index-en.mdPreset Color CodeRecommended Application ScenariosRendering Effect
WnWarning, Danger, Critical Items, DeletionWn Regular StyleWn
Rd:Rd Regular StyleRd
OgReminder, Notice, FixOg Regular StyleOg
YeAttention, Optimization, Memo, ExplanationYe Regular StyleYe
Tu:Tu Regular StyleTu
LmHint, Reference, NewLm Regular StyleLm
Gn:Gn Regular StyleGn
Mn:Mn Regular StyleMn
Ol:Ol Regular StyleOl
AqQuote Block, AnnouncementAq Regular StyleAq
Sk:Sk Regular StyleSk
Cy:Cy Regular StyleCy
BuInformation, NewsBu Regular StyleBu
Se:Se Regular StyleSe
La:La Regular StyleLa
Vn:Vn Regular StyleVn
PuExtension, Expansion, Reserved, BackupPu Regular StylePu
Au:Au Regular StyleAu
RoYouthful, Personality, FemaleRo Regular StyleRo
Pk:Pk Regular StylePk
Pl:Pl Regular StylePl
GdVIP, Finance, EngineeringGd Regular StyleGd
Bn:Bn Regular StyleBn
Cf:Cf Regular StyleCf
GyInvalid, Deferred, Disabled, EndedGy Regular StyleGy
WtBlack & WhiteWt Regular StyleWt
Bk:Bk Regular StyleBk
T1Current VLOOK™ Theme Primary ColorT1 Regular StyleT1
T2Current VLOOK™ Theme Secondary ColorT2 Regular StyleT2

Tag (Emphasized Style) Preset Color Codes and Examples

index-en.mdPreset Color CodeRecommended Application ScenariosRendering Effect
Wn!Warning, Danger, Critical Items, DeletionWn Emphasized StyleWn! WnMn Gradient StyleWnMn
Rd!:Rd Emphasized StyleRd! RdGn Gradient StyleRdGn
Og!Reminder, Notice, FixOg Emphasized StyleOg! OgCy Gradient StyleOgBu
Ye!Attention, Optimization, Memo, ExplanationYe Emphasized StyleYe! YeGd Gradient StyleYeAq
Tu!:Tu Emphasized StyleTu! TuVn Gradient StyleTuVn
Lm!Hint, Reference, NewLm Emphasized StyleLm! LmAq Gradient StyleLmYe
Gn!:Gn Emphasized StyleGn! GnRd Gradient StyleGnRd
Mn!:Mn Emphasized StyleMn! MnWn Gradient StyleMnAq
Ol!:Ol Emphasized StyleOl! OlCy Gradient StyleOlOg
Aq!Quote Block, AnnouncementAq Emphasized StyleAq! AqLm Gradient StyleAqLm
Sk!:Sk Emphasized StyleSk! SkPk Gradient StyleSkPk
Cy!:Cy Emphasized StyleCy! CyYe Gradient StyleCyYe
Bu!Information, NewsBu Emphasized StyleBu! BuOl Gradient StyleBuOl
Se!:Se Emphasized StyleSe! SeBn Gradient StyleSeOg
La!:La Emphasized StyleLa! LaYe Gradient StyleLaYe
Vn!:Vn Emphasized StyleVn! VnPu Gradient StyleVnRo
Pu!Extension, Expansion, Reserved, BackupPu Emphasized StylePu! PuYe Gradient StylePuYe
Au!:Au Emphasized StyleAu! AuOg Gradient StyleAuOg
Ro!Youthful, Personality, FemaleRo Emphasized StyleRo! RoRd Gradient StyleRoRd
Pk!:Pk Emphasized StylePk! PkGd Gradient StylePkLm
Pl!:Pl Emphasized StylePl! PlSk Gradient StylePlSk
Gd!VIP, Finance, EngineeringGd Emphasized StyleGd! GdYe Gradient StyleGdYe
Bn!:Bn Emphasized StyleBn! BnSe Gradient StyleBnGd
Cf!:Cf Emphasized StyleCf! CfRd Gradient StyleCfRd
Gy!Invalid, Deferred, Disabled, EndedGy Emphasized StyleGy! GyCy Gradient StyleGyCy
Wt!Black & WhiteWt Emphasized StyleWt! WtOg Gradient StyleWtOg
Bk!:Bk Emphasized StyleBk! BkOg Gradient StyleBkOg
T1!Current VLOOK™ Theme Primary ColorT1 Emphasized StyleT1! T1T2 Gradient StyleT1T2
T2!Current VLOOK™ Theme Secondary ColorT2 Emphasized StyleT2! T2T1 Gradient StyleT2T1

Multi-level Tag

Multi-level tag are used for more complex tagging scenarios, generally dividing tag into two or three levels. Unlike single-level tag with single information, multi-level tag can reflect multi-dimensional information.

Two-level structure examples Customer LevelVIPBnGd Customer LevelRegular CustomerGy Document ClassificationPublicBu Document ClassificationConfidentialRoRd Interaction TypeEmail

Three-level structure examples Project PhaseRequirement AnalysisFeasibility Report Latest VersionV2.3betaBuOg

tab

Syntax

  1. First complete the setup according to "Tag";

  2. Add corresponding content before or after the content wrapped by code symbols `

  • Corresponding Markdown syntax: *Segment 1`Segment 2`Segment 3*

Extended Usage

  • Adding content only after a single-level tag is equivalent to reversing the left-right style of a two-level multi-level tag, example: BeforeTag-A Tag-AAfter

  • Highlight variable styles: For "Segment 2", supported variable formats: {{variable}} %variable% $variable$ ${variable} #{variable} var(variable)

 

Tip

  • Supports adding preset color codes after multi-level tag to specify index-en.mdcolors (default is emphasized style) or index-en.mdgradient colors. If not specified, defaults to T1

  • To modify the default color code, use the "Plugin Adjustment Parameters" badge to specify.

tab

Multi-level Tag Preset Color Code Examples

index-en.mdPreset Color CodeRecommended Application ScenariosRendering Effect
WnWarning, Danger, Critical, DeletionTitleContent {{Variable 1}}Wn TitleContent {{Variable 1}}GradientWnMn
Rd:TitleContent %Variable 2%Rd TitleContent %Variable 2%GradientRdGn
OgReminder, Notice, Vitality, FixTitleContent $Variable 3$Og TitleContent $Variable 3$GradientOgBu
YeAttention, Optimization, Memo, ExplanationTitleContent ${Variable 4}Ye TitleContent ${Variable 4}GradientYeAq
Tu:TitleContent ${Variable 4}Tu TitleContent ${Variable 4}GradientTuVn
LmHint, Memo, Reference, NewTitleContent #{Variable 5}Lm TitleContent #{Variable 5}GradientLmYe
Gn:TitleContent var(Variable 6)Gn TitleContent var(Variable 6)GradientGnRd
Mn:TitleTag ContentMn TitleTag ContentGradientMnAq
Ol:TitleTag ContentOl TitleTag ContentGradientOlOg
AqQuote Block, Icy, AnnouncementTitleTag ContentAq TitleTag ContentGradientAqLm
Sk:TitleTag ContentSk TitleTag ContentGradientSkPk
Cy:TitleValue 1Cy TitleValue 1GradientCyYe
BuInformation, News, OceanTitleValue 2Bu TitleValue 2GradientBuOl
Se:TitleValue 3Se TitleValue 3GradientSeOg
La:TitleValue 4La TitleValue 4GradientLaYe
Vn:TitleValue 5Vn TitleValue 5GradientVnRo
PuExtension, Expansion, Important, ReservedTitleTag ContentPu TitleTag ContentGradientPuYe
Au:TitleTag ContentAu TitleTag ContentGradientAuOg
RoYouthful, Personality, FemaleTitleTag ContentRo TitleTag ContentGradientRoRd
Pk:TitleTag ContentPk TitleTag ContentGradientPkLm
Pl:TitleTag ContentPl TitleTag ContentGradientPlSk
GdVIP, Finance, Engineering, RewardTitleContent {{Variable 1}}Gd TitleContent {{Variable 1}}GradientGdYe
Bn:TitleContent %Variable 2%Bn TitleContent %Variable 2%GradientBnGd
Cf:TitleContent %Variable 2%Cf TitleContent %Variable 2%GradientCfRd
GyRegular, Invalid, Deferred, DisabledTitleContent $Variable 3$Gy TitleContent $Variable 3$GradientGyCy
WtBlack & WhiteTitleContent ${Variable 4}Wt TitleContent ${Variable 4}GradientWtOg
Bk:TitleContent ${Variable 4}Bk TitleContent ${Variable 4}GradientBkOg
T1Selected Theme "Primary Color"TitleContent #{Variable 5}T1 TitleContent #{Variable 5}GradientT1T2
T2Selected Theme "Secondary Color"TitleContent var(Variable 6)T2 TitleContent var(Variable 6)GradientT2T1

More Multi-level Tag Examples

index-en.mdFormatRendering EffectMore Rendering Examples
Three-segmentTitleContent 1Content 2T1H₂+O=H₂OBu Pi3.141592653T2
::Chemical FormulaH₂Ois Water💦Se CircleInternal Angles180 DegreesYe
No Title (Segment 1)Content 1Content 2GyLightOFFGy National DayOctober 1stRd

Markdown FansQI hope to add hyperlinks to tag for easy association with other documents or external information related to the tag

VLOOKAT2 Supports adding hyperlinks to tag. Just select the tag and directly set it according to Markdown hyperlink syntax.

Availability ••• Editing× Not SupportedGy Export HTML✓ SupportedGn

 

Here are tag with hyperlinks, try them out~

VIP Custom ThemeBnGd VLOOK@GitHub VLOOKGitHub@MadMaxChowT1T2 🎁 VIPSubmit My Custom RequirementsBnGdBnGdBn

 

Tip

Since clicking a "tag" is copying tag content, after exporting to HTML, hovering over the tag will show a separate entry to open the link.

 


If you have more needs or suggestions about the above content, feel free to provide feedback at any time~ Feedback via QQ Feedback via Telegram

Progress Bar

Markdown FansQWhen making documents with Markdown, I hope to visualize progress-related information more intuitively

VLOOKAT2 This is really very Easy for VLOOK™, just combine Markdown's "bold, highlight" these two standard formats to achieve it easily

Availability ••• Editing× Not SupportedGy Export HTML✓ SupportedGn

tab

Syntax

  • Set the progress numerical content to the following format combination: first "bold", then "highlight"

  • Corresponding Markdown syntax: **==Progress Value==**

Shortcut

Select the text, then press Cmd / Control + B to set as bold, then press Cmd / Control + ⇧ Shift + H to set as highlight

Supports adding preset color codes after the progress bar to specify colors. If not specified, it will automatically adapt colors based on specific values, as shown in the table below:

Progress Value Explanation

  1. When it's a specific value, directly specify a fixed value, examples:

    • Regular: index-en.md80.5

    • Overflow: index-en.md120 index-en.md-35

  2. When it's ?, automatically calculate the completion progress of all subtasks in the following task list.

index-en.md( The progress during editing is illustrative, the actual progress is subject to the rendering after exporting HTML )index-en.md


Static Progress Bar Examples

Static Progress Bar Different Color Examples

Default Auto-Adapt Colorindex-en.mdSupports Specifying Preset Color Codes==
index-en.md-25Wnindex-en.md5.5Wn
index-en.md0Rdindex-en.md10Rd
index-en.md5Ogindex-en.md15Og
index-en.md19Yeindex-en.md20Ye
index-en.md20Lmindex-en.md25Lm
index-en.md39Gnindex-en.md30Gn
index-en.md40Mnindex-en.md35Mn
index-en.md59Olindex-en.md40Ol
index-en.md60Aqindex-en.md45Aq
index-en.md79Cyindex-en.md50Cy
index-en.md80Buindex-en.md55Bu
index-en.md99Seindex-en.md60Se
index-en.md100Laindex-en.md65La
index-en.md125Vnindex-en.md70Vn
-Gyindex-en.md75Gy
:Bkindex-en.md80Bk
:Puindex-en.md85Pu
:Roindex-en.md90Ro
:Pkindex-en.md95Pk
:Gdindex-en.md100Gd
:Bnindex-en.md120Bn
:T1index-en.md-35T1
:T2index-en.md0T2

Gy

Automatically Calculate Task Item Completion Progress Example

Overall Task Progress index-en.md?

  • 1. Analyze Target Market Demand index-en.md?

    • Survey Target Customer Groups index-en.md?

      • Develop Questionnaire or Face-to-Face Interview Plan

      • Collect Customer Needs and Preference Information for Products or Services

    • Research Competitors index-en.md?

      • Analyze Competitor Products, Pricing Strategies and Market Share

      • Discover Competitor Strengths and Weaknesses, and Compare with Own

  • 2. Collect Market Data index-en.md?

    • Consult Industry Reports and Data index-en.md?

      • Consult Industry Reports and Statistics Released by Industry Associations

      • Collect Information on Industry Trends and Development Forecasts

    • Analyze Market Trends index-en.md?

      • Process Market Data Through Data Analysis Tools or Software

      • Discover and Explain Market Trends to Guide Project Decisions

Gy


If you have more needs or suggestions about the above content, feel free to provide feedback at any time~ Feedback via QQ Feedback via Telegram

Markdown FansQWhen writing tutorials or guidance documents, for menu sequences, step operations, directory hierarchies and other contents, I hope to have simple and efficient typesetting

VLOOKAT2 This is really very Easy for VLOOK™, just combine Markdown's "italic, highlight" these two standard formats to achieve easily.

Availability ••• Editing✓ SupportedGn Export HTML✓ SupportedGn

 


Syntax

  • Set the breadcrumb content to the following format combination: first "italic", then "highlight"

    Shortcut

    Select content, then press Cmd / Control + i to set as italic, then press Cmd / Control + ⇧ Shift + h to set as highlight

  • Corresponding Markdown syntax: *==This is breadcrumb content==*

  • Supported segment symbols: > / \ -> ▶︎

  • During editing previews main style, and after exporting to HTML supports:

    • Automatically optimize style for "segment symbols"

    • Click to copy its original information

Caution

  • When the entire paragraph contains only breadcrumb content, it will be prioritized as caption format for "tables/illustrations/code blocks/multimedia" etc.;

  • Breadcrumb starting content cannot contain formatting (like bold, italic) or text links.

 

  1. This describes menu sequence example: Menu > File > Export > Export Configuration, can also add text links for certain operations as needed

  2. This describes step operation example: Login Account ▸ Preferences ▶︎ Modify Personal Information, can be used to show entry guidance for target operations

  3. This describes directory hierarchy example: /Root Directory/Subdirectory 1/Subdirectory 1.1, C:\Program Files\Applications

Breadcrumbs in Tables Example

Directory Hierarchy Example in Table (Non-exclusive)Menu Sequence in Table (Exclusive)
Directory: /Root Directory/Subdirectory 1/Subdirectory 1.1Menu -> File → Export > Export Configuration

If you have more needs or suggestions about the above content, feel free to provide feedback at any time~ Feedback via QQ Feedback via Telegram

Scratch Card

Markdown FansQWhen making training documents with Markdown, hope to hide 'answers' like Scratch Card, only showing when clicked

VLOOKAT2 This is really very Easy for VLOOK™, just combine Markdown "italic, bold" these two standard formats to achieve easily.

Availability ••• Editing✓ SupportedGn Export HTML✓ SupportedGn

 

Syntax

  1. Set content to be hidden to following format combination: first "italic", then "bold"

Shortcut

Select content, then press Cmd / Control + i to set as italic, then press Cmd / Control + b to set as bold

  1. Hint text defaults to ••••Bk! , to specify just add directly before bold

  • Corresponding Markdown syntax: *Hint Text**Hidden Content***

(Supports adding preset color codes after scratch card to specify color, defaults to Gy if not specified)

Tip

To modify default color code, use "Plugin Adjustment Parameters" coating to specify.

Scratch Card Examples
index-en.mdPreset Color CodeRendering Effect
(Uses default when not specified)index-en.mdThis is scratch card without specified hint
:Favorite bamboo-eating animal?Panda
RdPer sistenceRd Un remittingRd
Og"Good night" in Cantonese?早[zou2] 唞[tau5]Og
YeWater」in English Me???Meter ❌Ye Wa???Water ✅Ye
TuWater」in English Me???Meter ❌Tu Wa???Water ✅Tu
LmHow to say "thank you" in English?Thank youLm
GnAppSecret Application Keycf67c3839f0214dcGn
AqThird planet in solar system?EarthAq
SkLargest island on Earth?GreenlandSk
CyLargest ocean on Earth?PacificCy
BuLargest of 7 continents?AsiaBu
SeWorld's highest peak?Mount EverestSe
VnLargest human organ?SkinVn
PuSmallest planet?MercuryPu
AuSmallest planet?MercuryAu
RoCountry with most islands?NorwayRo
PkWhich city is famous for its leaning tower?PisaPk
PlWhich city is famous for its leaning tower?PisaPl
GdLongest river?NileGd
BnLargest planet in solar system?JupiterBn
CfLargest planet in solar system?JupiterCf
GyWorld's deepest trench?MarianaGy
T1World's largest freshwater lake?BaikalT1
T2World's largest land mammal?African ElephantT2

If you have more needs or suggestions about the above content, feel free to provide feedback at any time~ Feedback via QQ Feedback via Telegram

Phonetic Notation

Superscript Phonetic Notation

Markdown FansQHope Markdown documents can conveniently add phonetic notation (like: pinyin, foreign language comparison), so my language training documents and e-books can be more outstanding

VLOOKAT2 By extending Markdown superscript syntax ^ ^, easily meets practical "phonetic notation" typesetting needs!

Availability ••• Editing✓ SupportedGn Export HTML✓ SupportedGn

 

Syntax

  • Add corresponding phonetic notation content after any character needing phonetic notation, and set this content to following format combination: First "italic", then "superscript"

  • Corresponding Markdown syntax: _^Phonetic Notation^_

tab

Important

To distinguish Typora's default single asterisk *italic* marked italics, italic in color codes recommends using Markdown's other italic mark syntax: underscore _italic_

Note

After exporting HTML, effect equals HTML 5 index-en.mdruby, index-en.mdrp, index-en.mdrt tag, and supports online definition or translation when clicking phonetic notation.

Phonetic Example-1

Waydào begets one; one begets two; two begetsshēng three; three begets myriadwàn thingsBuRoGn」── Dao De Jing•Laozi

Phonetic Example-2

Multilingual Phonetic Application Example_Chinese/Japanese/Korean/English_

CategoryFollowing is Markdown Format ContentRendering Effect
Phonetic道_^ㄉㄠ^_ 德_^ㄉㄜ^_ 经_^ㄐㄧㄥˉ^_ㄉㄠㄉㄜㄐㄧㄥˉ
Mandarin道_^dào^_ 德_^dé^_ 经_^jīng^_dàojīng
Cantonese道_^dou^_ 德_^däk^_ 经_^gïng^_doudäkgïng
Japanese鳥_^とり^_山_^やま^_ 明_^あきら^_とりやまあきら
Korean대_^Dae^_ 한_^Han^_ 민_^Min^_ 국_^Gug^_DaeHanMinGug

Chinese Phonetic Online Definition Service

When phonetic notation content is index-en.mdChinese, provided by 汉典

  • Click phonetic to open "汉典" official site, show corresponding "character" definition

Rd!

Non-Chinese Phonetic Online Translation Service

When phonetic notation content is index-en.mdnot Chinese, provided by Bing

  • Click phonetic to open "Bing Translator" official site, automatically translate Japanese "kana" parts

  • Other cases, translate the "character" being annotated

Bu!

Code-style Phonetic Notation

Availability ••• Editing× Not SupportedGy Export HTML✓ SupportedGn

Caution

Code-style phonetic notation is old phonetic syntax, not recommended for new documents!

This feature only supports existing documents, or when needing to add same phonetic notation to multiple characters simultaneously. Future versions may remove support for this syntax.

 


Syntax:`{text}(symbol)`

  • text: Characters needing "phonetic notation, pinyin, annotation"

  • symbol: Corresponding phonetic notation, pinyin symbols, or annotation content

After exporting HTML, effect equals HTML 5 index-en.mdruby, index-en.mdrp, index-en.mdrt tag, and supports online definition or translation when clicking phonetic notation.

Gy

Phonetic Example-1

{道}(dào)生一,一生二,二{生}(shēng)三,三生{万物}(wàn wù)」── 道德经•老子

Phonetic Example-2

Multilingual Phonetic Application_Chinese/Japanese/Korean/English_

CategoryFollowing is Markdown Format ContentRendering Effect
Phonetic`{道}(ㄉㄠˋ)` `{德}(ㄉㄜˊ)` `{经}(ㄐㄧㄥˉ)`{道}(ㄉㄠˋ) {德}(ㄉㄜˊ) {经}(ㄐㄧㄥˉ)
Mandarin`{道}(dào)` `{德}(dé)` `{经}(jīng)`{道}(dào) {德}(dé) {经}(jīng)
Cantonese`{道德经}(dou däk gïng)`{道德经}(dou däk gïng)
Japanese`{鳥山}(とりやま)` `{明}(あきら)`{鳥山}(とりやま) {明}(あきら)
Korean`{대 한 민 국}(Dae Han Min Gug)`{대 한 민 국}(Dae Han Min Gug)
Chinese-English`{道德经}(The Scripture of Ethics)`{道德经}(The Scripture of Ethics)
English-Chinese 1`{The Scripture}(经)` of `{Ethics}(道德)`{The Scripture}(经) of {Ethics}(道德)
English-Chinese 2`{The Scripture of Ethics}(道德经)`{The Scripture of Ethics}(道德经)

If you have more needs or suggestions about the above content, feel free to provide feedback at any time~ Feedback via QQ Feedback via Telegram

°Mermaid

Tip

More scripted chart styles, and script writing specifications combined with VLOOK™ related content详见《Scripted Charts for Markdown》。

Mermaid Style Optimization & Extension

Markdown FansQIf don't like Mermaid's default styles, and hope to automatically adapt to Dark Mode, what to do?

VLOOKAT2 Automatically provides deep style optimization.

Availability ••• Editing✓ SupportedGn Export HTML✓ SupportedGn

 

Unified and Optimized Styles

  • Automatically optimizes styles for various Mermaid charts, and supports Dark Mode

  • Following are some examples, more scripted chart examples详见这里 ❯❯

Mermaid Flowchart

Flowchart Example(Above "Branch Flow" content continued by below chart)

子图

子图的子图

分支

分支

分支

重要分支

条件1

条件2

条件3

条件4

开始

❤ 准备

节点

可选

子流程

存档

A
(同页)

数据

文件

双圈圆
点击可访问
GitHub

判断?

结束

手工输入

手动操作

B (离页)

A
(同页)

Branch Flow Example (Continuing from Above Diagram)

B (离页)

节点

结束

Mermaid Class Diagram

Class Diagram Example

Inheritance
继承

Composition
组合

Aggregation
聚合

Association
关联

Link (Solid)

Dependency
依赖

Realization
实现

Link (Dashed)

*

*

n

1

«interface»

classA

+public attribute

-private attribute

#protected attribute

~package attribute

+public method()

-private method()

#protected method()

~package method()

classB

«enumeration»

classC

Red

Blue

Green

WHITE

BLACK

classD

classE

classF

classG

classH

classI

classJ

classK

classL

classM

classN

classO

classP

类图示例

对 classE 类的说明

Mermaid Mind Map

Mind Map Example

Mindmap

Origins

📓 Long history

Popularisation

British popular psychology author Tony Buzan

Origins 2

Popularisation 2

Research

🍺 On effectiveness
and features

On Automatic
creation

Uses

Creative techniques

Strategic planning

Argument mapping

Research 2

Tools

Pen and paper

Mermaid

Tools 2

Pen and paper 2

Tools 3

Mermaid's Sequence Diagram

Markup Extensions for "Sequence Diagrams"

  • Supports marking different types of roles (important systems, external systems) to present different styles

  • Optimizes the appearance of loopCy alt / elseVn optPu parOg criticalRd breakBk tag with different styles, and automatically translates them based on the browser's current language

  • For more details about markup extensions, see here ❯❯

Sequence diagram with multiple different roles, clearer and more friendly

--外部系统角色**重要系统角色普通系统前端触点--外部系统角色**重要系统角色普通系统前端触点break[例外情况]par[平行消息]显示在外部系统左侧备注说明显示在外部系统右侧备注说明跨对象备注说明alt[默认情况][非默认情况]opt[可选]critical[必须执行][可选情况A][可选情况B]loop[循环]人物角色并行发送消息11中断处理消息2并行发送消息33发送消息4内部动作5发送消息A6默认情况消息A17非默认消息A28发送消息X9必须执行消息10执行可选消息A11执行可选消息B12人物角色

Tip

More scripted chart styles, and script writing specifications combined with VLOOK™ related content详见《Scripted Charts for Markdown》。

Mermaid Caption & Auto-numbering

About caption and auto-numbering for Mermaid diagrams

 

Click here for details ❯❯

 


For feedback: Feedback via Email Feedback via QQ Feedback via Telegram

°Formula

More Practical & Beautiful Formula

Availability ••• Editing✓ SupportedGn Export HTML✓ SupportedGn

Inline Mixed Formula

This is an inline mixed "mathematical formula" limxexpx=0, it can also be a "chemical formula" $\boxed{\ce{CH4 + 2 (OA2+7921NA2)}}$

Check the LaTeX code for the above inline formulas

Mathematical formula code: $\lim_{x \to \infty} \exp{-x} = 0$

Chemical formula code: $\ce{CH4 + 2 $\left( \ce{O2 + 79/21 N2} \right)$}$

Standalone formula block (```math syntax)

(1)x=b±b24ac2a
Check the Gitlab/GitHub style code for the above formula

 

Standalone formula block ($$ syntax)Second caption

y=y(x,t)=Aeiθ(My Math - 1)=A(cosθ+isinθ)=A(cos(kxωt)+isin(kxωt))=Acos(kxωt)+iAsin(kxωt)(My Math - 2)=Acos(2πλx2πvλt)+iAsin(2πλx2πvλt)(My Math - 3)=Acos2πλ(xvt)+iAsin2πλ(xvt)

You can also index-en.mdreference block formula numbers for navigation, for example refer to formula: My Math - 1

°Multimedia

Streaming Platforms

Markdown FanQ "I wish Markdown could embed videos from mainstream streaming platforms."

VLOOKAT2 To better leverage the rich video resources available on mainstream streaming platforms (such as Bilibili, Xigua Video, and YouTube), VLOOK™ provides optimized theme styling and enhanced support.

Availability ••• Editing✓ SupportedGn Export to HTML✓ SupportedGn

Tip

Embedded videos from streaming platforms also support captions and automatic numbering, using the same approach as for tablesLearn More ❯

Bilibili Videos

Embedded Bilibili Video (Landscape)

How do I get the Bilibili video embed code?

Get Bilibili Embed Code

(If the video cannot be played after exporting to HTML, please check whether the src value in the embed code is missing the https: prefix. Add it manually and try again.)

Since Bilibili videos autoplay by default, you can disable this behavior by appending autoplay=0 to the end of the src URL in the embed code, as shown below:

Example of disabling autoplay

Why can't embedded Bilibili videos be played when opening the exported HTML locally?

This is because the video URL (src) in the embed code provided by the Bilibili website does not include the https: prefix. Simply add it manually.

Douyin Videos

Embedded Douyin Video (Portrait)

How do I get the Douyin video embed code?

Although Douyin does not officially provide an embed code like Bilibili, you can use the Bilibili embed code as a template and simply replace the src value with the Douyin video streaming URL.

The Douyin streaming URL specifies the target video using the vid parameter. You can obtain this identifier by opening the video from the Douyin homepage in a desktop browser, then copying the value following modal_id= from the address bar. For example:

Browser address after opening a Douyin video

Douyin video embed code template

Tip

Videos from all streaming platforms are displayed in landscape mode by default. To display a video in portrait mode, simply append #pt to the end of the src URL in the embed code.

Tencent Video

Embedded Tencent Video

How do I get the Tencent Video embed code?

Get Tencent Video Embed Code

Standard Videos

Markdown FanQ "I wish Markdown could support videos, so I could create multimedia documents."

VLOOKAT2 Most Markdown tools still do not provide native support for videos, but now it can be achieved with almost zero additional effort!

Availability ••• Editing× Not SupportedGy Export to HTML✓ SupportedGn

The syntax is exactly the same as the Markdown image syntax!

  • Syntax: ![Top video caption](Video URL "Bottom video caption")

  • Example: ![This is a video](video.mp4)

  • Supported video formats: Ogg (.ogv), MPEG4 (.mp4), WebM (.webm)

Video Example

In addition to standard video controls, W3C-standard control features are also supported!

This is achieved by appending VLOOK™-specific parameters to the video URL, as described below:

Advanced Video Control Options

Customizable FeatureURL ParameterExample
Enable autoplayautoplay=true 
Enable loop playbackloop=true 
Enable preloadpreload=truePreloaded Video Example
Specify video widthwidth=<pixels>Specifies the video width (unit: px)
Specify video heightheight=<pixels>Specifies the video height (unit: px)

Example of Embedding a <video> Tag

Tip

  • Since the syntax is the same as for images, adding captions and automatic numbering to videos follows the same approach as images … Learn More ❯

  • If you use an embedded <video> tag, captions and automatic numbering follow the same approach as tables … Learn More ❯

Note

If you have any questions about using URL parameters or URL anchors, please refer to Extended Image URL Usage for more details.

Audio

Markdown FanQ "I wish Markdown could support audio, so I could create audiobooks and multimedia documents."

VLOOKAT2 Most Markdown tools still do not provide native support for audio, but now it can be achieved with almost zero additional effort!

Availability ••• Editing× Not SupportedGy Export to HTML✓ SupportedGn

The syntax is exactly the same as the Markdown image syntax!

  • Syntax: ![Top audio caption](Audio URL "Bottom audio caption")

  • Example: ![This is audio](audio.mp3)

  • Supported audio formats: MP3 (.mp3), Ogg (.ogg), WAV (.wav), M4A (.m4a)

Want to try a different audio player interface?

By default, audio is displayed using the browser's standard player. VLOOK™ also supports a customizable "Mini" player interface. AMAZING!

This is achieved by appending a VLOOK™ parameter to the audio URL:

  • URL parameter: controls=mini

  • Example: media/whistle.mp3?controls=mini

Standard Player Example

The audio player uses the standard interface by default

Mini Player Example

◄ Click to Play

In addition to standard audio controls, W3C-standard control features are also supported!

This is achieved by appending VLOOK™-specific parameters to the audio URL, as described below:

Advanced Audio Control Options

Customizable FeatureVLOOK™ URL ParameterExample
Enable the Mini playercontrols=mini
Enable Play / Pause mode
(Default: Play / End)
pause=true
⚠️NoteRd! Available only in Mini mode
Display audio durationduration=true
⚠️NoteRd! Available only in Mini mode
Enable autoplayautoplay=true
Enable loop playbackloop=trueLoop Playback Example
Enable preloadpreload=truePreload Example
Example of Embedding an <audio> Tag

Tip

  • Since the syntax is the same as for images, adding captions and automatic numbering to audio follows the same approach as images … Learn More ❯

  • If you use an embedded <audio> tag, captions and automatic numbering follow the same approach as tables … Learn More ❯

Note

If you have any questions about using URL parameters or URL anchors, please refer to Extended Image URL Usage for more details.

Captions and Automatic Numbering

Captions and automatic numbering for multimedia content

Learn More ❯❯