Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

https://github.com/typora-community-plugin/typora-community-plugin

Typora plugin system for enhancing your editing experience. | 增强 Typora 编辑体验的社区插件系统。
https://github.com/typora-community-plugin/typora-community-plugin

typora typora-community-plugin typora-extension typora-plugin

Last synced: 5 months ago
JSON representation

Typora plugin system for enhancing your editing experience. | 增强 Typora 编辑体验的社区插件系统。

Awesome Lists containing this project

README 

          
# Typora Community Plugin



English | [简体中文](https://github.com/typora-community-plugin/typora-community-plugin/blob/main/README.zh-CN.md)



A community plugin system for [Typora](https://typora.io/). Inspired by [Obsidian plugin system](https://docs.obsidian.md/Home).



**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.



## Preview



| Ribbon & Workspace                    | Command Panel                             |

| :-----------------------------------: | :---------------------------------------: |

| ![](./docs/assets/base.jpg)           | ![](./docs/assets/command-modal.jpg)      |

| Settings Modal                        | Plugin Marketplace                        |

| ![](./docs/assets/settings-modal.jpg) | ![](./docs/assets/plugin-marketplace.jpg) |



## Compatible



| Tested |                  |                  |                     |

| :----: | ---------------- | ---------------- | ------------------- |

| Typora | v1.1.x - v1.12.x | v1.5.x - v1.12.x | v1.4.8 - v1.12.x    |

| OS     | Windows 10       | Ubuntu 22        | macOS 10.13, 14, 15 |



## Features ([CHANGELOG](./docs/en-us/user-guide/CHANGELOG.md))



- Plugin Manage

  - [x] Install/Uninstall/Update plugin

  - [x] Enable/Disable plugin

- New UI components

  - [x] Ribbon

  - [x] Workspace `New`

    - [x] (Virtual) Multi File Tabs

    - [x] Split View `New`

- [x] Custom command hotkey

- [x] I18n: follow system or manual configure, now support English and Chinese

- [x] Compatible with macOS



### Plugins



You can [install plugins](./docs/en-us/user-guide/2-plugin-installation.md) from the Plugin Marketplace:



| Plugins                          | Description                                               |

| -------------------------------- | --------------------------------------------------------- |

| [abcjs][p12]                     | Use ABC music notation in codeblock.                      |

| [callout][p1]                    | Support Obsidian-like Callout `> [!type]`.                |

| [code-folding][p14]              | Make your codes foldable.                                 |

| [codeblock-copy-button][p2]      | Add a copy button to each codeblock's top-right corner.   |

| [codeblock-highlight-mapper][p3] | Map language A to language B for highlighting it.         |

| [collapsible-section][p4]        | Fold/unfold markdown section. Supports headings, list, codeblock, table, quoteblock, callout. |

| [darkmode][p13]                  | General dark mode for any theme.                          |

| [file-icon][p5]                  | Show different icon for different file type in file tree. |

| [footnotes][p18]                 | Footnote marker suggestion & Re-index the numerical footnotes. |

| [front-matter][p6]               | Auto edit front matter.                                   |

| [image-location][p15]            | Resolve image's location relative to vault's root.        |

| [image-viewer][p16]              | View all the images in current Markdown.                  |

| [markmap][p11]                   | Support Markmap in codeblock.                             |

| [note-refactor][p7]              | Extract selection to new file.                            |

| [note-snippets][p8]              | Use slash command to autocomplete note snippets.          |

| [styled-text][p21]               | Decorate the text matching RegExp.                        |

| [tag][p9]                        | Support tag like `#tag`.                                  |

| [templater][p19]                 | Create notes from templates.                              |

| [trigger][p20]                   | Set a trigger for the command to execute automatically.   |

| [wavedrom][p17]                  | Support WaveDrom in codeblock.                            |

| [wikilink][p10]                  | Support wikilink like `[[text]]`.                         |



## User Documentation



- [How to install](./docs/en-us/user-guide/1a-installation.md)

- [Install plugin in Marketplace](./docs/en-us/user-guide/2-plugin-installation.md)

- [How to uninstall](./docs/en-us/user-guide/1b-uninstall.md)



### Hotkeys



| Hotkey                      | Function            |

| --------------------------- | ------------------- |

| F1               | Open Command Panel  |

| Ctrl+.| Open Settings Modal |



## Development Documentation



See [Development Documentation](./docs/en-us/dev-guide/0-dev-docs.md) or [Getting Started](./docs/en-us/dev-guide/1-getting-started.md)



## Contributing



Welcome to create pull requests.



## Support



If you have any problem or suggestion please open an issue [here](https://github.com/typora-community-plugin/typora-community-plugin/issues).



[p1]: https://github.com/typora-community-plugin/typora-plugin-callout

[p2]: https://github.com/typora-community-plugin/typora-plugin-codeblock-copy-button

[p3]: https://github.com/typora-community-plugin/typora-plugin-codeblock-highlight-mapper

[p4]: https://github.com/typora-community-plugin/typora-plugin-collapsible-section

[p5]: https://github.com/typora-community-plugin/typora-plugin-file-icon

[p6]: https://github.com/typora-community-plugin/typora-plugin-front-matter

[p7]: https://github.com/typora-community-plugin/typora-plugin-note-refactor

[p8]: https://github.com/typora-community-plugin/typora-plugin-note-snippets

[p9]: https://github.com/typora-community-plugin/typora-plugin-tag

[p10]: https://github.com/typora-community-plugin/typora-plugin-wikilink

[p11]: https://github.com/typora-community-plugin/typora-plugin-markmap

[p12]: https://github.com/typora-community-plugin/typora-plugin-abcjs

[p13]: https://github.com/typora-community-plugin/typora-plugin-darkmode

[p14]: https://github.com/typora-community-plugin/typora-plugin-code-folding

[p15]: https://github.com/typora-community-plugin/typora-plugin-image-location

[p16]: https://github.com/typora-community-plugin/typora-plugin-image-viewer

[p17]: https://github.com/typora-community-plugin/typora-plugin-wavedrom

[p18]: https://github.com/typora-community-plugin/typora-plugin-footnotes

[p19]: https://github.com/typora-community-plugin/typora-plugin-templater

[p20]: https://github.com/typora-community-plugin/typora-plugin-trigger

[p21]: https://github.com/typora-community-plugin/typora-plugin-styled-text