Skip to content

Commit cbabed6

Browse files
authored
Revise README for improved clarity and formatting
Updated README to enhance clarity and structure.
1 parent a71f367 commit cbabed6

1 file changed

Lines changed: 12 additions & 17 deletions

File tree

README.md

Lines changed: 12 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -3,32 +3,29 @@
33
[![npm version](https://img.shields.io/npm/v/create-markdown.svg)](https://www.npmjs.com/package/create-markdown)
44
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
55

6-
A complete block-based markdown solution with zero dependencies. Parse, create, serialize, and render markdown with full TypeScript support.
6+
Lightweight, block-based markdown solution (_zero dependencies_). Parse, create, serialize, and render markdown with TypeScript support.
77

88
## Packages
9-
109
| Package | Version | Description |
1110
|---------|---------|-------------|
1211
| [@create-markdown/core](./packages/core) | 0.1.0 | Zero-dependency parsing and serialization |
1312
| [@create-markdown/react](./packages/react) | 0.1.0 | React components and hooks |
1413
| [@create-markdown/preview](./packages/preview) | 0.1.0 | HTML rendering with Shiki and Mermaid |
1514
| [create-markdown](./packages/create-markdown) | 0.1.0 | Convenience bundle |
1615

17-
## Features
18-
19-
- Block-based architecture - Work with structured blocks instead of raw strings
20-
- Bidirectional conversion - Parse markdown to blocks, serialize blocks to markdown
21-
- Rich inline styles - Bold, italic, code, links, strikethrough, highlights
22-
- React components - Optional React bindings for rendering and editing
23-
- HTML preview - Framework-agnostic HTML rendering with themes
24-
- Syntax highlighting - Shiki plugin for code blocks
25-
- Diagrams - Mermaid plugin for flowcharts, sequence diagrams, etc.
26-
- Web Component - `<markdown-preview>` custom element
27-
- Zero dependencies - Core package has no runtime dependencies
28-
- Full TypeScript - Complete type definitions with generics
16+
## Key Features
17+
- **Block-based architecture**: Work with structured blocks instead of raw strings
18+
- **Bidirectional conversion**: Parse markdown to blocks, serialize blocks to markdown
19+
- **Rich inline styles**: Bold, italic, code, links, strikethrough, highlights
20+
- **React components**: Optional React bindings for rendering and editing
21+
- **HTML preview**: Framework-agnostic HTML rendering with themes
22+
- **Syntax highlighting**: Shiki plugin for code blocks
23+
- **Diagrams**: Mermaid plugin for flowcharts, sequence diagrams, etc.
24+
- **Web Component**: `<markdown-preview>` custom element
25+
- **Zero dependencies**: Core package has no runtime dependencies
26+
- **Full TypeScript**: Complete type definitions with generics
2927

3028
## Installation
31-
3229
```bash
3330
# Install individual packages (recommended)
3431
bun add @create-markdown/core
@@ -40,9 +37,7 @@ bun add create-markdown
4037
```
4138

4239
## Quick Start
43-
4440
### Parse and Serialize Markdown
45-
4641
```typescript
4742
import { parse, stringify, h1, paragraph } from '@create-markdown/core';
4843

0 commit comments

Comments
 (0)