Skip to content

Commit 85343d8

Browse files
authored
docs: Update 14-markdown.md
1 parent a96dba3 commit 85343d8

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

adminforth/documentation/docs/tutorial/05-Plugins/14-markdown.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# Markdown
22

3-
The Markdown plugin enables Markdown support in AdminForth, allowing users to create and edit records using Markdown syntax.
3+
The Markdown plugin enables Markdown support in AdminForth, allowing users to create and edit fields using Markdown syntax and save rich content in Markdown syntax.
4+
5+
Also, it allows previewing of Markdown fields in the show page.
46

57
## Installation
68

@@ -12,7 +14,7 @@ npm install @adminforth/markdown --save
1214

1315
### Usage
1416

15-
Configure the plugin in your apartments resource file:
17+
Instantiate the plugin in your apartments resource file for 'description' field.
1618

1719
```typescript title="./resources/apartments.ts"
1820
import MarkdownPlugin from '@adminforth/markdown';
@@ -24,7 +26,9 @@ plugins: [
2426
]
2527
```
2628

27-
Here is how it looks in create view:
29+
> Please note that plugin can only work on TEXT and STRING fields
30+
31+
Here is how it looks in the create view:
2832

2933
![alt text](markdown.png)
3034

0 commit comments

Comments
 (0)