Expose @lezer/markdown and addMarkdownConfig

Author: cyanzhong

README.md

@@ -16,7 +16,7 @@ Add `markedit-api` to your (TypeScript) project's devDependencies:
 ```json
 {
   "devDependencies": {
-    "markedit-api": "https://github.com/MarkEdit-app/MarkEdit-api#v0.2.0"
+    "markedit-api": "https://github.com/MarkEdit-app/MarkEdit-api#v0.3.0"
   }
 }
 ```
@@ -35,12 +35,14 @@ interface MarkEdit {
   editorView: EditorView;
   // Convenient text editing interfaces.
   editorAPI: TextEditable;
-  // Add an extension to MarkEdit.
-  addExtension: (extension: Extension) => void;
   // CodeMirror modules used by MarkEdit.
   codemirror: { view, state, language, commands, search };
   // Lezer modules used by MarkEdit.
-  lezer: { common, highlight, lr },
+  lezer: { common, highlight, markdown, lr };
+  // Add an extension to MarkEdit.
+  addExtension: (extension: Extension) => void;
+  // Add a Markdown config to MarkEdit.
+  addMarkdownConfig: (config: MarkdownConfig) => void;
 }
 ```
 

markedit.d.ts

@@ -1,5 +1,6 @@
 import type { EditorView } from '@codemirror/view';
 import type { Extension } from '@codemirror/state';
+import type { MarkdownConfig } from '@lezer/markdown';
 
 import type * as cmView from '@codemirror/view';
 import type * as cmState from '@codemirror/state';
@@ -9,6 +10,7 @@ import type * as cmSearch from '@codemirror/search';
 
 import type * as lezerCommon from '@lezer/common';
 import type * as lezerHighlight from '@lezer/highlight';
+import type * as lezerMarkdown from '@lezer/markdown';
 import type * as lezerLr from '@lezer/lr';
 
 export const MarkEdit: MarkEdit;
@@ -68,6 +70,11 @@ export interface MarkEdit {
      */
     highlight: typeof lezerHighlight;
 
+    /**
+     * The `@lezer/markdown` module.
+     */
+    markdown: typeof lezerMarkdown;
+
     /**
      * The `@lezer/lr` module.
      */
@@ -79,6 +86,12 @@ export interface MarkEdit {
    * @param extension CodeMirror extension.
    */
   addExtension: (extension: Extension) => void;
+
+  /**
+   * Add a Markdown config to MarkEdit.
+   * @param config Markdown config.
+   */
+  addMarkdownConfig: (config: MarkdownConfig) => void;
 }
 
 export interface TextEditable {

package.json

@@ -1,6 +1,6 @@
 {
   "name": "markedit-api",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "Type definitions for the latest MakrEdit API.",
   "main": "main.ts",
   "types": "markedit.d.ts",
@@ -13,6 +13,7 @@
     "@codemirror/view": "^6.0.0",
     "@lezer/common": "^1.0.0",
     "@lezer/highlight": "^1.0.0",
-    "@lezer/lr": "^1.0.0"
+    "@lezer/lr": "^1.0.0",
+    "@lezer/markdown": "^1.0.0"
   }
 }