create-markdown 0.2.2 → 0.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.cjs +19 -1727
- package/dist/index.d.ts +6 -33
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +2 -1725
- package/dist/preview.cjs +40 -0
- package/dist/preview.d.ts +8 -0
- package/dist/preview.d.ts.map +1 -0
- package/dist/preview.js +2 -0
- package/dist/react.cjs +40 -0
- package/dist/react.d.ts +8 -0
- package/dist/react.d.ts.map +1 -0
- package/dist/react.js +2 -0
- package/package.json +36 -18
- package/LICENSE +0 -21
- package/README.md +0 -294
- package/dist/core/blocks.d.ts +0 -136
- package/dist/core/blocks.d.ts.map +0 -1
- package/dist/core/document.d.ts +0 -135
- package/dist/core/document.d.ts.map +0 -1
- package/dist/core/utils.d.ts +0 -80
- package/dist/core/utils.d.ts.map +0 -1
- package/dist/parsers/inline.d.ts +0 -14
- package/dist/parsers/inline.d.ts.map +0 -1
- package/dist/parsers/markdown.d.ts +0 -19
- package/dist/parsers/markdown.d.ts.map +0 -1
- package/dist/parsers/tokenizer.d.ts +0 -38
- package/dist/parsers/tokenizer.d.ts.map +0 -1
- package/dist/react/block-renderer.d.ts +0 -70
- package/dist/react/block-renderer.d.ts.map +0 -1
- package/dist/react/hooks.d.ts +0 -142
- package/dist/react/hooks.d.ts.map +0 -1
- package/dist/react/index.cjs +0 -1814
- package/dist/react/index.d.ts +0 -11
- package/dist/react/index.d.ts.map +0 -1
- package/dist/react/index.js +0 -1782
- package/dist/serializers/markdown.d.ts +0 -30
- package/dist/serializers/markdown.d.ts.map +0 -1
- package/dist/types/index.d.ts +0 -199
- package/dist/types/index.d.ts.map +0 -1
|
@@ -1,30 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* create-markdown — Markdown Serializer
|
|
3
|
-
* Convert: blocks to markdown strings
|
|
4
|
-
*/
|
|
5
|
-
import type { Block, TextSpan, MarkdownSerializeOptions, Document } from '../types';
|
|
6
|
-
/**
|
|
7
|
-
* Converts: array of blocks to a markdown string
|
|
8
|
-
*/
|
|
9
|
-
export declare function blocksToMarkdown(blocks: Block[], options?: MarkdownSerializeOptions): string;
|
|
10
|
-
/**
|
|
11
|
-
* Converts: document to a markdown string
|
|
12
|
-
*/
|
|
13
|
-
export declare function documentToMarkdown(doc: Document, options?: MarkdownSerializeOptions): string;
|
|
14
|
-
/**
|
|
15
|
-
* Serializes: single block to markdown
|
|
16
|
-
*/
|
|
17
|
-
export declare function serializeBlock(block: Block, depth: number, options: Required<MarkdownSerializeOptions>, index?: number, siblings?: Block[]): string;
|
|
18
|
-
/**
|
|
19
|
-
* Serializes: array of text spans to markdown
|
|
20
|
-
*/
|
|
21
|
-
export declare function serializeInlineContent(spans: TextSpan[], options: Required<MarkdownSerializeOptions>): string;
|
|
22
|
-
/**
|
|
23
|
-
* Serializes: single text span with its styles
|
|
24
|
-
*/
|
|
25
|
-
export declare function serializeSpan(span: TextSpan, options: Required<MarkdownSerializeOptions>): string;
|
|
26
|
-
/**
|
|
27
|
-
* Quick stringify function - converts: blocks to markdown
|
|
28
|
-
*/
|
|
29
|
-
export declare function stringify(blocks: Block[], options?: MarkdownSerializeOptions): string;
|
|
30
|
-
//# sourceMappingURL=markdown.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"markdown.d.ts","sourceRoot":"","sources":["../../src/serializers/markdown.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EACR,KAAK,EACL,QAAQ,EAER,wBAAwB,EACxB,QAAQ,EAOX,MAAM,UAAU,CAAC;AAoBlB;;GAEG;AACH,wBAAgB,gBAAgB,CAC5B,MAAM,EAAE,KAAK,EAAE,EACf,OAAO,GAAE,wBAA6B,GACvC,MAAM,CAUR;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAC9B,GAAG,EAAE,QAAQ,EACb,OAAO,GAAE,wBAA6B,GACvC,MAAM,CAER;AAMD;;GAEG;AACH,wBAAgB,cAAc,CAC1B,KAAK,EAAE,KAAK,EACZ,KAAK,EAAE,MAAM,EACb,OAAO,EAAE,QAAQ,CAAC,wBAAwB,CAAC,EAC3C,KAAK,GAAE,MAAU,EACjB,QAAQ,GAAE,KAAK,EAAO,GACvB,MAAM,CAuCR;AAgOD;;GAEG;AACH,wBAAgB,sBAAsB,CAClC,KAAK,EAAE,QAAQ,EAAE,EACjB,OAAO,EAAE,QAAQ,CAAC,wBAAwB,CAAC,GAC5C,MAAM,CAER;AAED;;GAEG;AACH,wBAAgB,aAAa,CACzB,IAAI,EAAE,QAAQ,EACd,OAAO,EAAE,QAAQ,CAAC,wBAAwB,CAAC,GAC5C,MAAM,CAuDR;AAqBD;;GAEG;AACH,wBAAgB,SAAS,CACrB,MAAM,EAAE,KAAK,EAAE,EACf,OAAO,CAAC,EAAE,wBAAwB,GACnC,MAAM,CAER"}
|
package/dist/types/index.d.ts
DELETED
|
@@ -1,199 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* create-markdown - Type Definitions
|
|
3
|
-
* Block-based document structure for markdown notes
|
|
4
|
-
*/
|
|
5
|
-
/**
|
|
6
|
-
* All supported block types in the document
|
|
7
|
-
*/
|
|
8
|
-
export type BlockType = 'paragraph' | 'heading' | 'bulletList' | 'numberedList' | 'checkList' | 'codeBlock' | 'blockquote' | 'table' | 'image' | 'divider' | 'callout';
|
|
9
|
-
/**
|
|
10
|
-
* Callout variants for styled callout blocks
|
|
11
|
-
*/
|
|
12
|
-
export type CalloutType = 'info' | 'warning' | 'tip' | 'danger' | 'note';
|
|
13
|
-
/**
|
|
14
|
-
* Link data for inline links
|
|
15
|
-
*/
|
|
16
|
-
export interface LinkData {
|
|
17
|
-
url: string;
|
|
18
|
-
title?: string;
|
|
19
|
-
}
|
|
20
|
-
/**
|
|
21
|
-
* Inline styles that can be applied to text spans
|
|
22
|
-
*/
|
|
23
|
-
export interface InlineStyle {
|
|
24
|
-
bold?: boolean;
|
|
25
|
-
italic?: boolean;
|
|
26
|
-
underline?: boolean;
|
|
27
|
-
strikethrough?: boolean;
|
|
28
|
-
code?: boolean;
|
|
29
|
-
highlight?: boolean;
|
|
30
|
-
link?: LinkData;
|
|
31
|
-
}
|
|
32
|
-
/**
|
|
33
|
-
* A span of text with optional inline styles
|
|
34
|
-
*/
|
|
35
|
-
export interface TextSpan {
|
|
36
|
-
text: string;
|
|
37
|
-
styles: InlineStyle;
|
|
38
|
-
}
|
|
39
|
-
/**
|
|
40
|
-
* Properties for heading blocks
|
|
41
|
-
*/
|
|
42
|
-
export interface HeadingProps {
|
|
43
|
-
level: 1 | 2 | 3 | 4 | 5 | 6;
|
|
44
|
-
}
|
|
45
|
-
/**
|
|
46
|
-
* Properties for code blocks
|
|
47
|
-
*/
|
|
48
|
-
export interface CodeBlockProps {
|
|
49
|
-
language?: string;
|
|
50
|
-
}
|
|
51
|
-
/**
|
|
52
|
-
* Properties for checklist items
|
|
53
|
-
*/
|
|
54
|
-
export interface CheckListProps {
|
|
55
|
-
checked: boolean;
|
|
56
|
-
}
|
|
57
|
-
/**
|
|
58
|
-
* Properties for image blocks
|
|
59
|
-
*/
|
|
60
|
-
export interface ImageProps {
|
|
61
|
-
url: string;
|
|
62
|
-
alt?: string;
|
|
63
|
-
title?: string;
|
|
64
|
-
width?: number;
|
|
65
|
-
height?: number;
|
|
66
|
-
}
|
|
67
|
-
/**
|
|
68
|
-
* Properties for callout blocks
|
|
69
|
-
*/
|
|
70
|
-
export interface CalloutProps {
|
|
71
|
-
type: CalloutType;
|
|
72
|
-
}
|
|
73
|
-
/**
|
|
74
|
-
* Properties for table blocks
|
|
75
|
-
*/
|
|
76
|
-
export interface TableProps {
|
|
77
|
-
headers: string[];
|
|
78
|
-
rows: string[][];
|
|
79
|
-
alignments?: ('left' | 'center' | 'right' | null)[];
|
|
80
|
-
}
|
|
81
|
-
/**
|
|
82
|
-
* Empty props for blocks that don't need additional properties
|
|
83
|
-
*/
|
|
84
|
-
export interface EmptyProps {
|
|
85
|
-
}
|
|
86
|
-
/**
|
|
87
|
-
* Map of block types to their property interfaces
|
|
88
|
-
*/
|
|
89
|
-
export interface BlockPropsMap {
|
|
90
|
-
paragraph: EmptyProps;
|
|
91
|
-
heading: HeadingProps;
|
|
92
|
-
bulletList: EmptyProps;
|
|
93
|
-
numberedList: EmptyProps;
|
|
94
|
-
checkList: CheckListProps;
|
|
95
|
-
codeBlock: CodeBlockProps;
|
|
96
|
-
blockquote: EmptyProps;
|
|
97
|
-
table: TableProps;
|
|
98
|
-
image: ImageProps;
|
|
99
|
-
divider: EmptyProps;
|
|
100
|
-
callout: CalloutProps;
|
|
101
|
-
}
|
|
102
|
-
/**
|
|
103
|
-
* Get the props type for a specific block type
|
|
104
|
-
*/
|
|
105
|
-
export type BlockProps<T extends BlockType> = BlockPropsMap[T];
|
|
106
|
-
/**
|
|
107
|
-
* Block in the document
|
|
108
|
-
* @template T - The block type
|
|
109
|
-
*/
|
|
110
|
-
export interface Block<T extends BlockType = BlockType> {
|
|
111
|
-
/** Unique identifier for the block */
|
|
112
|
-
id: string;
|
|
113
|
-
/** The type of block */
|
|
114
|
-
type: T;
|
|
115
|
-
/** Inline content (text spans with styles) */
|
|
116
|
-
content: TextSpan[];
|
|
117
|
-
/** Nested child blocks (for lists, etc.) */
|
|
118
|
-
children: Block[];
|
|
119
|
-
/** Type-specific properties */
|
|
120
|
-
props: BlockProps<T>;
|
|
121
|
-
}
|
|
122
|
-
/**
|
|
123
|
-
* Type-safe block creators
|
|
124
|
-
*/
|
|
125
|
-
export type ParagraphBlock = Block<'paragraph'>;
|
|
126
|
-
export type HeadingBlock = Block<'heading'>;
|
|
127
|
-
export type BulletListBlock = Block<'bulletList'>;
|
|
128
|
-
export type NumberedListBlock = Block<'numberedList'>;
|
|
129
|
-
export type CheckListBlock = Block<'checkList'>;
|
|
130
|
-
export type CodeBlockBlock = Block<'codeBlock'>;
|
|
131
|
-
export type BlockquoteBlock = Block<'blockquote'>;
|
|
132
|
-
export type TableBlock = Block<'table'>;
|
|
133
|
-
export type ImageBlock = Block<'image'>;
|
|
134
|
-
export type DividerBlock = Block<'divider'>;
|
|
135
|
-
export type CalloutBlock = Block<'callout'>;
|
|
136
|
-
/**
|
|
137
|
-
* Document metadata
|
|
138
|
-
*/
|
|
139
|
-
export interface DocumentMeta {
|
|
140
|
-
/** Document title */
|
|
141
|
-
title?: string;
|
|
142
|
-
/** Document description */
|
|
143
|
-
description?: string;
|
|
144
|
-
/** Author information */
|
|
145
|
-
author?: string;
|
|
146
|
-
/** Creation timestamp */
|
|
147
|
-
createdAt?: Date;
|
|
148
|
-
/** Last modification timestamp */
|
|
149
|
-
updatedAt?: Date;
|
|
150
|
-
/** Custom metadata fields */
|
|
151
|
-
[key: string]: unknown;
|
|
152
|
-
}
|
|
153
|
-
/**
|
|
154
|
-
* Complete markdown document
|
|
155
|
-
*/
|
|
156
|
-
export interface Document {
|
|
157
|
-
/** Document version for migrations */
|
|
158
|
-
version: number;
|
|
159
|
-
/** Array of blocks in the document */
|
|
160
|
-
blocks: Block[];
|
|
161
|
-
/** Document metadata */
|
|
162
|
-
meta: DocumentMeta;
|
|
163
|
-
}
|
|
164
|
-
/**
|
|
165
|
-
* Options for markdown serialization
|
|
166
|
-
*/
|
|
167
|
-
export interface MarkdownSerializeOptions {
|
|
168
|
-
/** Line ending character(s) */
|
|
169
|
-
lineEnding?: '\n' | '\r\n';
|
|
170
|
-
/** Number of spaces for list indentation */
|
|
171
|
-
listIndent?: number;
|
|
172
|
-
/** Heading style */
|
|
173
|
-
headingStyle?: 'atx' | 'setext';
|
|
174
|
-
/** Code block style */
|
|
175
|
-
codeBlockStyle?: 'fenced' | 'indented';
|
|
176
|
-
/** Bullet character for unordered lists */
|
|
177
|
-
bulletChar?: '-' | '*' | '+';
|
|
178
|
-
/** Emphasis character for bold/italic */
|
|
179
|
-
emphasisChar?: '*' | '_';
|
|
180
|
-
}
|
|
181
|
-
/**
|
|
182
|
-
* Options for markdown parsing
|
|
183
|
-
*/
|
|
184
|
-
export interface MarkdownParseOptions {
|
|
185
|
-
/** Custom ID generator function */
|
|
186
|
-
generateId?: () => string;
|
|
187
|
-
/** Enable strict parsing mode */
|
|
188
|
-
strict?: boolean;
|
|
189
|
-
}
|
|
190
|
-
/**
|
|
191
|
-
* Options for document creation
|
|
192
|
-
*/
|
|
193
|
-
export interface DocumentOptions {
|
|
194
|
-
/** Initial metadata */
|
|
195
|
-
meta?: Partial<DocumentMeta>;
|
|
196
|
-
/** Custom ID generator */
|
|
197
|
-
generateId?: () => string;
|
|
198
|
-
}
|
|
199
|
-
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAMH;;GAEG;AACH,MAAM,MAAM,SAAS,GACjB,WAAW,GACX,SAAS,GACT,YAAY,GACZ,cAAc,GACd,WAAW,GACX,WAAW,GACX,YAAY,GACZ,OAAO,GACP,OAAO,GACP,SAAS,GACT,SAAS,CAAC;AAEd;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,MAAM,GAAG,SAAS,GAAG,KAAK,GAAG,QAAQ,GAAG,MAAM,CAAC;AAMzE;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,IAAI,CAAC,EAAE,QAAQ,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,WAAW,CAAC;CACrB;AAMD;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,KAAK,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,OAAO,EAAE,OAAO,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,WAAW,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,IAAI,EAAE,MAAM,EAAE,EAAE,CAAC;IACjB,UAAU,CAAC,EAAE,CAAC,MAAM,GAAG,QAAQ,GAAG,OAAO,GAAG,IAAI,CAAC,EAAE,CAAC;CACrD;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;CAAG;AAE9B;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,SAAS,EAAE,UAAU,CAAC;IACtB,OAAO,EAAE,YAAY,CAAC;IACtB,UAAU,EAAE,UAAU,CAAC;IACvB,YAAY,EAAE,UAAU,CAAC;IACzB,SAAS,EAAE,cAAc,CAAC;IAC1B,SAAS,EAAE,cAAc,CAAC;IAC1B,UAAU,EAAE,UAAU,CAAC;IACvB,KAAK,EAAE,UAAU,CAAC;IAClB,KAAK,EAAE,UAAU,CAAC;IAClB,OAAO,EAAE,UAAU,CAAC;IACpB,OAAO,EAAE,YAAY,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,MAAM,UAAU,CAAC,CAAC,SAAS,SAAS,IAAI,aAAa,CAAC,CAAC,CAAC,CAAC;AAM/D;;;GAGG;AACH,MAAM,WAAW,KAAK,CAAC,CAAC,SAAS,SAAS,GAAG,SAAS;IACpD,sCAAsC;IACtC,EAAE,EAAE,MAAM,CAAC;IACX,wBAAwB;IACxB,IAAI,EAAE,CAAC,CAAC;IACR,8CAA8C;IAC9C,OAAO,EAAE,QAAQ,EAAE,CAAC;IACpB,4CAA4C;IAC5C,QAAQ,EAAE,KAAK,EAAE,CAAC;IAClB,+BAA+B;IAC/B,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,KAAK,CAAC,WAAW,CAAC,CAAC;AAChD,MAAM,MAAM,YAAY,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC;AAC5C,MAAM,MAAM,eAAe,GAAG,KAAK,CAAC,YAAY,CAAC,CAAC;AAClD,MAAM,MAAM,iBAAiB,GAAG,KAAK,CAAC,cAAc,CAAC,CAAC;AACtD,MAAM,MAAM,cAAc,GAAG,KAAK,CAAC,WAAW,CAAC,CAAC;AAChD,MAAM,MAAM,cAAc,GAAG,KAAK,CAAC,WAAW,CAAC,CAAC;AAChD,MAAM,MAAM,eAAe,GAAG,KAAK,CAAC,YAAY,CAAC,CAAC;AAClD,MAAM,MAAM,UAAU,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;AACxC,MAAM,MAAM,UAAU,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;AACxC,MAAM,MAAM,YAAY,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC;AAC5C,MAAM,MAAM,YAAY,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC;AAM5C;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,qBAAqB;IACrB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,2BAA2B;IAC3B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,yBAAyB;IACzB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,yBAAyB;IACzB,SAAS,CAAC,EAAE,IAAI,CAAC;IACjB,kCAAkC;IAClC,SAAS,CAAC,EAAE,IAAI,CAAC;IACjB,6BAA6B;IAC7B,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB,sCAAsC;IACtC,OAAO,EAAE,MAAM,CAAC;IAChB,sCAAsC;IACtC,MAAM,EAAE,KAAK,EAAE,CAAC;IAChB,wBAAwB;IACxB,IAAI,EAAE,YAAY,CAAC;CACpB;AAMD;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,+BAA+B;IAC/B,UAAU,CAAC,EAAE,IAAI,GAAG,MAAM,CAAC;IAC3B,4CAA4C;IAC5C,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,oBAAoB;IACpB,YAAY,CAAC,EAAE,KAAK,GAAG,QAAQ,CAAC;IAChC,uBAAuB;IACvB,cAAc,CAAC,EAAE,QAAQ,GAAG,UAAU,CAAC;IACvC,2CAA2C;IAC3C,UAAU,CAAC,EAAE,GAAG,GAAG,GAAG,GAAG,GAAG,CAAC;IAC7B,yCAAyC;IACzC,YAAY,CAAC,EAAE,GAAG,GAAG,GAAG,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,mCAAmC;IACnC,UAAU,CAAC,EAAE,MAAM,MAAM,CAAC;IAC1B,iCAAiC;IACjC,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,uBAAuB;IACvB,IAAI,CAAC,EAAE,OAAO,CAAC,YAAY,CAAC,CAAC;IAC7B,0BAA0B;IAC1B,UAAU,CAAC,EAAE,MAAM,MAAM,CAAC;CAC3B"}
|