Skip to content

Commit 5d40bd4

Browse files
committed
doc: Update README
1 parent e2afe10 commit 5d40bd4

File tree

1 file changed

+34
-31
lines changed

1 file changed

+34
-31
lines changed

.github/README.md

Lines changed: 34 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,48 +1,51 @@
11
# jcdcdev.Umbraco.ExtendedMarkdownEditor
22

3-
[![Umbraco Marketplace](https://img.shields.io/badge/Umbraco-Marketplace-%233544B1?style=flat&logo=umbraco)](https://marketplace.umbraco.com/package/jcdcdev.umbraco.extendedmarkdowneditor)
4-
[![GitHub License](https://img.shields.io/github/license/jcdcdev/jcdcdev.Umbraco.ExtendedMarkdownEditor?color=8AB803&label=License&logo=github)](https://github.com/jcdcdev/jcdcdev.Umbraco.ExtendedMarkdownEditor/blob/main/LICENSE)
5-
[![NuGet Downloads](https://img.shields.io/nuget/dt/jcdcdev.Umbraco.ExtendedMarkdownEditor?color=cc9900&label=Downloads&logo=nuget)](https://www.nuget.org/packages/jcdcdev.Umbraco.ExtendedMarkdownEditor/)
3+
[![Umbraco Marketplace](https://img.shields.io/badge/Umbraco-Marketplace-%233544B1?style=flat&logo=umbraco)](https://marketplace.umbraco.com/package/jcdcdev.Umbraco.ExtendedMarkdownEditor)
4+
[![License](https://img.shields.io/github/license/jcdcdev/jcdcdev.Umbraco.ExtendedMarkdownEditor?color=8AB803&label=License&logo=github)](https://github.com/jcdcdev/jcdcdev.Umbraco.ExtendedMarkdownEditor?tab=MIT-1-ov-file)
5+
[![NuGet Downloads](https://img.shields.io/nuget/dt/jcdcdev.Umbraco.ExtendedMarkdownEditor?color=cc9900&label=Downloads&logo=nuget)](https://www.nuget.org/packages/jcdcdev.Umbraco.ExtendedMarkdownEditor)
66
[![Project Website](https://img.shields.io/badge/Project%20Website-jcdc.dev-jcdcdev?style=flat&color=3c4834&logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIxNiIgaGVpZ2h0PSIxNiIgZmlsbD0id2hpdGUiIGNsYXNzPSJiaSBiaS1wYy1kaXNwbGF5IiB2aWV3Qm94PSIwIDAgMTYgMTYiPgogIDxwYXRoIGQ9Ik04IDFhMSAxIDAgMCAxIDEtMWg2YTEgMSAwIDAgMSAxIDF2MTRhMSAxIDAgMCAxLTEgMUg5YTEgMSAwIDAgMS0xLTF6bTEgMTMuNWEuNS41IDAgMSAwIDEgMCAuNS41IDAgMCAwLTEgMG0yIDBhLjUuNSAwIDEgMCAxIDAgLjUuNSAwIDAgMC0xIDBNOS41IDFhLjUuNSAwIDAgMCAwIDFoNWEuNS41IDAgMCAwIDAtMXpNOSAzLjVhLjUuNSAwIDAgMCAuNS41aDVhLjUuNSAwIDAgMCAwLTFoLTVhLjUuNSAwIDAgMC0uNS41TTEuNSAyQTEuNSAxLjUgMCAwIDAgMCAzLjV2N0ExLjUgMS41IDAgMCAwIDEuNSAxMkg2djJoLS41YS41LjUgMCAwIDAgMCAxSDd2LTRIMS41YS41LjUgMCAwIDEtLjUtLjV2LTdhLjUuNSAwIDAgMSAuNS0uNUg3VjJ6Ii8+Cjwvc3ZnPg==)](https://jcdc.dev/umbraco-packages/extended-markdown-editor)
77

8-
A lightweight custom property editor for Umbraco that sits on top of the default Umbraco.MarkdownEditor.
98

10-
## Features
11-
12-
### Property Value Converter
13-
14-
Replaces `IHtmlEncodedString` with `MarkdownValue` which contains the following properties
15-
16-
- **Raw** - The raw markdown as a string
17-
- **Html** - The transformed HTML value
9+
A lightweight custom property editor for Umbraco that sits on top of the default Umbraco.MarkdownEditor.
10+
11+
### Plug and Play
12+
13+
All existing and future properties using Umbraco.MarkdownEditor will automatically use the new editor.
14+
15+
Removing this package will revert to the default Umbraco.MarkdownEditor, **no data loss will occur**.
16+
17+
### Data Type
18+
19+
Extends the configuration to allow control over the transformation of Markdown to HTML
20+
21+
- **Header Offset** - The offset to apply to the header levels
22+
- For example: `-1` would transform `# Header 1` to `<h2>Header 1</h2>`
23+
- **External Links** Open In New Tab - Adds `target="_blank"` to external links
24+
25+
### Property Value Converter
26+
27+
Replaces `IHtmlEncodedString` with `MarkdownValue` which contains the following properties
28+
29+
- **Raw** - The raw markdown as a string
30+
- **Html** - The transformed HTML value
1831
- **Markdown** - The Markdig MarkdownDocument
1932

20-
### Data Type
21-
22-
Extends the configuration to allow control over the transformation of Markdown to HTML
23-
24-
- **Header Offset** - The offset to apply to the header levels
25-
- For example: `-1` would transform `# Header 1` to `<h2>Header 1</h2>`
26-
- **External Links** Open In New Tab - Adds `target="_blank"` to external links
27-
28-
### Plug and Play
29-
30-
All existing and future properties using Umbraco.MarkdownEditor will automatically use the new editor.
31-
32-
Removing this package will revert to the default Umbraco.MarkdownEditor, **no data loss will occur**.
33-
3433
## Quick Start
3534

36-
```csharp
37-
dotnet add package jcdcdev.Umbraco.ExtendedMarkdownEditor
35+
```csharp
36+
dotnet add package jcdcdev.Umbraco.ExtendedMarkdownEditor
3837
```
3938

39+
40+
4041
## Contributing
4142

42-
Contributions to this package are most welcome! Please read
43-
the [Contributing Guidelines](https://github.com/jcdcdev/jcdcdev.Umbraco.ExtendedMarkdownEditor/blob/main/.github/CONTRIBUTING.md).
43+
Contributions to this package are most welcome! Please visit the [Contributing](https://github.com/jcdcdev/jcdcdev.Umbraco.ExtendedMarkdownEditor/contribute) page.
4444

45-
## Acknowledgments (thanks!)
45+
## Acknowledgements (Thanks)
4646

4747
- LottePitcher - [opinionated-package-starter](https://github.com/LottePitcher/opinionated-package-starter)
4848
- jcdcdev - [jcdcdev.Umbraco.PackageTemplate](https://github.com/jcdcdev/jcdcdev.Umbraco.PackageTemplate)
49+
50+
51+

0 commit comments

Comments
 (0)