doocs/md

支持快捷添加内容

Closed

#398 opened on Sep 11, 2024

View on GitHubContributor guide
 (3 comments) (0 reactions) (0 assignees)Vue (2,142 forks)user submission
enhancementgood first issuehelp wanted

Repository metrics

Stars
 (12,649 stars)
PR merge metrics
 (Avg merge 1d 11h) (99 merged PRs in 30d)

Description

1. 想法

在编辑框内容为空时，展示 placeholder：输入 "/" 快捷添加内容

image

用户输入 / 时，唤起选项弹窗，示例：

image

  • 用户选中 "H1" 时，移除编辑框中的 /，并自动添加 '# ' 到目前光标所在位置
  • 用户选中 ”代码块“时，自动添加 ```\n\n```
  • 用户选中”公式块“时，弹出公式编辑窗

image

2. 参考

LeetCode 新版编辑器

image

Contributor guide

Research direction
First, understand the current editor implementation. Look at the editor component in src/ directory and identify how keyboard events are handled. Then, design a slash command plugin that intercepts '/' keypress when editor is empty, displays a popup with options like H1, code block, math block, and inserts appropriate markdown syntax. Reference the LeetCode editor for UX inspiration. Check if there is an existing popup or dropdown component to reuse.
Tech stack
vuejavascripthtmlcss
Domain
frontend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Vue.jsMarkdown editor basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65