Skip to content

Commit 6200fb8

Browse files
committed
Readme doocs and previews
1 parent 25af759 commit 6200fb8

5 files changed

Lines changed: 15 additions & 16 deletions

File tree

README.md

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,36 @@
11
# 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/
33

44
## Contents
55
- **[Features](#features)**
66
- **[Preview](#preview)**
7-
- [Desktop](#desktop)
8-
- [Mobile](#mobile)
97
- **[Install](#install)**
10-
- [Install Method 1](#install-method-1)
118
- **[Third-Party](#third-party)**
129

1310
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)
1613

1714
## Features
1815
* Markdown-first authoring with ProseMirror document model and serializer
1916
* Blazor-focused JSInterop API: `create`, `setMarkdown`, `getMarkdown`, `focus`, `destroy`
2017
* Productive editing features: slash menu, table controls, link toolbar, and keyboard shortcuts
2118

2219
## Preview
23-
### Desktop
24-
Use `samples/index.html` to preview editor behavior in desktop browsers.
2520

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+
2832

2933
## Install
30-
### Install Method 1
3134
1. Install dependencies:
3235
- `npm ci`
3336
2. Build distributable assets:

docs/how-to-use.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,5 +31,4 @@ Use the global object:
3131

3232
## Notes
3333
- Keep `wwwroot` outputs as release artifacts (`js`, `min.js`, `css`).
34-
- Keep dependency versions pinned for deterministic behavior.
3534
- Use the packaging guidance in [jsinterop-packaging.md](jsinterop-packaging.md).

docs/jsinterop-packaging.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -44,11 +44,8 @@ JSInterop API:
4444
- `window.blazerMarkdownEditor.focus(editorId)`
4545
- `window.blazerMarkdownEditor.destroy(editorId)`
4646

47-
## Release process (artifact-only)
4847

49-
Create a GitHub release with only the `wwwroot` files for that version.
50-
51-
Suggested release assets:
48+
Required assets:
5249

5350
- `wwwroot/blazer-markdown-editor.js`
5451
- `wwwroot/blazer-markdown-editor.min.js`

docs/preview.png

84 KB
Loading

docs/slash-menu.png

18.5 KB
Loading

0 commit comments

Comments
 (0)