English | 简体中文

A community plugin system for Typora. Inspired by Obsidian plugin system.

WARNING: Third-party plugins may have data or privacy risks.

To be on the safe side, install an open source plugin that can review the source code.

• installer: Inject loader to Typora.
• loader: Decide to load which core (production or development).
• core: Setup an environment for extending Typora and managing plugins.
• types: Types of Typora global variables.
• esbuild-plugin: Build core or plugin with esbuild.

• Plugin Manage
  • Install/Uninstall/Update plugin
  • Enable/Disable plugin
• New UI components
  • Ribbon
  • (Virtual) Multi File Tabs
• Custom command hotkey
• APIs to extend Typora
  • Markdown preprocessor
  • Markdown postprocessor
  • Markdown suggestion
• I18n: follow system or manual configure, now support English and Chinese
• Compatible with macOS
• Documentation
  • User documentation
  • Developer documentation

Ribbon & Multi File Tabs	Command Panel
Settings Modal	Plugin Marketplace

1. Download Release typora-community-plugin.zip.
2. Unzip it.
3. Run install.ps1 (only for Windows) as Admin to install.
   If you want to install it for custom Typora installed directory, run install.ps1 -root <TyporaHome> as Admin.

for Windows

1. Download Release typora-community-plugin.zip.
2. Unzip it.
3. Copy files to %UserProfile%/.typora/community-plugins.
4. Create a symlink. Run cmd as admin, and run command mklink /d %UserProfile%\\AppData\\Roaming\\Typora\\plugins %UserProfile%\\.typora\\community-plugins.
5. Modify {TyporaHome}/resources/window.html. Open the file with encoding UTF-8, then replace text </body></html> at the end of file as <script src="typora://app/userData/plugins/loader.js" type="module"></script></body></html>.

for Linux

1. Download Release typora-community-plugin.zip.
2. Unzip it.
3. Copy files to ~/.config/Typora/plugins.
4. Modify /usr/share/typora/resources/window.html. Open the file with encoding UTF-8, then replace text </body></html> at the end of file as <script src="typora://app/userData/plugins/loader.js" type="module"></script></body></html>.

for macOS

1. Download Release typora-community-plugin.zip.
2. Unzip it.
3. Copy files to /Users/{UserName}/Library/Application%20Support/abnerworks.Typora/plugins.
4. Right click Typora.app, then click menu item "Show Package Contents" to open the app inner folder. Modify Typora.app/Contents/Resources/TypeMark/index.html. Open the file with encoding UTF-8, then replace text </body> at the end of file as <script src="file:///Users/{UserName}/Library/Application%20Support/abnerworks.Typora/plugins/loader.js" type="module"></script></body>, and {UserName} need to be replaced with your current user name of macOS.

PS: After installation, Ribbon & Multi File Tabs will be shown by default. You can hide them in the Setting Modal.

See How to uninstall

Welcome to create pull requests.

If you have any problem or suggestion please open an issue here.