@milkdown/preset-commonmark 7.0.0-next.0 → 7.0.0-next.1

package/lib/node/heading.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"heading.d.ts","sourceRoot":"","sources":["../../src/node/heading.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,uBAAuB,CAAA;AAgBjD,eAAO,MAAM,kBAAkB,wCAPU,IAAI,kCAO0C,CAAA;AAEvF,eAAO,MAAM,WAAW,qCAAuB,CAAA;AAE/C,eAAO,MAAM,aAAa,kDAgExB,CAAA;AAEF,eAAO,MAAM,sBAAsB,sCAiBlC,CAAA;AAED,eAAO,MAAM,oBAAoB,4CAS/B,CAAA;AAEF,eAAO,MAAM,uBAAuB,6CAkBhC,CAAA;AAEJ,eAAO,MAAM,aAAa,sKAkDxB,CAAA"}
+{"version":3,"file":"heading.d.ts","sourceRoot":"","sources":["../../src/node/heading.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,uBAAuB,CAAA;AAkBjD,eAAO,MAAM,kBAAkB,wCATU,IAAI,kCAS0C,CAAA;AAGvF,eAAO,MAAM,WAAW,qCAAuB,CAAA;AAG/C,eAAO,MAAM,aAAa,kDAgExB,CAAA;AAIF,eAAO,MAAM,sBAAsB,sCAgBjC,CAAA;AAKF,eAAO,MAAM,oBAAoB,4CAS/B,CAAA;AAKF,eAAO,MAAM,uBAAuB,6CAkBhC,CAAA;AAKJ,eAAO,MAAM,aAAa,sKAkDxB,CAAA"}

package/lib/node/hr.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"hr.d.ts","sourceRoot":"","sources":["../../src/node/hr.ts"],"names":[],"mappings":"AAMA,eAAO,MAAM,MAAM,qCAAkB,CAAA;AACrC,eAAO,MAAM,QAAQ,6CAgBlB,CAAA;AAEH,eAAO,MAAM,iBAAiB,sCAS5B,CAAA;AAEF,eAAO,MAAM,eAAe,6CAkB1B,CAAA"}
+{"version":3,"file":"hr.d.ts","sourceRoot":"","sources":["../../src/node/hr.ts"],"names":[],"mappings":"AAOA,eAAO,MAAM,MAAM,qCAAkB,CAAA;AAGrC,eAAO,MAAM,QAAQ,6CAgBlB,CAAA;AAIH,eAAO,MAAM,iBAAiB,sCAS5B,CAAA;AAGF,eAAO,MAAM,eAAe,6CAkB1B,CAAA"}

package/lib/node/image.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"image.d.ts","sourceRoot":"","sources":["../../src/node/image.ts"],"names":[],"mappings":"AAMA,eAAO,MAAM,SAAS,qCAAqB,CAAA;AAE3C,eAAO,MAAM,WAAW,gDAyDtB,CAAA;AAEF,MAAM,MAAM,yBAAyB,GAAG;IACtC,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,GAAG,CAAC,EAAE,MAAM,CAAA;CACb,CAAA;AACD,eAAO,MAAM,kBAAkB,+DAa3B,CAAA;AAEJ,eAAO,MAAM,kBAAkB,+DAkB7B,CAAA;AAEF,eAAO,MAAM,oBAAoB,sCAS/B,CAAA"}
+{"version":3,"file":"image.d.ts","sourceRoot":"","sources":["../../src/node/image.ts"],"names":[],"mappings":"AAOA,eAAO,MAAM,SAAS,qCAAqB,CAAA;AAG3C,eAAO,MAAM,WAAW,gDAyDtB,CAAA;AAGF,MAAM,MAAM,yBAAyB,GAAG;IACtC,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,GAAG,CAAC,EAAE,MAAM,CAAA;CACb,CAAA;AAID,eAAO,MAAM,kBAAkB,+DAa3B,CAAA;AAIJ,eAAO,MAAM,kBAAkB,+DAkB7B,CAAA;AAKF,eAAO,MAAM,oBAAoB,sCAS/B,CAAA"}

package/lib/node/list-item.d.ts

@@ -1,7 +1,7 @@
 export declare const listItemAttr: import("@milkdown/utils").$NodeAttr;
 export declare const listItemSchema: import("@milkdown/utils").$NodeSchema<"list_item">;
 export declare const sinkListItemCommand: import("@milkdown/utils").$Command<unknown>;
-export declare const splitListItemCommand: import("@milkdown/utils").$Command<unknown>;
 export declare const liftListItemCommand: import("@milkdown/utils").$Command<unknown>;
+export declare const splitListItemCommand: import("@milkdown/utils").$Command<unknown>;
 export declare const listItemKeymap: import("@milkdown/utils").$UserKeymap<"listItemKeymap", "SinkListItem" | "NextListItem" | "LiftListItem">;
 //# sourceMappingURL=list-item.d.ts.map

package/lib/node/list-item.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"list-item.d.ts","sourceRoot":"","sources":["../../src/node/list-item.ts"],"names":[],"mappings":"AAMA,eAAO,MAAM,YAAY,qCAAwB,CAAA;AAEjD,eAAO,MAAM,cAAc,oDA2DxB,CAAA;AAEH,eAAO,MAAM,mBAAmB,6CAA4E,CAAA;AAC5G,eAAO,MAAM,oBAAoB,6CAA8E,CAAA;AAC/G,eAAO,MAAM,mBAAmB,6CAA6E,CAAA;AAE7G,eAAO,MAAM,cAAc,2GAsBzB,CAAA"}
+{"version":3,"file":"list-item.d.ts","sourceRoot":"","sources":["../../src/node/list-item.ts"],"names":[],"mappings":"AAOA,eAAO,MAAM,YAAY,qCAAwB,CAAA;AAGjD,eAAO,MAAM,cAAc,oDA2DxB,CAAA;AAcH,eAAO,MAAM,mBAAmB,6CAA4E,CAAA;AAc5G,eAAO,MAAM,mBAAmB,6CAA6E,CAAA;AAe7G,eAAO,MAAM,oBAAoB,6CAA8E,CAAA;AAM/G,eAAO,MAAM,cAAc,2GAsBzB,CAAA"}

package/lib/node/ordered-list.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ordered-list.d.ts","sourceRoot":"","sources":["../../src/node/ordered-list.ts"],"names":[],"mappings":"AAOA,eAAO,MAAM,eAAe,qCAA2B,CAAA;AAEvD,eAAO,MAAM,iBAAiB,uDAiD3B,CAAA;AAEH,eAAO,MAAM,0BAA0B,sCAKrC,CAAA;AAEF,eAAO,MAAM,wBAAwB,6CAA8E,CAAA;AAEnH,eAAO,MAAM,iBAAiB,iFAQ5B,CAAA"}
+{"version":3,"file":"ordered-list.d.ts","sourceRoot":"","sources":["../../src/node/ordered-list.ts"],"names":[],"mappings":"AAQA,eAAO,MAAM,eAAe,qCAA2B,CAAA;AAGvD,eAAO,MAAM,iBAAiB,uDAiD3B,CAAA;AAGH,eAAO,MAAM,0BAA0B,sCAKrC,CAAA;AAGF,eAAO,MAAM,wBAAwB,6CAA8E,CAAA;AAInH,eAAO,MAAM,iBAAiB,iFAQ5B,CAAA"}

package/lib/node/paragraph.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"paragraph.d.ts","sourceRoot":"","sources":["../../src/node/paragraph.ts"],"names":[],"mappings":"AAOA,eAAO,MAAM,aAAa,qCAAyB,CAAA;AACnD,eAAO,MAAM,eAAe,oDAuCzB,CAAA;AAEH,eAAO,MAAM,mBAAmB,6CAA6E,CAAA;AAE7G,eAAO,MAAM,eAAe,0EAQ1B,CAAA"}
+{"version":3,"file":"paragraph.d.ts","sourceRoot":"","sources":["../../src/node/paragraph.ts"],"names":[],"mappings":"AAQA,eAAO,MAAM,aAAa,qCAAyB,CAAA;AAGnD,eAAO,MAAM,eAAe,oDAuCzB,CAAA;AAGH,eAAO,MAAM,mBAAmB,6CAA6E,CAAA;AAI7G,eAAO,MAAM,eAAe,0EAQ1B,CAAA"}

package/lib/node/text.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"text.d.ts","sourceRoot":"","sources":["../../src/node/text.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,UAAU,iCAcpB,CAAA"}
+{"version":3,"file":"text.d.ts","sourceRoot":"","sources":["../../src/node/text.ts"],"names":[],"mappings":"AAIA,eAAO,MAAM,UAAU,iCAcpB,CAAA"}

package/lib/plugin/hardbreak-clear-mark-plugin.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"hardbreak-clear-mark-plugin.d.ts","sourceRoot":"","sources":["../../src/plugin/hardbreak-clear-mark-plugin.ts"],"names":[],"mappings":"AAMA,eAAO,MAAM,wBAAwB,kCAqCnC,CAAA"}
+{"version":3,"file":"hardbreak-clear-mark-plugin.d.ts","sourceRoot":"","sources":["../../src/plugin/hardbreak-clear-mark-plugin.ts"],"names":[],"mappings":"AAOA,eAAO,MAAM,wBAAwB,kCAqCnC,CAAA"}

package/lib/plugin/hardbreak-filter-plugin.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"hardbreak-filter-plugin.d.ts","sourceRoot":"","sources":["../../src/plugin/hardbreak-filter-plugin.ts"],"names":[],"mappings":"AAIA,eAAO,MAAM,oBAAoB,kEAAwD,CAAA;AAGzF,eAAO,MAAM,qBAAqB,kCAuBhC,CAAA"}
+{"version":3,"file":"hardbreak-filter-plugin.d.ts","sourceRoot":"","sources":["../../src/plugin/hardbreak-filter-plugin.ts"],"names":[],"mappings":"AAKA,eAAO,MAAM,oBAAoB,kEAAwD,CAAA;AAIzF,eAAO,MAAM,qBAAqB,kCAuBhC,CAAA"}

package/lib/plugin/inline-nodes-cursor-plugin.d.ts

@@ -1,6 +1,2 @@
-/**
- * This plugin is to solve the chrome 98 bug:
- * https://discuss.prosemirror.net/t/cursor-jumps-at-the-end-of-line-when-it-betweens-two-inline-nodes/4641
- */
 export declare const inlineNodesCursorPlugin: import("@milkdown/utils").$Prose;
 //# sourceMappingURL=inline-nodes-cursor-plugin.d.ts.map

package/lib/plugin/inline-nodes-cursor-plugin.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"inline-nodes-cursor-plugin.d.ts","sourceRoot":"","sources":["../../src/plugin/inline-nodes-cursor-plugin.ts"],"names":[],"mappings":"AAKA;;;GAGG;AACH,eAAO,MAAM,uBAAuB,kCAmFlC,CAAA"}
+{"version":3,"file":"inline-nodes-cursor-plugin.d.ts","sourceRoot":"","sources":["../../src/plugin/inline-nodes-cursor-plugin.ts"],"names":[],"mappings":"AAMA,eAAO,MAAM,uBAAuB,kCAmFlC,CAAA"}

package/lib/plugin/inline-sync-plugin/config.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../../src/plugin/inline-sync-plugin/config.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,eAAe,CAAA;AACxC,OAAO,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAA;AAC3D,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AAKxD,MAAM,MAAM,cAAc,GAAG,CAAC,OAAO,EAAE;IACrC,QAAQ,EAAE,IAAI,CAAA;IACd,QAAQ,EAAE,IAAI,CAAA;IACd,GAAG,EAAE,GAAG,CAAA;IACR,EAAE,EAAE,WAAW,CAAA;IACf,IAAI,EAAE,MAAM,CAAA;CACb,KAAK,OAAO,CAAA;AAEb,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,EAAE,MAAM,CAAA;IACnB,IAAI,EAAE,MAAM,CAAA;CACb;AAED,MAAM,WAAW,gBAAgB;IAC/B,iBAAiB,EAAE,mBAAmB,CAAA;IACtC,cAAc,EAAE,cAAc,CAAA;IAC9B,WAAW,EAAE,KAAK,CAAC,QAAQ,GAAG,MAAM,CAAC,CAAA;IACrC,eAAe,EAAE,CAAC,iBAAiB,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,KAAK,MAAM,CAAA;CACrE;AAED,eAAO,MAAM,aAAa,EAAE,gBAyB3B,CAAA;AAGD,eAAO,MAAM,gBAAgB,sEAAgF,CAAA"}
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../../src/plugin/inline-sync-plugin/config.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,eAAe,CAAA;AACxC,OAAO,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAA;AAC3D,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AAMxD,MAAM,MAAM,cAAc,GAAG,CAAC,OAAO,EAAE;IACrC,QAAQ,EAAE,IAAI,CAAA;IACd,QAAQ,EAAE,IAAI,CAAA;IACd,GAAG,EAAE,GAAG,CAAA;IACR,EAAE,EAAE,WAAW,CAAA;IACf,IAAI,EAAE,MAAM,CAAA;CACb,KAAK,OAAO,CAAA;AAGb,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,EAAE,MAAM,CAAA;IACnB,IAAI,EAAE,MAAM,CAAA;CACb;AAGD,MAAM,WAAW,gBAAgB;IAC/B,iBAAiB,EAAE,mBAAmB,CAAA;IACtC,cAAc,EAAE,cAAc,CAAA;IAC9B,WAAW,EAAE,KAAK,CAAC,QAAQ,GAAG,MAAM,CAAC,CAAA;IACrC,eAAe,EAAE,CAAC,iBAAiB,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,KAAK,MAAM,CAAA;CACrE;AAGD,eAAO,MAAM,aAAa,EAAE,gBAyB3B,CAAA;AAaD,eAAO,MAAM,gBAAgB,sEAAgF,CAAA"}

package/lib/plugin/inline-sync-plugin/inline-sync-plugin.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"inline-sync-plugin.d.ts","sourceRoot":"","sources":["../../../src/plugin/inline-sync-plugin/inline-sync-plugin.ts"],"names":[],"mappings":"AAUA,eAAO,MAAM,gBAAgB,kCAkD3B,CAAA"}
+{"version":3,"file":"inline-sync-plugin.d.ts","sourceRoot":"","sources":["../../../src/plugin/inline-sync-plugin/inline-sync-plugin.ts"],"names":[],"mappings":"AAeA,eAAO,MAAM,gBAAgB,kCAkD3B,CAAA"}

package/lib/plugin/remark-add-order-in-list-plugin.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"remark-add-order-in-list-plugin.d.ts","sourceRoot":"","sources":["../../src/plugin/remark-add-order-in-list-plugin.ts"],"names":[],"mappings":"AAKA,eAAO,MAAM,0BAA0B,mCASrC,CAAA"}
+{"version":3,"file":"remark-add-order-in-list-plugin.d.ts","sourceRoot":"","sources":["../../src/plugin/remark-add-order-in-list-plugin.ts"],"names":[],"mappings":"AAMA,eAAO,MAAM,0BAA0B,mCASrC,CAAA"}

package/lib/plugin/remark-inline-link-plugin.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"remark-inline-link-plugin.d.ts","sourceRoot":"","sources":["../../src/plugin/remark-inline-link-plugin.ts"],"names":[],"mappings":"AAIA,eAAO,MAAM,sBAAsB,mCAAmC,CAAA"}
+{"version":3,"file":"remark-inline-link-plugin.d.ts","sourceRoot":"","sources":["../../src/plugin/remark-inline-link-plugin.ts"],"names":[],"mappings":"AAKA,eAAO,MAAM,sBAAsB,mCAAmC,CAAA"}

package/lib/plugin/remark-line-break.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"remark-line-break.d.ts","sourceRoot":"","sources":["../../src/plugin/remark-line-break.ts"],"names":[],"mappings":"AAKA,eAAO,MAAM,eAAe,mCAmC1B,CAAA"}
+{"version":3,"file":"remark-line-break.d.ts","sourceRoot":"","sources":["../../src/plugin/remark-line-break.ts"],"names":[],"mappings":"AAQA,eAAO,MAAM,eAAe,mCAmC1B,CAAA"}

package/lib/plugin/sync-heading-id-plugin.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"sync-heading-id-plugin.d.ts","sourceRoot":"","sources":["../../src/plugin/sync-heading-id-plugin.ts"],"names":[],"mappings":"AAMA,eAAO,MAAM,mBAAmB,kCA8C9B,CAAA"}
+{"version":3,"file":"sync-heading-id-plugin.d.ts","sourceRoot":"","sources":["../../src/plugin/sync-heading-id-plugin.ts"],"names":[],"mappings":"AAQA,eAAO,MAAM,mBAAmB,kCA8C9B,CAAA"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@milkdown/preset-commonmark",
   "type": "module",
-  "version": "7.0.0-next.0",
+  "version": "7.0.0-next.1",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -30,14 +30,14 @@
     "remark-inline-links": "^6.0.0",
     "tslib": "^2.4.0",
     "unist-util-visit": "^4.0.0",
-    "@milkdown/exception": "7.0.0-next.0",
-    "@milkdown/utils": "7.0.0-next.0"
+    "@milkdown/exception": "7.0.0-next.1",
+    "@milkdown/utils": "7.0.0-next.1"
   },
   "devDependencies": {
     "@types/unist": "^2.0.6",
-    "@milkdown/core": "7.0.0-next.0",
-    "@milkdown/ctx": "7.0.0-next.0",
-    "@milkdown/prose": "7.0.0-next.0"
+    "@milkdown/core": "7.0.0-next.1",
+    "@milkdown/ctx": "7.0.0-next.1",
+    "@milkdown/prose": "7.0.0-next.1"
   },
   "nx": {
     "targets": {

package/src/composed/commands.ts

@@ -3,6 +3,7 @@ import type { MilkdownPlugin } from '@milkdown/ctx'
 import { toggleEmphasisCommand, toggleInlineCodeCommand, toggleLinkCommand, toggleStrongCommand, updateLinkCommand } from '../mark'
 import { createCodeBlockCommand, downgradeHeadingCommand, insertHardbreakCommand, insertHrCommand, insertImageCommand, liftListItemCommand, sinkListItemCommand, splitListItemCommand, turnIntoTextCommand, updateImageCommand, wrapInBlockquoteCommand, wrapInBulletListCommand, wrapInHeadingCommand, wrapInOrderedListCommand } from '../node'
 
+/// @internal
 export const commands: MilkdownPlugin[] = [
   turnIntoTextCommand,
   wrapInBlockquoteCommand,

package/src/composed/inputrules.ts

@@ -2,6 +2,7 @@
 import type { MilkdownPlugin } from '@milkdown/ctx'
 import { createCodeBlockInputRule, insertHrInputRule, wrapInBlockquoteInputRule, wrapInBulletListInputRule, wrapInHeadingInputRule, wrapInOrderedListInputRule } from '../node'
 
+/// @internal
 export const inputrules: MilkdownPlugin[] = [
   wrapInBlockquoteInputRule,
   wrapInBulletListInputRule,

package/src/composed/keymap.ts

@@ -3,6 +3,7 @@ import type { MilkdownPlugin } from '@milkdown/ctx'
 import { emphasisKeymap, inlineCodeKeymap, strongKeymap } from '../mark'
 import { blockquoteKeymap, bulletListKeymap, codeBlockKeymap, hardbreakKeymap, headingKeymap, listItemKeymap, orderedListKeymap, paragraphKeymap } from '../node'
 
+/// @internal
 export const keymap: MilkdownPlugin[] = [
   blockquoteKeymap,
   codeBlockKeymap,

package/src/composed/plugins.ts

@@ -1,8 +1,10 @@
 /* Copyright 2021, Milkdown by Mirone. */
 
+import type { MilkdownPlugin } from '@milkdown/ctx'
 import { hardbreakClearMarkPlugin, hardbreakFilterNodes, hardbreakFilterPlugin, inlineNodesCursorPlugin, inlineSyncConfig, inlineSyncPlugin, remarkAddOrderInListPlugin, remarkInlineLinkPlugin, remarkLineBreak, syncHeadingIdPlugin, syncListOrderPlugin } from '../plugin'
 
-export const plugins = [
+/// @internal
+export const plugins: MilkdownPlugin[] = [
   inlineSyncConfig,
   inlineSyncPlugin,
 

package/src/composed/schema.ts

@@ -4,6 +4,7 @@ import type { MilkdownPlugin } from '@milkdown/ctx'
 import { emphasisAttr, emphasisSchema, inlineCodeAttr, inlineCodeSchema, linkAttr, linkSchema, strongAttr, strongSchema } from '../mark'
 import { blockquoteAttr, blockquoteSchema, bulletListAttr, bulletListSchema, codeBlockAttr, codeBlockSchema, docSchema, hardbreakAttr, hardbreakSchema, headingAttr, headingIdGenerator, headingSchema, hrAttr, hrSchema, imageAttr, imageSchema, listItemAttr, listItemSchema, orderedListAttr, orderedListSchema, paragraphAttr, paragraphSchema, textSchema } from '../node'
 
+/// @internal
 export const schema: MilkdownPlugin[] = [
   docSchema,
 

package/src/index.ts

@@ -7,4 +7,5 @@ export * from './mark'
 export * from './plugin'
 export * from './composed'
 
+/// The commonmark preset, includes all the plugins.
 export const commonmark = [schema, inputrules, commands, keymap, plugins].flat()

package/src/mark/emphasis.ts

@@ -3,8 +3,10 @@ import { commandsCtx } from '@milkdown/core'
 import { toggleMark } from '@milkdown/prose/commands'
 import { $command, $markAttr, $markSchema, $useKeymap } from '@milkdown/utils'
 
+/// HTML attributes for the emphasis mark.
 export const emphasisAttr = $markAttr('emphasis')
 
+/// Emphasis mark schema.
 export const emphasisSchema = $markSchema('emphasis', ctx => ({
   inclusive: false,
   parseDOM: [
@@ -29,8 +31,11 @@ export const emphasisSchema = $markSchema('emphasis', ctx => ({
   },
 }))
 
+/// A command to toggle the emphasis mark.
 export const toggleEmphasisCommand = $command('ToggleEmphasis', () => () => toggleMark(emphasisSchema.type()))
 
+/// Keymap for the emphasis mark.
+/// - `Mod-i` - Toggle the emphasis mark.
 export const emphasisKeymap = $useKeymap('emphasisKeymap', {
   ToggleEmphasis: {
     shortcuts: 'Mod-i',

package/src/mark/inline-code.ts

@@ -3,7 +3,10 @@ import { commandsCtx } from '@milkdown/core'
 import type { MarkType } from '@milkdown/prose/model'
 import { $command, $markAttr, $markSchema, $useKeymap } from '@milkdown/utils'
 
+/// HTML attributes for the inlineCode mark.
 export const inlineCodeAttr = $markAttr('inlineCode')
+
+/// InlineCode mark schema.
 export const inlineCodeSchema = $markSchema('inlineCode', ctx => ({
   priority: 100,
   code: true,
@@ -26,6 +29,7 @@ export const inlineCodeSchema = $markSchema('inlineCode', ctx => ({
   },
 }))
 
+/// A command to toggle the inlineCode mark.
 export const toggleInlineCodeCommand = $command('ToggleInlineCode', () => () => (state, dispatch) => {
   const { selection, tr } = state
   if (selection.empty)
@@ -53,6 +57,8 @@ export const toggleInlineCodeCommand = $command('ToggleInlineCode', () => () =>
   return true
 })
 
+/// Keymap for the inlineCode mark.
+/// - `Mod-e` - Toggle the inlineCode mark.
 export const inlineCodeKeymap = $useKeymap('inlineCodeKeymap', {
   ToggleInlineCode: {
     shortcuts: 'Mod-e',

package/src/mark/link.ts

@@ -5,7 +5,10 @@ import type { Node as ProseNode } from '@milkdown/prose/model'
 import { TextSelection } from '@milkdown/prose/state'
 import { $command, $markAttr, $markSchema } from '@milkdown/utils'
 
+/// HTML attributes for the link mark.
 export const linkAttr = $markAttr('link')
+
+/// Link mark schema.
 export const linkSchema = $markSchema('link', ctx => ({
   attrs: {
     href: {},
@@ -44,11 +47,17 @@ export const linkSchema = $markSchema('link', ctx => ({
   },
 }))
 
+/// @internal
 export type UpdateLinkCommandPayload = {
   href?: string
   title?: string
 }
+/// A command to toggle the link mark.
+/// You can pass the `href` and `title` to the link.
 export const toggleLinkCommand = $command('ToggleLink', () => (payload: UpdateLinkCommandPayload = {}) => toggleMark(linkSchema.type(), payload))
+
+/// A command to update the link mark.
+/// You can pass the `href` and `title` to update the link.
 export const updateLinkCommand = $command('UpdateLink', () => (payload: UpdateLinkCommandPayload = {}) => (state, dispatch) => {
   if (!dispatch)
     return false

package/src/mark/strong.ts

@@ -3,7 +3,10 @@ import { commandsCtx } from '@milkdown/core'
 import { toggleMark } from '@milkdown/prose/commands'
 import { $command, $markAttr, $markSchema, $useKeymap } from '@milkdown/utils'
 
+/// HTML attributes for the strong mark.
 export const strongAttr = $markAttr('strong')
+
+/// Strong mark schema.
 export const strongSchema = $markSchema('strong', ctx => ({
   inclusive: false,
   parseDOM: [
@@ -28,8 +31,11 @@ export const strongSchema = $markSchema('strong', ctx => ({
   },
 }))
 
+/// A command to toggle the strong mark.
 export const toggleStrongCommand = $command('ToggleStrong', () => () => toggleMark(strongSchema.type()))
 
+/// Keymap for the strong mark.
+/// - `Mod-b` - Toggle the strong mark.
 export const strongKeymap = $useKeymap('strongKeymap', {
   ToggleBold: {
     shortcuts: ['Mod-b'],

package/src/node/blockquote.ts

@@ -5,8 +5,10 @@ import { wrappingInputRule } from '@milkdown/prose/inputrules'
 import type { $NodeSchema } from '@milkdown/utils'
 import { $command, $inputRule, $nodeAttr, $nodeSchema, $useKeymap } from '@milkdown/utils'
 
+/// HTML attributes for blockquote node.
 export const blockquoteAttr = $nodeAttr('blockquote')
 
+/// Schema for blockquote node.
 export const blockquoteSchema: $NodeSchema<'blockquote'> = $nodeSchema('blockquote', ctx => ({
   content: 'block+',
   group: 'block',
@@ -27,10 +29,15 @@ export const blockquoteSchema: $NodeSchema<'blockquote'> = $nodeSchema('blockquo
   },
 }))
 
+/// This input rule will convert a line that starts with `> ` into a blockquote.
+/// You can type `> ` at the start of a line to create a blockquote.
 export const wrapInBlockquoteInputRule = $inputRule(() => wrappingInputRule(/^\s*>\s$/, blockquoteSchema.type()))
 
+/// This command will wrap the current selection in a blockquote.
 export const wrapInBlockquoteCommand = $command('WrapInBlockquote', () => () => wrapIn(blockquoteSchema.type()))
 
+/// Keymap for blockquote.
+/// - `Mod-Shift-b`: Wrap selection in blockquote.
 export const blockquoteKeymap = $useKeymap('blockquoteKeymap', {
   WrapInBlockquote: {
     shortcuts: 'Mod-Shift-b',

package/src/node/bullet-list.ts

@@ -5,7 +5,10 @@ import { wrapIn } from '@milkdown/prose/commands'
 import { wrappingInputRule } from '@milkdown/prose/inputrules'
 import { $command, $inputRule, $nodeAttr, $nodeSchema, $useKeymap } from '@milkdown/utils'
 
+/// HTML attributes for bullet list node.
 export const bulletListAttr = $nodeAttr('bulletList')
+
+/// Schema for bullet list node.
 export const bulletListSchema = $nodeSchema('bullet_list', (ctx) => {
   return {
     content: 'listItem+',
@@ -57,10 +60,14 @@ export const bulletListSchema = $nodeSchema('bullet_list', (ctx) => {
   }
 })
 
+/// Input rule for wrapping a block in bullet list node.
 export const wrapInBulletListInputRule = $inputRule(() => wrappingInputRule(/^\s*([-+*])\s$/, bulletListSchema.type()))
 
+/// Command for creating bullet list node.
 export const wrapInBulletListCommand = $command('WrapInBulletList', () => () => wrapIn(bulletListSchema.type()))
 
+/// Keymap for bullet list node.
+/// - `Mod-Alt-8`: Wrap a block in bullet list.
 export const bulletListKeymap = $useKeymap('bulletListKeymap', {
   WrapInBulletList: {
     shortcuts: 'Mod-Alt-8',

package/src/node/code-block.ts

@@ -5,11 +5,13 @@ import { setBlockType } from '@milkdown/prose/commands'
 import { textblockTypeInputRule } from '@milkdown/prose/inputrules'
 import { $command, $inputRule, $nodeAttr, $nodeSchema, $useKeymap } from '@milkdown/utils'
 
+/// HTML attributes for code block node.
 export const codeBlockAttr = $nodeAttr('codeBlock', () => ({
   pre: {},
   code: {},
 }))
 
+/// Schema for code block node.
 export const codeBlockSchema = $nodeSchema('code_block', (ctx) => {
   return {
     content: 'text*',
@@ -68,11 +70,17 @@ export const codeBlockSchema = $nodeSchema('code_block', (ctx) => {
   }
 })
 
+/// A input rule for creating code block.
+/// For example, ` ```javascript ` will create a code block with language javascript.
 export const createCodeBlockInputRule = $inputRule(() => textblockTypeInputRule(/^```(?<language>[a-z]*)?[\s\n]$/, codeBlockSchema.type(), match => ({
   language: match.groups?.language ?? '',
 })))
 
+/// A command for creating code block.
+/// You can pass the language of the code block as the parameter.
 export const createCodeBlockCommand = $command('CreateCodeBlock', () => (language = '') => setBlockType(codeBlockSchema.type(), { language }))
+
+/// A command for updating the code block language of the target position.
 export const updateCodeBlockLanguageCommand = $command('UpdateCodeBlockLanguage', () => ({ pos, language }: { pos: number; language: string } = { pos: -1, language: '' }) => (state, dispatch) => {
   if (pos >= 0) {
     dispatch?.(state.tr.setNodeAttribute(pos, 'language', language))
@@ -82,6 +90,8 @@ export const updateCodeBlockLanguageCommand = $command('UpdateCodeBlockLanguage'
   return false
 })
 
+/// Keymap for code block.
+/// - `Mod-Alt-c`: Create a code block.
 export const codeBlockKeymap = $useKeymap('codeBlockKeymap', {
   CreateCodeBlock: {
     shortcuts: 'Mod-Alt-c',

package/src/node/doc.ts

@@ -1,6 +1,7 @@
 /* Copyright 2021, Milkdown by Mirone. */
 import { $node } from '@milkdown/utils'
 
+/// The top-level document node.
 export const docSchema = $node('doc', () => ({
   content: 'block+',
   parseMarkdown: {

package/src/node/hardbreak.ts

@@ -3,12 +3,17 @@ import { commandsCtx } from '@milkdown/core'
 import { Selection } from '@milkdown/prose/state'
 import { $command, $nodeAttr, $nodeSchema, $useKeymap } from '@milkdown/utils'
 
+/// HTML attributes for the hardbreak node.
+///
+/// Default value:
+/// - `data-is-inline` - Whether the hardbreak is inline.
 export const hardbreakAttr = $nodeAttr('hardbreak', (node) => {
   return {
     'data-is-inline': node.attrs.isInline,
   }
 })
 
+/// Hardbreak node schema.
 export const hardbreakSchema = $nodeSchema('hardbreak', ctx => ({
   inline: true,
   group: 'inline',
@@ -38,6 +43,7 @@ export const hardbreakSchema = $nodeSchema('hardbreak', ctx => ({
   },
 }))
 
+/// Command to insert a hardbreak.
 export const insertHardbreakCommand = $command('InsertHardbreak', () => () => (state, dispatch) => {
   const { selection, tr } = state
   if (selection.empty) {
@@ -57,6 +63,8 @@ export const insertHardbreakCommand = $command('InsertHardbreak', () => () => (s
   return true
 })
 
+/// Keymap for the hardbreak node.
+/// - `Shift-Enter` - Insert a hardbreak.
 export const hardbreakKeymap = $useKeymap('hardbreakKeymap', {
   InsertHardbreak: {
     shortcuts: 'Shift-Enter',

package/src/node/heading.ts

@@ -19,10 +19,14 @@ const defaultHeadingIdGenerator = (node: Node) =>
     .toLowerCase()
     .trim()
 
+/// This is a slice contains a function to generate heading id.
+/// You can configure it to generate id in your own way.
 export const headingIdGenerator = $ctx(defaultHeadingIdGenerator, 'headingIdGenerator')
 
+/// HTML attributes for heading node.
 export const headingAttr = $nodeAttr('heading')
 
+/// Schema for heading node.
 export const headingSchema = $nodeSchema('heading', (ctx) => {
   const getId = ctx.get(headingIdGenerator.key)
   return {
@@ -89,6 +93,8 @@ export const headingSchema = $nodeSchema('heading', (ctx) => {
   }
 })
 
+/// This input rule can turn the selected block into heading.
+/// You can input numbers of `#` and a `space` to create heading.
 export const wrapInHeadingInputRule = $inputRule((ctx) => {
   return textblockTypeInputRule(/^(?<hashes>#+)\s$/, headingSchema.type(), (match) => {
     const x = match.groups?.hashes?.length || 0
@@ -105,9 +111,11 @@ export const wrapInHeadingInputRule = $inputRule((ctx) => {
     }
     return { level: x }
   })
-},
-)
+})
 
+/// This command can turn the selected block into heading.
+/// You can pass the level of heading to this command.
+/// By default, the level is 1, which means it will create a `h1` element.
 export const wrapInHeadingCommand = $command('WrapInHeading', () => {
   return (level?: number) => {
     level ??= 1
@@ -119,6 +127,9 @@ export const wrapInHeadingCommand = $command('WrapInHeading', () => {
   }
 })
 
+/// This command can downgrade the selected heading.
+/// For example, if you have a `h2` element, and you call this command, you will get a `h1` element.
+/// If the element is already a `h1` element, it will turn it into a `p` element.
 export const downgradeHeadingCommand = $command('DowngradeHeading', () => () =>
   (state, dispatch, view) => {
     const { $from } = state.selection
@@ -139,6 +150,9 @@ export const downgradeHeadingCommand = $command('DowngradeHeading', () => () =>
     return true
   })
 
+/// Keymap for heading node.
+/// - `<Mod-Alt-{1-6}>`: Turn the selected block into `h{1-6}` element.
+/// - `<Delete>/<Backspace>`: Downgrade the selected heading.
 export const headingKeymap = $useKeymap('headingKeymap', {
   TurnIntoH1: {
     shortcuts: 'Mod-Alt-1',

package/src/node/hr.ts

@@ -4,7 +4,10 @@ import { Selection } from '@milkdown/prose/state'
 import { $command, $inputRule, $nodeAttr, $nodeSchema } from '@milkdown/utils'
 import { paragraphSchema } from './paragraph'
 
+/// HTML attributes for the hr node.
 export const hrAttr = $nodeAttr('hr')
+
+/// Hr node schema.
 export const hrSchema = $nodeSchema('hr', ctx => ({
   group: 'block',
   parseDOM: [{ tag: 'hr' }],
@@ -23,6 +26,8 @@ export const hrSchema = $nodeSchema('hr', ctx => ({
   },
 }))
 
+/// Input rule to insert a hr.
+/// For example, `---` will be converted to a hr.
 export const insertHrInputRule = $inputRule(() => new InputRule(
   /^(?:---|___\s|\*\*\*\s)$/, (state, match, start, end) => {
     const { tr } = state
@@ -34,6 +39,7 @@ export const insertHrInputRule = $inputRule(() => new InputRule(
   },
 ))
 
+/// Command to insert a hr.
 export const insertHrCommand = $command('InsertHr', () => () => (state, dispatch) => {
   if (!dispatch)
     return true

package/src/node/image.ts

@@ -4,8 +4,10 @@ import { findSelectedNodeOfType } from '@milkdown/prose'
 import { InputRule } from '@milkdown/prose/inputrules'
 import { $command, $inputRule, $nodeAttr, $nodeSchema } from '@milkdown/utils'
 
+/// HTML attributes for image node.
 export const imageAttr = $nodeAttr('image')
 
+/// Schema for image node.
 export const imageSchema = $nodeSchema('image', (ctx) => {
   return {
     inline: true,
@@ -65,11 +67,15 @@ export const imageSchema = $nodeSchema('image', (ctx) => {
   }
 })
 
+/// @internal
 export type UpdateImageCommandPayload = {
   src?: string
   title?: string
   alt?: string
 }
+
+/// This command will insert a image node.
+/// You can pass a payload to set `src`, `alt` and `title` for the image node.
 export const insertImageCommand = $command('InsertImage', () => (payload: UpdateImageCommandPayload = {}) =>
   (state, dispatch) => {
     if (!dispatch)
@@ -85,6 +91,8 @@ export const insertImageCommand = $command('InsertImage', () => (payload: Update
     return true
   })
 
+/// This command will update the selected image node.
+/// You can pass a payload to update `src`, `alt` and `title` for the image node.
 export const updateImageCommand = $command('UpdateImage', () => (payload: UpdateImageCommandPayload = {}) => (state, dispatch) => {
   const nodeWithPos = findSelectedNodeOfType(state.selection, imageSchema.type())
   if (!nodeWithPos)
@@ -105,6 +113,9 @@ export const updateImageCommand = $command('UpdateImage', () => (payload: Update
   return true
 })
 
+/// This input rule will insert a image node.
+/// You can input `![alt](src "title")` to insert a image node.
+/// The `title` is optional.
 export const insertImageInputRule = $inputRule(() => new InputRule(
   /!\[(?<alt>.*?)]\((?<filename>.*?)\s*(?="|\))"?(?<title>[^"]+)?"?\)/,
   (state, match, start, end) => {

package/src/node/list-item.ts

@@ -4,8 +4,10 @@ import { expectDomTypeError } from '@milkdown/exception'
 import { liftListItem, sinkListItem, splitListItem } from '@milkdown/prose/schema-list'
 import { $command, $nodeAttr, $nodeSchema, $useKeymap } from '@milkdown/utils'
 
+/// HTML attributes for list item node.
 export const listItemAttr = $nodeAttr('listItem')
 
+/// Schema for list item node.
 export const listItemSchema = $nodeSchema('list_item', ctx => ({
   group: 'listItem',
   content: 'paragraph block*',
@@ -67,10 +69,53 @@ export const listItemSchema = $nodeSchema('list_item', ctx => ({
   },
 }))
 
+/// The command to sink list item.
+///
+/// For example:
+/// ```md
+/// * List item 1
+/// * List item 2 <- cursor here
+/// ```
+/// Will get:
+/// ```md
+/// * List item 1
+///   * List item 2
+/// ```
 export const sinkListItemCommand = $command('SinkListItem', () => () => sinkListItem(listItemSchema.type()))
-export const splitListItemCommand = $command('SplitListItem', () => () => splitListItem(listItemSchema.type()))
+
+/// The command to lift list item.
+///
+/// For example:
+/// ```md
+/// * List item 1
+///   * List item 2 <- cursor here
+/// ```
+/// Will get:
+/// ```md
+/// * List item 1
+/// * List item 2
+/// ```
 export const liftListItemCommand = $command('SplitListItem', () => () => liftListItem(listItemSchema.type()))
 
+/// The command to split a list item.
+///
+/// For example:
+/// ```md
+/// * List item 1
+/// * List item 2 <- cursor here
+/// ```
+/// Will get:
+/// ```md
+/// * List item 1
+/// * List item 2
+/// * <- cursor here
+/// ```
+export const splitListItemCommand = $command('SplitListItem', () => () => splitListItem(listItemSchema.type()))
+
+/// Keymap for list item node.
+/// - `<Enter>`: Split the current list item.
+/// - `<Tab>/<Mod-]>`: Sink the current list item.
+/// - `<Shift-Tab>/<Mod-[>`: Lift the current list item.
 export const listItemKeymap = $useKeymap('listItemKeymap', {
   NextListItem: {
     shortcuts: 'Enter',