@ritedown/core 0.0.0-stage → 2.1.0-beta.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 duichuai (https://duichuai.com)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/index.d.ts

@@ -0,0 +1,52 @@
+import { type Pluggable } from 'unified';
+import remarkGfm from 'remark-gfm';
+import type { Root } from 'mdast';
+export type { Root } from 'mdast';
+export type { Pluggable } from 'unified';
+/**
+ * Syntax extensions available to the pipeline.
+ * Ritedown core ships with zero extensions enabled by default —
+ * callers opt in explicitly (see `builtin`).
+ */
+export interface RitedownOptions {
+    /** remark/rehype plugins to extend the pipeline */
+    extensions?: Pluggable[];
+}
+/** Built-in extension registry (GFM: tables, task lists, strikethrough, autolinks, footnotes, alerts) */
+export declare const builtin: {
+    readonly gfm: typeof remarkGfm;
+};
+/**
+ * Descriptor for a Ritedown plugin: a named bundle of remark/rehype
+ * extensions plus optional editor-side hooks.
+ */
+export interface RitedownPlugin {
+    /** stable identifier used for enable/disable persistence */
+    id: string;
+    /** display name (i18n keys or literal text) */
+    name: string;
+    /** short description shown in the settings panel */
+    description?: string;
+    /** remark (or array-form) plugin injected into the pipeline */
+    remark?: Pluggable;
+    /** rehype plugin injected after remarkRehype */
+    rehype?: Pluggable;
+    /** enabled when the user has never toggled it (default true) */
+    defaultEnabled?: boolean;
+    /**
+     * CodeMirror extension factory for editor-side syntax support.
+     * Typed `unknown` so core keeps zero editor dependencies; callers
+     * narrow the result to their own Extension type.
+     */
+    editorExtension?: () => unknown;
+}
+/**
+ * Plugins bundled with core, in canonical declaration order.
+ * Order matters: callers must preserve it when assembling pipelines.
+ */
+export declare const builtinPlugins: RitedownPlugin[];
+/** Parse markdown into an mdast tree (CommonMark 0.31.2 + enabled extensions;
+ * transformer-phase plugins like gemoji run too). */
+export declare function parse(markdown: string, options?: RitedownOptions): Root;
+/** Render markdown to HTML (CommonMark 0.31.2 + enabled extensions). */
+export declare function render(markdown: string, options?: RitedownOptions): string;

package/dist/index.js

@@ -0,0 +1,51 @@
+import { unified } from 'unified';
+import remarkParse from 'remark-parse';
+import remarkGfm from 'remark-gfm';
+import remarkRehype from 'remark-rehype';
+import rehypeStringify from 'rehype-stringify';
+import remarkGfmAlerts from '@ritedown/gfm-alerts';
+/** Built-in extension registry (GFM: tables, task lists, strikethrough, autolinks, footnotes, alerts) */
+export const builtin = {
+    gfm: remarkGfm,
+};
+/**
+ * Plugins bundled with core, in canonical declaration order.
+ * Order matters: callers must preserve it when assembling pipelines.
+ */
+export const builtinPlugins = [
+    {
+        id: 'gfm',
+        name: 'GFM',
+        description: 'Tables, task lists, strikethrough, autolinks, footnotes',
+        remark: builtin.gfm,
+        defaultEnabled: true,
+    },
+    {
+        id: 'gfmAlerts',
+        name: 'GFM Alerts',
+        description: '> [!NOTE] / [!TIP] / [!IMPORTANT] / [!WARNING] / [!CAUTION] blocks',
+        remark: remarkGfmAlerts,
+        defaultEnabled: true,
+    },
+];
+function createProcessor(options = {}) {
+    return unified()
+        .use(remarkParse)
+        .use(options.extensions ?? [])
+        .use(remarkRehype)
+        .use(rehypeStringify);
+}
+/** remark-only pipeline (no rehype): used by parse() to stay in mdast */
+function createParser(options = {}) {
+    return unified().use(remarkParse).use(options.extensions ?? []);
+}
+/** Parse markdown into an mdast tree (CommonMark 0.31.2 + enabled extensions;
+ * transformer-phase plugins like gemoji run too). */
+export function parse(markdown, options) {
+    const processor = createParser(options);
+    return processor.runSync(processor.parse(markdown));
+}
+/** Render markdown to HTML (CommonMark 0.31.2 + enabled extensions). */
+export function render(markdown, options) {
+    return String(createProcessor(options).processSync(markdown));
+}

package/package.json

@@ -1,6 +1,51 @@
 {
   "name": "@ritedown/core",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "2.1.0-beta.0",
+  "description": "Ritedown kernel: Markdown parse & render pipeline (CommonMark 0.31.2 based, pluggable extensions)",
+  "license": "MIT",
+  "author": "duichuai",
+  "homepage": "https://duichuai.com",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/duichuai/ritedown.git",
+    "directory": "packages/core"
+  },
+  "bugs": {
+    "url": "https://github.com/duichuai/ritedown/issues"
+  },
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/",
+    "access": "public"
+  },
+  "dependencies": {
+    "remark-gfm": "^4.0.0",
+    "remark-parse": "^11.0.0",
+    "remark-rehype": "^11.1.0",
+    "rehype-stringify": "^10.0.1",
+    "unified": "^11.0.5",
+    "@ritedown/gfm-alerts": "2.1.0-beta.0"
+  },
+  "devDependencies": {
+    "@types/node": "^20.0.0",
+    "tsx": "^4.19.0",
+    "typescript": "^5.6.0",
+    "vitest": "^3.0.0"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "test": "vitest run",
+    "demo": "tsx src/demo.ts"
+  }
 }

package/README.md

@@ -1,3 +0,0 @@
-# Temporary Holding Version
-
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.