README.md

April 19, 2026 · View on GitHub

English | 简体中文

Typora Plugin

typora_plugin

Ask DeepWiki

#PluginFunctionEnabled by Default
1window_tabWindow Tab Bar
2search_multiMulti-Fields File Searcher
3collapse_paragraphChapter Folding×
4collapse_listList Folding×
5collapse_tableTable Folding×
6md_paddingChinese-English Text Spacer
7slash_commandsSlash Commands
8mouse_gesturesMouse Gestures×
9templaterFile Templater
10resource_managerResource Management
11fence_enhanceEnhance Fence
12right_outlineRight Outline
13commanderCommander
14command_paletteCommand Palette
15right_click_menuRight-Click Menu
16pie_menuPie menu×
17datatablesEnhance Table×
18preferencesPreferences
19markmapProvides Markmap support
20echartsProvides Echarts support
21chartProvides Chart.js support
22drawIOProvides DrawIO support
23abcProvides abc.js support
24calendarProvides tui.calendar support
25wavedromProvides WaveDrom support
26marpProvides Marp support
27plantUMLProvides PlantUML support×
28calloutsProvides Callouts support
29text_stylizeText stylization
30read_onlyRead-only mode
31blurBlur mode
32kanbanKanban
33timelineTimeline
34chatChat
35auto_numberAuto numbering
36image_viewerImage viewer
37cjk_symbol_pairingCJK Symbol Pairing
38resize_tableTable Resizer
39resize_imageImage Resizer
40export_enhanceAvoid image loss when exporting to HTML
41sidebar_enhanceDrag & drop to rearrange、Display non-Markdown files、Keep Fold State
42markdownlintMarkdownlint Check
43truncate_textHide content to improve performance for large files×
44darkDark mode
45no_imageNo image mode
46myopic_defocusDefocus Comfort Mode
47updaterOne-click plugin update
48easy_modifyEditing tools
49editor_width_sliderAdjust writing area width
50asset_root_redirectResource Redirection×
51bookmarkBookmark manager×
52cipherEncrypt files×
53ripgrepSearch files using ripgrep×
54article_uploaderOne-click upload blog to supported platforms×
55cursor_historyCursor History×
56static_markersStatic Markers×
57customOpen platform for user-defined plugins (Advanced)
58hotkeysHotkey registration center (Advanced)
59action_buttonsAdd function buttons in the lower right corner (Advanced)
60json_rpcTypora Automation (Advanced)×

If you have other needs or find bugs, feel free to open an issue. PRs are also welcome. If you find this project helpful, please give me a star ⭐

Q&A

  • Is my Typora supported? Typora's version should be ≥ 0.9.98 (the last free version).
  • How to modify plugin configurations? Right-click menu -> Interactive Plugins -> Preferences. Respect all user choices. Any plugin or feature can be permanently enabled/disabled.
  • How to upgrade plugins? Right-click menu -> Interactive Plugins -> Preferences -> Check for Updates.
  • How to uninstall plugins? Right-click menu -> Interactive Plugins -> Preferences -> Uninstall Plugins.
  • How to develop plugins? No Build Time, No need to install development environment. Please refer to Readme for details.
  • Does it support Typora for Mac? I don't have a Mac device, so I haven't tested it.
  • Any other questions? Please ask AI Wiki.

How to Use: Windows/Linux Platform

Visit Video Installation Tutorial

  1. Download the plugin source code package and unzip it.

  2. Go to the Typora installation path and find the folder A containing window.html.

    • For the official version of Typora, the path is ./resources/window.html.

    • For the beta version of Typora, the path is ./resources/app/window.html.

  3. Paste the unzipped plugin folder into folder A.

  4. Go to the folder A/plugin/bin/.

    • Windows: Right-Click on the file installw_windows.ps1. Select 'Run with PowerShell'.
    • Linux: Run install_linux.sh as administrator.
  5. Verification: Restart Typora, right-click in the main text area, and if you see the plugin items, everything is fine.

Official VersionBeta Version
Steps 2-3typora_dir_newtypora_dir_old
WindowsLinux
Step 4install_windowsinstall_linux

How to Use: Archlinux Platform

Currently, this method is only for the Archlinux platform, see aur/typora-plugin

yay -S typora-plugin

Plugin Usage Instructions

All plugins provide seven usage methods:

  • Keyboard enthusiasts:
    • Command Palette (see command_palette plugin)
    • Slash commands (see slash_commands plugin)
    • Shortcut keys (see hotkeys plugin)
  • Mouse enthusiasts:
    • Right-click in the main text area (see right_click_menu plugin)
    • Mouse gestures (see mouse_gestures plugin)
    • Quick buttons (see action_buttons plugin)
    • Pie menu(see pie_menu plugin)

window_tab

window_tab

search_multi

By using Google search syntax and combining different criteria to accurately search for files.

search_mutli

collapse_paragraph

collapse_paragraph

collapse_list

Fold/expand unordered lists, ordered lists, task lists.

collapse_table

Fold/expand tables.

md_padding

Add spaces between Chinese and English, Chinese and numbers when mixed.

md_padding

slash_commands

Similar to Notion's slash command.

slash_commands

mouse_gestures

Mouse gestures in Typora.

templater

Similar to Obsidian's file template function, quickly create files based on templates.

templater

resource_manager

Resource management, cleanup of unused images

fence_enhance

fence_enhance

right_outline

Typora's sidebar cannot display both [File] and [Outline] simultaneously. To solve this problem, this plugin adds an [Outline] on the right.

commander

commander

markmap

markmap

command_palette

Similar to VSCode's command palette (Ctrl+Shift+P)

command_palette

right_click_menu

All plugins support direct invocation through the right-click menu. Mouse enthusiasts can use the right-click menu as the main way to call all plugins.

pie_menu

Pie Menu. Usage:

  • Open circular menu: Ctrl + right mouse button
  • Rotate circular menu: Middle mouse button
  • Pin the circular menu, so it doesn't automatically disappear: Left mouse button in the middle of the circle
  • Expand the circular menu, so it doesn't automatically collapse: Right mouse button in the middle of the circle

preferences

Preferences

echarts

echarts

chart

chart

drawIO

drawIO

abc

abcjs

calendar

calendar

wavedrom

wavedrom

marp

Use markdown to create PPT.

plantUML

plantUML

Due to the B/S architecture of plantUML, a rendering server is required. Suggest using Docker to install:

docker pull plantuml/plantuml-server:jetty
docker run -d --name plantuml-server -p 8080:8080 plantuml/plantuml-server:jetty

callouts

callouts

kanban

kanban

timeline

timeline

chat

chat

text_stylize

text_stylize

read_only

In read-only mode, the document cannot be edited (after enabling, the bottom right corner of the statistics area will show ReadOnly).

blur

After enabling, only the currently focused component is visible, the rest are blurred. It can be used to prevent peeking.

This plugin can only be used with the official version of Typora.

auto_number

auto_number

Unlike other implementations using theme CSS, this plugin perfectly solves the problem of no numbering in the sidebar after exporting to PDF by modifying the built-in function :)

image_viewer

One-stop image viewing, and provides simple image editing.

image-reviewer

cjk_symbol_pairing

Automatically pair symbols when typing 《 【 ( ‘ “ 「.

datatables

Enhance tables. Provides functions such as search, filter, pagination, and sorting.

Usage: Place the cursor on the table -> Right-click menu -> Interactive Plugins -> Table Enhancement.

datatables

resize_table

ctrl + mouse drag: Modify the row height and column width of the table.

resize_table

resize_image

alt + mouse scroll: Adjust the image size.

export_enhance

When exporting HTML, convert images to base64 to avoid image loss.

  • Drag & drop outline to rearrange
  • Display non-Markdown files in the sidebar
  • Keep Fold Outline State
  • Customize Sidebar File Icons
  • Display File Count

dark

Dark Mode

no_image

No Image Mode

myopic_defocus

Defocus Comfort Mode

markdownlint

Check whether the current file complies with the markdown best practices.

updater

Upgrade Plugin.

easy_modify

This plugin is a collection of commonly used editing tools, currently including:

  1. Copy title path
  2. Promote the title level of the selected paragraph
  3. Demote the title level of the selected paragraph
  4. Convert line break CRLF to LF
  5. Convert line break LF to CRLF
  6. Remove invisible characters
  7. Generate mind map based on the document outline: mindmap
  8. Generate mind map based on the document outline: graph
  9. Extract selected text to a new file
  10. Add trailing spaces

editor_width_slider

Adjust the width of the writing area.

asset_root_redirect

If you mainly use Obsidian or Joplin to manage files and occasionally use Typora to open files, you will encounter a problem: both Obsidian and Joplin put local resources in the same directory, but Typora defaults to using relative paths to reference local resources.

This plugin is disabled by default and needs to be manually enabled.

bookmark

Usage:

  1. Use alt + click on the text content to bookmark.
  2. This will automatically bring up the bookmark manager. Click on the bookmark above to jump to the bookmark.

cipher

Encrypt File.

truncate_text

The rendering performance of large files in Typora is very poor. Use this plugin to temporarily hide content (just hide the display, not modify the file) to improve rendering performance. It can also be used to prevent peeking.

Principle: By setting the display style of DOM elements to none, elements are hidden so that they do not occupy a position in the rendering tree, and operations on hidden elements do not cause reflow of other elements.

ripgrep

Typora comes with ripgrep. This plugin supports using the built-in ripgrep to search files.

To use this plugin, you need to be familiar with the ripgrep tool. This plugin is disabled by default and needs to be manually enabled.

cursor_history

  • hotkey for the previous cursor: alt+←
  • hotkey for the next cursor: alt+→

This plugin is disabled by default and needs to be manually enabled.

static_markers

Say goodbye to distracting format refreshes. This plugin keeps your Markdown syntax markers always visible and static.

This plugin disables the auto-hiding feature for syntax markers in WYSIWYG mode. It ensures that all Markdown characters—like **, ##, and _—remain persistently visible around your text, just as they would in a source code editor.

static_markers

This plugin is disabled by default and needs to be manually enabled.

hotkeys

This plugin is an advanced plugin, only available to users with a JavaScript background.

Bind hotkeys to [any plugin system function] or [any custom function] in a declarative form.

action_buttons

This plugin is an advanced plugin, only available to users with a JavaScript background.

Similar to hotkeys, set function buttons for [any plugin system function] in a declarative form.

custom

This plugin is an advanced plugin, only available to users with a JavaScript background.

Provide open capabilities, support users to write their own plugins.

For specific usage, please refer to README.md.

json_rpc

Expose all capabilities including the typora-plugin in the form of json-rpc for external manipulation of Typora.

For specific usage, please refer to README.md.

This plugin is an advanced plugin, only available to developers. After enabling this plugin, the external will have both node and browser environments, which can fully control the computer, so if you are not a developer, please do not enable it.

article_uploader

The user clicks or uses a shortcut key to trigger the automatic publishing function of the current article. The program automatically publishes blog articles to major platforms according to user configuration.

For specific usage, refer to: README.md. Taking uploading to CSDN as an example, the GIF is as follows:

CSDN Success Demonstration

Acknowledgements

Conclusion

This project follows the MIT license, feel free to enjoy it.

If you find it useful, please give it a star ⭐, and feel free to recommend it to like-minded friends.