|
1 | 1 | # Blazer Markdown Editor |
2 | | -A lightweight ProseMirror-based Markdown editor for Blazor (including MudBlazor) with slash commands, table editing, and JSInterop-friendly APIs. |
| 2 | +A lightweight (<550kb) ProseMirror-based javascript Markdown editor with slash commands, table editing, and JSInterop-friendly APIs. Developed as I needed a WYSIWYG markdown editor for Blazor but all I could find was react and vue components. Can be used standalone or authored into component for Blazor. Check the demo https://iamdabe.github.io/codex/ |
3 | 3 |
|
4 | 4 | ## Contents |
5 | 5 | - **[Features](#features)** |
6 | 6 | - **[Preview](#preview)** |
7 | | - - [Desktop](#desktop) |
8 | | - - [Mobile](#mobile) |
9 | 7 | - **[Install](#install)** |
10 | | - - [Install Method 1](#install-method-1) |
11 | 8 | - **[Third-Party](#third-party)** |
12 | 9 |
|
13 | 10 | Additional docs: |
14 | | -- [JSInterop Packaging](docs/jsinterop-packaging.md) |
15 | | -- [How to Use](docs/how-to-use.md) |
| 11 | +- [JSInterop Packaging](./docs/jsinterop-packaging.md) |
| 12 | +- [How to Use](./docs/how-to-use.md) |
16 | 13 |
|
17 | 14 | ## Features |
18 | 15 | * Markdown-first authoring with ProseMirror document model and serializer |
19 | 16 | * Blazor-focused JSInterop API: `create`, `setMarkdown`, `getMarkdown`, `focus`, `destroy` |
20 | 17 | * Productive editing features: slash menu, table controls, link toolbar, and keyboard shortcuts |
21 | 18 |
|
22 | 19 | ## Preview |
23 | | -### Desktop |
24 | | -Use `samples/index.html` to preview editor behavior in desktop browsers. |
25 | 20 |
|
26 | | -### Mobile |
27 | | -Use device emulation (or a real device) with `samples/index.html` to validate responsive behavior and touch interactions. |
| 21 | +<div style="display:flex; flex-wrap:wrap; gap:15px;"> |
| 22 | + |
| 23 | +<a href="./docs/preview.png"> |
| 24 | + <img src="./docs/preview.png" alt="Preview" width="300"> |
| 25 | +</a> |
| 26 | + |
| 27 | +<a href="./docs/slash-menu.png"> |
| 28 | + <img src="./docs/slash-menu.png" alt="Slash Menu" width="300"> |
| 29 | +</a> |
| 30 | +</div> |
| 31 | + |
28 | 32 |
|
29 | 33 | ## Install |
30 | | -### Install Method 1 |
31 | 34 | 1. Install dependencies: |
32 | 35 | - `npm ci` |
33 | 36 | 2. Build distributable assets: |
|
0 commit comments