moondown 0.1.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,435 @@
+# Moondown
+
+![Moondown Logo](assets/logo_char.png)
+
+[English README](README_EN.md)
+
+Moondown 是一个基于 CodeMirror 6 的无头 Markdown 编辑器。它提供了成熟的编辑核心，支持 Markdown 语法隐藏、斜杠菜单、气泡菜单、表格编辑、图片组件、Mermaid 图表、LaTeX 预览以及 AI 集成扩展点，同时保持与前端框架无关。
+
+Moondown 是一个独立的开源项目，定位是嵌入到你的应用中，而不是提供固定的应用壳。
+
+## 功能特性
+
+- 基于 CodeMirror 6 的 Markdown 编辑
+- 浅色与深色主题
+- 语法隐藏，获得更清爽的写作体验
+- 斜杠菜单
+- 选区气泡菜单
+- 行内格式：粗体、斜体、高亮、下划线、删除线、行内代码
+- 标题、有序列表、无序列表、引用、分割线
+- 可编辑 Markdown 表格
+- 图片渲染与编辑
+- Mermaid 代码块预览
+- 基于 KaTeX 的 LaTeX 代码块预览
+- 支持图片、Mermaid、LaTeX 组件的源码编辑
+- AI 续写与润色扩展钩子
+- 通过翻译覆盖实现国际化
+- 插件 API（CodeMirror 扩展、生命周期钩子、自定义斜杠命令）
+- 本地 playground 用于视觉 QA 与集成测试
+
+## 安装
+
+```bash
+npm install moondown
+```
+
+或者：
+
+```bash
+pnpm add moondown
+```
+
+导入编辑器及样式：
+
+```ts
+import Moondown from 'moondown';
+import 'moondown/style.css';
+import 'tippy.js/dist/tippy.css';
+```
+
+`tippy` 样式用于表格辅助浮层。
+
+## 快速开始
+
+```ts
+import Moondown from 'moondown';
+import 'moondown/style.css';
+import 'tippy.js/dist/tippy.css';
+
+const container = document.querySelector('#editor');
+
+if (!container) {
+  throw new Error('Editor container not found');
+}
+
+const editor = new Moondown(container as HTMLElement, '# Hello Moondown', {
+  theme: 'light',
+  syntaxHiding: true,
+  placeholder: 'Write something...',
+  onChange: () => {
+    console.log(editor.getValue());
+  },
+});
+```
+
+编辑器实例提供了简洁的命令式 API：
+
+```ts
+editor.getValue();
+editor.setValue('# Updated');
+editor.setTheme('dark');
+editor.toggleSyntaxHiding(false);
+editor.setReadOnly(true);
+editor.focus();
+editor.destroy();
+```
+
+## 基础 HTML
+
+```html
+<div id="editor"></div>
+```
+
+Moondown 会填充你提供的容器。请在应用内设置容器尺寸：
+
+```css
+#editor {
+  min-height: 480px;
+}
+```
+
+## Markdown 组件
+
+### 图片
+
+```md
+![Alt text](https://example.com/image.png)
+```
+
+图片组件支持选中、编辑、删除，并可在只读模式下受保护。
+
+### Mermaid
+
+````md
+```mermaid
+flowchart TD
+  Draft --> Review
+  Review --> Publish
+```
+````
+
+Mermaid 代码块会渲染为图表预览。点击预览可选中对应源码块进行编辑。
+
+### LaTeX
+
+````md
+```latex
+\int_0^1 x^2 dx = \frac{1}{3}
+\sum_{i=1}^{n} i = \frac{n(n+1)}{2}
+```
+````
+
+LaTeX 代码块按行渲染，多行源码会保持多行预览。
+
+## 配置
+
+```ts
+import type { EditorConfig } from 'moondown';
+
+const config: EditorConfig = {
+  theme: 'light',
+  syntaxHiding: true,
+  placeholder: 'Start writing...',
+  readOnly: false,
+  locale: 'en',
+  translations: {},
+  onChange(update) {
+    console.log(update.state.doc.toString());
+  },
+  onFocus() {
+    console.log('focused');
+  },
+  onBlur() {
+    console.log('blurred');
+  },
+};
+```
+
+### EditorConfig
+
+| 选项 | 类型 | 默认值 | 说明 |
+| --- | --- | --- | --- |
+| `theme` | `'light' \| 'dark'` | `'light'` | 编辑器初始主题。 |
+| `syntaxHiding` | `boolean` | `true` | 尽可能隐藏 Markdown 语法标记。 |
+| `placeholder` | `string` | `''` | 空文档时展示的占位文本。 |
+| `readOnly` | `boolean` | `false` | 禁止文档内容修改。 |
+| `locale` | `string` | `'en'` | 内置 UI 与 AI 提示所用语言区域。 |
+| `translations` | `Record<string, string>` | `{}` | UI 文案覆盖。 |
+| `onAIStream` | `AIStreamHandler` | `null` | 流式 AI 提供方钩子。 |
+| `plugins` | `MoondownPlugin[]` | `[]` | 用户插件列表。 |
+| `onChange` | `(update) => void` | `undefined` | 文档变更后触发。 |
+| `onFocus` | `() => void` | `undefined` | 编辑器获得焦点时触发。 |
+| `onBlur` | `() => void` | `undefined` | 编辑器失去焦点时触发。 |
+
+## AI 集成
+
+Moondown 不内置托管 AI 服务。你需要提供一个 `onAIStream` 函数，并返回 `ReadableStream<string>`。
+
+```ts
+import Moondown, type AIStreamHandler from 'moondown';
+
+const onAIStream: AIStreamHandler = async (systemPrompt, userPrompt, signal) => {
+  const response = await fetch('/api/ai', {
+    method: 'POST',
+    headers: {
+      'Content-Type': 'application/json',
+    },
+    body: JSON.stringify({ systemPrompt, userPrompt }),
+    signal,
+  });
+
+  if (!response.ok || !response.body) {
+    throw new Error(`AI request failed: ${response.status}`);
+  }
+
+  const reader = response.body.getReader();
+  const decoder = new TextDecoder();
+
+  return new ReadableStream<string>({
+    async start(controller) {
+      while (true) {
+        const { done, value } = await reader.read();
+        if (done) break;
+        controller.enqueue(decoder.decode(value, { stream: true }));
+      }
+      controller.close();
+    },
+  });
+};
+
+new Moondown(document.querySelector('#editor') as HTMLElement, '', {
+  onAIStream,
+});
+```
+
+不要在浏览器端暴露模型服务商 API Key。请通过你自己的后端转发真实模型调用。
+
+## 插件
+
+插件可以贡献 CodeMirror 扩展、生命周期钩子和斜杠命令。
+
+```ts
+import { defineMoondownPlugin } from 'moondown';
+
+const templatePlugin = defineMoondownPlugin({
+  name: 'template-plugin',
+  slashCommands: [
+    {
+      id: 'template.decision',
+      title: 'Decision Note',
+      icon: 'file-plus',
+      keywords: ['decision', 'adr'],
+      execute(view) {
+        const pos = view.state.selection.main.from;
+        view.dispatch({
+          changes: {
+            from: pos,
+            insert: '## Decision\n\n- Context:\n- Options:\n- Outcome:\n',
+          },
+        });
+      },
+    },
+  ],
+});
+
+new Moondown(document.querySelector('#editor') as HTMLElement, '', {
+  plugins: [templatePlugin],
+});
+```
+
+你也可以包装原生 CodeMirror 扩展：
+
+```ts
+import { createExtensionPlugin } from 'moondown';
+
+const myPlugin = createExtensionPlugin('my-extension', myCodeMirrorExtension);
+```
+
+## 主题
+
+Moondown 样式基于 CSS 自定义属性。你可以在应用层覆盖：
+
+```css
+:root {
+  --color-primary-hsl: 211 100% 50%;
+  --color-primary-light-hsl: 209 100% 72%;
+  --color-primary-dark-hsl: 211 100% 42%;
+}
+```
+
+这些变量会影响选区颜色、Markdown 标记、列表项目符号、链接、引用强调、组件、菜单和 AI 面板控件。
+
+运行时切换主题：
+
+```ts
+editor.setTheme('dark');
+```
+
+## 国际化
+
+通过 `translations` 覆盖内置 UI 文案：
+
+```ts
+new Moondown(container, '', {
+  locale: 'zh-CN',
+  translations: {
+    'moondown.slash.heading1': '一级标题',
+    'moondown.slash.insertTable': '插入表格',
+    'moondown.ai.polish.buttons.retry': '重试',
+    'moondown.ai.polish.buttons.copy': '复制',
+    'moondown.ai.polish.buttons.insert': '插入',
+    'moondown.ai.polish.placeholder': '描述你想如何润色选中文本...',
+  },
+});
+```
+
+## 开发
+
+环境要求：
+
+- Node.js `>= 22`
+- pnpm `>= 10`
+
+安装依赖：
+
+```bash
+pnpm install
+```
+
+运行本地 playground：
+
+```bash
+pnpm run dev
+```
+
+默认 playground 地址：
+
+```text
+http://localhost:5174
+```
+
+使用自定义端口：
+
+```bash
+PORT=5175 pnpm run dev
+```
+
+## 脚本
+
+| 命令 | 说明 |
+| --- | --- |
+| `pnpm run check` | 进行 TypeScript 类型检查。 |
+| `pnpm run build` | 构建 ESM、CJS、类型声明和 CSS 到 `dist/`。 |
+| `pnpm run build:playground` | 构建静态 playground 到 `playground-dist/`。 |
+| `pnpm run test:unit` | 运行单元测试。 |
+| `pnpm run test:e2e` | 运行浏览器 E2E 测试。 |
+| `pnpm run test:e2e:real-ai` | 运行可选的真实 AI 集成测试。 |
+| `pnpm run test:ai:smoke` | 对 OpenAI 兼容 AI 接口做冒烟测试。 |
+| `pnpm run test:full` | 类型检查 + 构建 + 单测 + E2E 全量测试。 |
+
+## 测试
+
+在提交 PR 或发布版本前，建议运行：
+
+```bash
+pnpm run test:full
+```
+
+AI 服务集成测试请先配置环境变量，再运行：
+
+```bash
+DEEPSEEK_ENDPOINT='https://example.com/openai/v1/' \
+DEEPSEEK_MODEL='your-model' \
+DEEPSEEK_API_KEY='your-key' \
+pnpm run test:e2e:real-ai
+```
+
+## 发布
+
+该包已配置为公开发布到 npm：
+
+```json
+{
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    },
+    "./style.css": "./dist/style.css"
+  },
+  "files": ["dist", "README.md", "LICENSE"],
+  "publishConfig": {
+    "access": "public"
+  }
+}
+```
+
+推荐发布流程：
+
+```bash
+pnpm install
+pnpm run test:full
+npm login
+npm whoami
+npm version patch
+npm pack --dry-run
+npm publish --access public
+```
+
+如需升级次版本或主版本，可使用 `npm version minor` 或 `npm version major`。
+
+如果你的 npm 账号或包开启了发布双重认证，发布时 npm 会提示输入 OTP。自动化发布场景建议使用具备发布权限的 granular npm token。
+
+npm 官方参考：
+
+- [创建并发布非 scoped 公共包](https://docs.npmjs.com/creating-and-publishing-unscoped-public-packages/)
+- [创建并发布 scoped 公共包](https://docs.npmjs.com/creating-and-publishing-scoped-public-packages)
+- [npm publish CLI 命令](https://docs.npmjs.com/cli/v11/commands/npm-publish)
+- [为包发布开启 2FA](https://docs.npmjs.com/requiring-2fa-for-package-publishing-and-settings-modification)
+
+## 包内容
+
+发布后的 npm 包包含：
+
+- `dist/index.js`
+- `dist/index.cjs`
+- `dist/index.d.ts`
+- `dist/style.css`
+- `README.md`
+- `LICENSE`
+
+发布前可通过以下命令确认打包文件：
+
+```bash
+npm pack --dry-run
+```
+
+## 贡献
+
+欢迎提交 issue 和 pull request。请尽量保持改动聚焦，并为会影响编辑器输出、浏览器交互、组件行为或公共 API 的变更补充测试。
+
+建议检查项：
+
+```bash
+pnpm run check
+pnpm run test:unit
+pnpm run test:e2e
+```
+
+## 许可证
+
+Apache-2.0