From d00c327426d314e3cf83d6302bbae91adc328518 Mon Sep 17 00:00:00 2001 From: Mirone Saul Date: Fri, 15 Jul 2022 10:45:17 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20=E2=9C=8F=EF=B8=8F=20add=20doc=20for=20?= =?UTF-8?q?block=20plugin?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- packages/plugin-block/README.md | 2 +- website/pages/official-plugins/plugin-block/index.md | 12 ++++++++++++ website/route/page-config.ts | 1 + website/route/page-dict.ts | 7 +++++++ 4 files changed, 21 insertions(+), 1 deletion(-) create mode 100644 website/pages/official-plugins/plugin-block/index.md diff --git a/packages/plugin-block/README.md b/packages/plugin-block/README.md index 113247f25b1..f4947d8bf01 100644 --- a/packages/plugin-block/README.md +++ b/packages/plugin-block/README.md @@ -1,6 +1,6 @@ # @milkdown/plugin-block -The history plugin of [milkdown](https://milkdown.dev/). +The block plugin of [milkdown](https://milkdown.dev/). # Official Documentation diff --git a/website/pages/official-plugins/plugin-block/index.md b/website/pages/official-plugins/plugin-block/index.md new file mode 100644 index 00000000000..1a76173b82a --- /dev/null +++ b/website/pages/official-plugins/plugin-block/index.md @@ -0,0 +1,12 @@ +# @milkdown/plugin-block + +Block plugin for [milkdown](https://milkdown.dev/) to simulate the behavior of block editor. + +```typescript +import { Editor } from '@milkdown/core'; +import { commonmark } from '@milkdown/preset-commonmark'; + +import { block } from '@milkdown/plugin-block'; + +Editor.make().use(commonmark).use(block).create(); +``` diff --git a/website/route/page-config.ts b/website/route/page-config.ts index c74f7119699..193f97c05b1 100644 --- a/website/route/page-config.ts +++ b/website/route/page-config.ts @@ -47,6 +47,7 @@ export const config: ConfigItem[] = [ 'plugin-tooltip', 'plugin-slash', 'plugin-menu', + 'plugin-block', 'plugin-indent', 'plugin-trailing', 'plugin-emoji', diff --git a/website/route/page-dict.ts b/website/route/page-dict.ts index a9861301905..9d14d5c24ac 100644 --- a/website/route/page-dict.ts +++ b/website/route/page-dict.ts @@ -443,6 +443,13 @@ export const titleDict: Dict = new Map([ 'zh-hans': 'plugin-trailing', }, ], + [ + 'plugin-block', + { + en: 'plugin-block', + 'zh-hans': 'plugin-block', + }, + ], [ 'theme-nord', {