takumi-markdown 1.0.0

package/README.md

@@ -0,0 +1,65 @@
+# Takumi Markdown (匠)
+
+Beautiful Markdown renderer for React with Japanese typography optimization and ruby notation support.
+
+## Features
+
+- 🎨 **Beautiful Typography** - Optimized for Japanese (CJK) text
+- 📝 **Ruby Notation** - Support for `｜親文字《ルビ》` syntax (小説家になろう/カクヨム style)
+- 📋 **Frontmatter** - YAML frontmatter parsing and display
+- ✨ **GFM Support** - Tables, checkboxes, and more
+- 🎯 **Syntax Highlighting** - Code blocks with highlight.js
+
+## Installation
+
+```bash
+npm install takumi-markdown
+```
+
+## Usage
+
+```tsx
+import { MarkdownRenderer } from 'takumi-markdown';
+import 'takumi-markdown/styles.css';
+
+function App() {
+  const markdown = `
+# タイトル
+
+これは**美しい**マークダウンです。
+
+｜山田太郎《やまだたろう》は旅に出た。
+`;
+
+  return <MarkdownRenderer content={markdown} />;
+}
+```
+
+## Ruby Notation
+
+Supports 小説家になろう / カクヨム style ruby (furigana) notation:
+
+| Syntax | Result |
+|--------|--------|
+| `｜漢字《かんじ》` | <ruby>漢字<rt>かんじ</rt></ruby> |
+| `漢字《かんじ》` | <ruby>漢字<rt>かんじ</rt></ruby> (auto-detect) |
+
+## API
+
+### `<MarkdownRenderer />`
+
+| Prop | Type | Description |
+|------|------|-------------|
+| `content` | `string` | Markdown content to render |
+
+### `remarkRuby`
+
+Remark plugin for ruby notation. Exported for advanced users who want to use it with their own react-markdown setup.
+
+```tsx
+import remarkRuby from 'takumi-markdown/remarkRuby';
+```
+
+## License
+
+MIT

package/dist/components/MarkdownRenderer.d.ts

@@ -0,0 +1,7 @@
+import React from 'react';
+import '../styles/typography.css';
+import 'highlight.js/styles/github.css';
+export interface MarkdownRendererProps {
+    content: string;
+}
+export declare const MarkdownRenderer: React.FC<MarkdownRendererProps>;

package/dist/lib/index.d.ts

@@ -0,0 +1,3 @@
+export { MarkdownRenderer } from '../components/MarkdownRenderer';
+export type { MarkdownRendererProps } from '../components/MarkdownRenderer';
+export { default as remarkRuby } from '../plugins/remarkRuby';

package/dist/plugins/remarkRuby.d.ts

@@ -0,0 +1,16 @@
+import type { Plugin } from 'unified';
+import type { Root } from 'mdast';
+/**
+ * Remark plugin to convert ruby notation to HTML ruby elements
+ *
+ * Supports the following formats (compatible with 小説家になろう / カクヨム):
+ * - ｜親文字《ルビ》 (explicit delimiter with full-width pipe)
+ * - |親文字《ルビ》 (explicit delimiter with half-width pipe)
+ * - 漢字《かんじ》 (auto-detect kanji)
+ *
+ * @example
+ * Input: ｜山田太郎《やまだたろう》
+ * Output: <ruby>山田太郎<rt>やまだたろう</rt></ruby>
+ */
+declare const remarkRuby: Plugin<[], Root>;
+export default remarkRuby;