streetwriters/notesnook

Slash commands in editor

Open

#2,559 opened on 2023年5月20日

GitHub で見る
 (5 comments) (8 reactions) (1 assignee)JavaScript (5,325 stars) (285 forks)batch import
Status: PendingType: Feature Requestgood first issue

説明

What problem are you facing?

Using the toolbar for adding different types of formats can become cumbersome and unwieldy. While Markdown shortcuts work for basic things like bold, italic etc., they aren't useful for adding complex widgets such as tables, outline lists etc. Secondly, it can be a chore for people to remember all the different markdown shortcuts.

What's the solution you'd like to see in Notesnook?

We can do what a lot of other editors are doing: use / as an entrypoint for showing a list of filterable formats. For example:

  1. Typing / on a new line
  2. A menu popups up with 5 most used formats
  3. Anything typed after / is used as a query to filter formats
  4. Pressing Enter inserts the specified format.

One thing to note here is that / commands are only for block level nodes like:

  1. Tables
  2. Lists
  3. Outline list
  4. Task list
  5. Blockquote
  6. Codeblock

What alternatives have you considered?

Using the toolbar with a mouse or keyboard shortcuts.

Additional context

No response

コントリビューターガイド

技術スタック
javascript
領域
frontend
Issue 種別
feature
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-2 days
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
active
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
clear
前提条件
JavaScriptEditor internalsBlock level nodes
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
30
調査方針
To implement slash commands, you need to understand Notesnook's editor architecture. The issue suggests adding a menu that appears when typing '/' on a new line, showing block level nodes like tables, lists, etc. Look at the existing toolbar and command system in the editor source code, likely in files under 'packages/editor'. Check how other editors like Notion or Obsidian implement slash commands for inspiration. Since the issue mentions filtering, you'll need to implement a search as you type mechanism. Start by exploring the current editor components and identify where to hook into the keypress event.
Slash commands in editor · streetwriters/notesnook#2559 | Good First Issue