@docfuse/markdown 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Docfuse Contributors
+
+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/README.md

@@ -0,0 +1,50 @@
+# @docfuse/markdown
+
+English | [简体中文](./README.zh-CN.md)
+
+`@docfuse/markdown` renders Markdown in React and provides build or SSR rendering for Markdown and trusted MDX. It also publishes shared theme tokens and behavior-based browser enhancement.
+
+## Install and render
+
+```bash
+pnpm add @docfuse/markdown react react-dom
+```
+
+```tsx
+import { Markdown } from '@docfuse/markdown'
+import '@docfuse/markdown/base.css'
+import '@docfuse/markdown/theme.css'
+
+export function Article({ source }: { source: string }) {
+  return <Markdown source={source} />
+}
+```
+
+## Public entries
+
+- `@docfuse/markdown` provides the React renderer and plugin contract.
+- `@docfuse/markdown/server` provides the Markdown and trusted-MDX build or SSR renderer.
+- `@docfuse/markdown/server/analyze` analyzes document features without rendering.
+- `@docfuse/markdown/client` enhances generated static HTML.
+- `@docfuse/markdown/theme` provides the shared theme contract.
+- `@docfuse/markdown/base.css` and `@docfuse/markdown/theme.css` provide the public style layers.
+
+Optional syntax such as formulas is supplied by `@docfuse/plugins`:
+
+```bash
+pnpm add @docfuse/plugins
+```
+
+```tsx
+import { Markdown } from '@docfuse/markdown'
+import { math } from '@docfuse/plugins'
+import '@docfuse/markdown/base.css'
+import '@docfuse/markdown/theme.css'
+import '@docfuse/plugins/math.css'
+
+<Markdown source={source} options={{ plugins: [math()] }} />
+```
+
+See the [Markdown documentation](https://docfuse.dev/en/markdown/) for renderer options, MDX, syntax, theming, and browser enhancement.
+
+License: MIT

package/README.zh-CN.md

@@ -0,0 +1,50 @@
+# @docfuse/markdown
+
+[English](./README.md) | 简体中文
+
+`@docfuse/markdown` 在 React 中渲染 Markdown，并为 Markdown 与可信 MDX 提供构建或 SSR 渲染器。包内还提供共享主题 Token 和按行为加载的浏览器增强。
+
+## 安装与渲染
+
+```bash
+pnpm add @docfuse/markdown react react-dom
+```
+
+```tsx
+import { Markdown } from '@docfuse/markdown'
+import '@docfuse/markdown/base.css'
+import '@docfuse/markdown/theme.css'
+
+export function Article({ source }: { source: string }) {
+  return <Markdown source={source} />
+}
+```
+
+## 公开入口
+
+- `@docfuse/markdown` 提供 React 渲染器和插件契约。
+- `@docfuse/markdown/server` 提供 Markdown 与可信 MDX 的构建或 SSR 渲染器。
+- `@docfuse/markdown/server/analyze` 只分析文档能力，不执行渲染。
+- `@docfuse/markdown/client` 增强已经生成的静态 HTML。
+- `@docfuse/markdown/theme` 提供共享主题契约。
+- `@docfuse/markdown/base.css` 和 `@docfuse/markdown/theme.css` 是公开样式入口。
+
+数学公式等可选语法由 `@docfuse/plugins` 提供：
+
+```bash
+pnpm add @docfuse/plugins
+```
+
+```tsx
+import { Markdown } from '@docfuse/markdown'
+import { math } from '@docfuse/plugins'
+import '@docfuse/markdown/base.css'
+import '@docfuse/markdown/theme.css'
+import '@docfuse/plugins/math.css'
+
+<Markdown source={source} options={{ plugins: [math()] }} />
+```
+
+渲染选项、MDX、写作语法、主题和浏览器增强见 [Markdown 文档](https://docfuse.dev/markdown/)。
+
+许可证：MIT