Skip to content

Commit d5d9903

Browse files
committed
Feat: Add plugin command_palette
1 parent 7086da6 commit d5d9903

47 files changed

Lines changed: 1633 additions & 2128 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

README-cn.md

Lines changed: 43 additions & 104 deletions
Large diffs are not rendered by default.

README.md

Lines changed: 37 additions & 101 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ English | [简体中文](https://github.com/obgnail/typora_plugin/blob/master/RE
2929
| 10 | fence_enhance | Enhance Fence | |
3030
| 11 | right_outline | Right Outline | |
3131
| 12 | commander | Commander | |
32-
| 13 | toolbar | Multi-Purpose Searcher | |
32+
| 13 | command_palette | Command Palette | |
3333
| 14 | right_click_menu | Right-Click Menu | |
3434
| 15 | pie_menu | Pie menu | × |
3535
| 16 | datatables | Enhance Table | × |
@@ -85,7 +85,7 @@ English | [简体中文](https://github.com/obgnail/typora_plugin/blob/master/RE
8585

8686
- **Is my Typora supported?** Typora's version should be ≥ 0.9.98 (the last free version).
8787
- **How to modify plugin configurations?** Right-click menu -> Interactive Plugins -> Preferences. **Respect all user choices**. Any plugin or feature can be permanently enabled/disabled.
88-
- **How to upgrade plugins?** Right-click menu -> Interactive Plugins -> Upgrade Plugins.
88+
- **How to upgrade plugins?** Right-click menu -> Interactive Plugins -> Preferences -> Check for Updates.
8989
- **How to uninstall plugins?** Right-click menu -> Interactive Plugins -> Preferences -> Uninstall Plugins.
9090
- **How to develop plugins?** No Build Time, No need to install development environment. Please refer to [Readme](https://github.com/obgnail/typora_plugin/blob/master/plugin/custom/README-en.md) for details.
9191
- **Does it support Typora for Mac?** I don't have a Mac device, so I haven't tested it.
@@ -140,7 +140,7 @@ yay -S typora-plugin
140140
All plugins provide four usage methods:
141141

142142
- Keyboard enthusiasts:
143-
- `Ctrl+J` to bring up the plugin list (see `toolbar` plugin)
143+
- Command Palette (see `command_palette` plugin)
144144
- Shortcut keys (see `hotkeys` plugin)
145145
- Mouse enthusiasts:
146146
- Right-click in the main text area (see `right_click_menu` plugin)
@@ -154,7 +154,7 @@ All plugins provide four usage methods:
154154

155155
### search_multi
156156

157-
Function: Search through a combination of different conditions to accurately find files.
157+
Search through a combination of different conditions to accurately find files.
158158

159159

160160
Usage example: The search syntax is similar to Google search syntax and supports regular expressions.
@@ -181,47 +181,38 @@ Usage example: The search syntax is similar to Google search syntax and supports
181181

182182
### collapse_list
183183

184-
Function: Fold/expand unordered lists, ordered lists, task lists.
184+
Fold/expand unordered lists, ordered lists, task lists.
185185

186186

187187
### collapse_table
188188

189-
Function: Fold/expand tables.
189+
Fold/expand tables.
190190

191191

192192
### md_padding
193193

194-
Function: Add spaces between Chinese and English, Chinese and numbers when mixed.
195-
196-
Shortcut: ctrl + shift + B
194+
Add spaces between Chinese and English, Chinese and numbers when mixed.
197195

198196
![md_padding](assets/md_padding.gif)
199197

200198

201199
### slash_commands
202200

203-
Function: Similar to Notion's slash command.
204-
205-
Supports:
206-
207-
- Insert text snippets (snippet)
208-
- Insert components
209-
- Edit styles
210-
- Execute arbitrary logic
201+
Similar to Notion's slash command.
211202

212203
![slash_commands](assets/slash_commands.gif)
213204

214205

215206
### templater
216207

217-
Function: Similar to Obsidian's file template function, quickly create files based on templates.
208+
Similar to Obsidian's file template function, quickly create files based on templates.
218209

219210
![templater](assets/templater.gif)
220211

221212

222213
### resource_manager
223214

224-
Function: Resource management, cleanup of unused images
215+
Resource management, cleanup of unused images
225216

226217

227218
### fence_enhance
@@ -231,7 +222,7 @@ Function: Resource management, cleanup of unused images
231222

232223
### right_outline
233224

234-
Function: Typora's sidebar cannot display both [File] and [Outline] simultaneously. To solve this problem, this plugin adds an [Outline] on the right.
225+
Typora's sidebar cannot display both [File] and [Outline] simultaneously. To solve this problem, this plugin adds an [Outline] on the right.
235226

236227

237228
### commander
@@ -244,50 +235,23 @@ Function: Typora's sidebar cannot display both [File] and [Outline] simultaneous
244235
![markmap](assets/markmap.gif)
245236

246237

247-
### toolbar
248-
249-
Function: Similar to VSCode's ctrl + shift + p function
250-
251-
Supports search:
252-
253-
- `his`: Recently opened files
254-
- `plu`: Plugins
255-
- `tab`: Open tabs
256-
- `ops`: Common operations
257-
- `out`: Document outline
258-
- `mode`: Switch file mode
259-
- `theme`: Temporarily switch theme
260-
- `func`: Function list
261-
- `all`: Mixed search (search all items mixed together)
262-
263-
Input content description:
238+
### command_palette
264239

265-
- Input content = search tool name + space + search content
266-
- Supports `intersection queries`, `difference queries`, and can be freely combined (similar to Google's positive and negative queries)
267-
268-
Examples:
269-
270-
- `his node learn`: Find recently opened files that have titles containing both node and learn keywords
271-
- `plu multi -search`: Find plugins whose names contain the multi keyword but do not contain the search keyword
272-
- `tab -messing`: Find all open tabs whose names do not contain the messing keyword
273-
- `his close -win -mark tab`: Find recently opened files whose titles contain close and tab keywords, but do not contain win and mark keywords
274-
275-
![toolbar](assets/toolbar.gif)
240+
Similar to VSCode's command palette (Ctrl+Shift+P)
276241

277242

278243
### right_click_menu
279244

280245
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.
281246

282-
283247
### pie_menu
284248

285-
Usage:
249+
Pie Menu. Usage:
286250

287251
- `Open circular menu`: Ctrl + right mouse button
288252
- `Rotate circular menu`: Middle mouse button
289-
- `Pin the circular menu, so it doesn't automatically disappear`: Left mouse button on the center of the circle
290-
- `Expand the circular menu, so it doesn't automatically collapse`: Right mouse button on the center of the circle
253+
- `Pin the circular menu, so it doesn't automatically disappear`: Left mouse button in the middle of the circle
254+
- `Expand the circular menu, so it doesn't automatically collapse`: Right mouse button in the middle of the circle
291255

292256
### preferences
293257

@@ -299,8 +263,6 @@ Preferences
299263

300264
### chart
301265

302-
Usage: Right-click menu -> Language plugins -> Chart
303-
304266
![chart](./assets/chart.png)
305267

306268
### drawIO
@@ -309,35 +271,25 @@ Usage: Right-click menu -> Language plugins -> Chart
309271

310272
### abc
311273

312-
Usage: Right-click menu -> Language plugins -> ABC
313-
314274
![abcjs](./assets/abcjs.png)
315275

316276
### calendar
317277

318-
Usage: Right-click menu -> Language plugins -> Calendar
319-
320278
![calendar](./assets/calendar.png)
321279

322280
### wavedrom
323281

324-
Usage: Right-click menu -> Language plugins -> Wavedrom
325-
326282
![wavedrom](./assets/wavedrom.png)
327283

328284
### marp
329285

330-
Function: Use markdown to create PPT.
331-
332-
Usage: Right-click menu -> Language plugins -> Marp
286+
Use markdown to create PPT.
333287

334288
### plantUML
335289

336-
Usage: Right-click menu -> Language plugins -> PlantUML
337-
338290
![plantUML](./assets/plantUML.png)
339291

340-
Due to the B/S architecture of plantUML, users are required to provide a rendering server. Suggest using Docker to install rendering server:
292+
Due to the B/S architecture of plantUML, a rendering server is required. Suggest using Docker to install:
341293

342294
```bash
343295
docker pull plantuml/plantuml-server:jetty
@@ -348,41 +300,29 @@ docker run -d --name plantuml-server -p 8080:8080 plantuml/plantuml-server:jetty
348300

349301
![callouts](./assets/callouts.png)
350302

351-
The quantity, type, color, and icon can all be defined by yourself. Please modify the configuration.
352-
353303
### kanban
354304

355-
Extend the code syntax to add Kanban functionality.
356-
357305
![kanban](assets/kanban.png)
358306

359307
### timeline
360308

361-
Extend the code syntax to add timeline functionality.
362-
363309
![timeline](./assets/timeline.png)
364310

365311
### chat
366312

367-
Extend the code syntax to add chat functionality.
368-
369313
![chat](./assets/chat.png)
370314

371315
### text_stylize
372316

373-
Function: Convert text to HTML format, changing the text style.
374-
375317
![text_stylize](./assets/text_stylize.gif)
376318

377319
### read_only
378320

379-
Function: In read-only mode, the document cannot be edited (after enabling, the bottom right corner of the statistics area will show `ReadOnly`).
380-
381-
Shortcut: ctrl+shift+R
321+
In read-only mode, the document cannot be edited (after enabling, the bottom right corner of the statistics area will show `ReadOnly`).
382322

383323
### blur
384324

385-
Function: After enabling, only the currently focused component is visible, the rest are blurred. It can be used to prevent peeking.
325+
After enabling, only the currently focused component is visible, the rest are blurred. It can be used to prevent peeking.
386326

387327
> This plugin can only be used with the official version of Typora.
388328
@@ -396,39 +336,39 @@ Unlike other implementations using theme CSS, this plugin perfectly solves the p
396336

397337
### image_viewer
398338

399-
Function: One-stop image viewing, and provides simple image editing.
339+
One-stop image viewing, and provides simple image editing.
400340

401341
![image-reviewer](./assets/image-reviewer.png)
402342

403343
### cjk_symbol_pairing
404344

405-
Function: Automatically pair symbols when typing `《 【 ( ‘ “ 「`.
345+
Automatically pair symbols when typing `《 【 ( ‘ “ 「`.
406346

407347
### datatables
408348

409-
Function: Enhance tables. Provides functions such as search, filter, pagination, and sorting.
349+
Enhance tables. Provides functions such as search, filter, pagination, and sorting.
410350

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

413353
![datatables](assets/datatables.png)
414354

415355
### resize_table
416356

417-
Function: `ctrl + mouse drag`: Modify the row height and column width of the table.
357+
`ctrl + mouse drag`: Modify the row height and column width of the table.
418358

419359
![resize_table](assets/resize_table.gif)
420360

421361
### resize_image
422362

423-
Function: `alt + mouse scroll`: Adjust the image size.
363+
`alt + mouse scroll`: Adjust the image size.
424364

425365
### export_enhance
426366

427-
Function: When exporting HTML, convert images to base64 to avoid image loss.
367+
When exporting HTML, convert images to base64 to avoid image loss.
428368

429369
### sidebar_enhance
430370

431-
Function:
371+
432372

433373
- Drag & drop outline to rearrange
434374
- Display non-Markdown files in the sidebar
@@ -450,15 +390,11 @@ Defocus Comfort Mode
450390

451391
### markdownlint
452392

453-
Function: Check whether the current file complies with the markdown best practices.
454-
455-
Usage:Click the small square in the top right corner
393+
Check whether the current file complies with the markdown best practices.
456394

457395
### updater
458396

459-
Upgrade Plugin
460-
461-
> As we all know, some users cannot download the latest plugin directly from GitHub, so a proxy setting function is provided (default is system proxy).
397+
Upgrade Plugin.
462398

463399
### easy_modify
464400

@@ -477,11 +413,11 @@ This plugin is a collection of commonly used editing tools, currently including:
477413

478414
### editor_width_slider
479415

480-
Function: Adjust the width of the writing area.
416+
Adjust the width of the writing area.
481417

482418
### asset_root_redirect
483419

484-
Function: 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.
420+
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.
485421

486422
> This plugin is disabled by default and needs to be manually enabled.
487423
@@ -498,7 +434,7 @@ Encrypt File.
498434

499435
### truncate_text
500436

501-
Function: 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.
437+
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.
502438

503439
> 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.
504440
@@ -529,33 +465,33 @@ This plugin disables the auto-hiding feature for syntax markers in WYSIWYG mode.
529465

530466
> This plugin is an advanced plugin, only available to users with a JavaScript background.
531467
532-
Function: Bind hotkeys to [any plugin system function] or [any custom function] in a declarative form.
468+
Bind hotkeys to [any plugin system function] or [any custom function] in a declarative form.
533469

534470
### action_buttons
535471

536472
> This plugin is an advanced plugin, only available to users with a JavaScript background.
537473
538-
Function: Similar to hotkeys, set function buttons for [any plugin system function] in a declarative form.
474+
Similar to hotkeys, set function buttons for [any plugin system function] in a declarative form.
539475

540476
### custom
541477

542478
> This plugin is an advanced plugin, only available to users with a JavaScript background.
543479
544-
Function: Provide open capabilities, support users to write their own plugins.
480+
Provide open capabilities, support users to write their own plugins.
545481

546482
For specific usage, please refer to [README.md](https://github.com/obgnail/typora_plugin/blob/master/plugin/custom/README.md).
547483

548484
### json_rpc
549485

550-
Function: Expose all capabilities including the typora-plugin in the form of `json-rpc` for external manipulation of Typora.
486+
Expose all capabilities including the typora-plugin in the form of `json-rpc` for external manipulation of Typora.
551487

552488
For specific usage, please refer to [README.md](https://github.com/obgnail/typora_plugin/blob/master/plugin/json_rpc/README.md).
553489

554490
> 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.
555491
556492
### article_uploader
557493

558-
Function: 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.
494+
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.
559495

560496
For specific usage, refer to: [README.md](https://github.com/obgnail/typora_plugin/blob/master/plugin/article_uploader/README.md). Taking uploading to CSDN as an example, the GIF is as follows:
561497

assets/toolbar.gif

-189 KB
Binary file not shown.

0 commit comments

Comments
 (0)