Skip to content

Commit a96dba3

Browse files
committed
docs: add markdown plugin documentation
1 parent a32133d commit a96dba3

File tree

4 files changed

+35
-0
lines changed

4 files changed

+35
-0
lines changed
Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Markdown
2+
3+
The Markdown plugin enables Markdown support in AdminForth, allowing users to create and edit records using Markdown syntax.
4+
5+
## Installation
6+
7+
To install the plugin:
8+
9+
```bash
10+
npm install @adminforth/markdown --save
11+
```
12+
13+
### Usage
14+
15+
Configure the plugin in your apartments resource file:
16+
17+
```typescript title="./resources/apartments.ts"
18+
import MarkdownPlugin from '@adminforth/markdown';
19+
20+
// ... existing resource configuration ...
21+
22+
plugins: [
23+
new MarkdownPlugin({fieldName: "description"}),
24+
]
25+
```
26+
27+
Here is how it looks in create view:
28+
29+
![alt text](markdown.png)
30+
31+
Here is how it looks in show view:
32+
33+
![alt text](markdown-show1.png)
34+
![alt text](markdown-show2.png)
35+
52.1 KB
Loading
57.1 KB
Loading
102 KB
Loading

0 commit comments

Comments
 (0)