Skip to content

Commit 28145ae

Browse files
committed
doc: Update NuGet README
1 parent 03fc014 commit 28145ae

File tree

1 file changed

+42
-9
lines changed

1 file changed

+42
-9
lines changed

docs/README_nuget.md

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

3-
[![Documentation](https://img.shields.io/badge/Docs-Quickstart-394933?style=flat&logo=github)](https://github.com/jcdcdev/jcdcdev.Umbraco.ExtendedMarkdownEditor/tree/main?tab=readme-ov-file#quick-start)
4-
[![Umbraco Marketplace](https://img.shields.io/badge/Umbraco-Marketplace-%233544B1?style=flat&logo=umbraco)](https://marketplace.umbraco.com/package/jcdcdev.umbraco.extendedmarkdowneditor)
5-
[![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)
6-
[![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+
[![Documentation](https://img.shields.io/badge/Docs-Quickstart-394933?style=flat&logo=github)](https://github.com/jcdcdev/jcdcdev.Umbraco.ExtendedMarkdownEditor?tab=readme-ov-file#quick-start)
4+
[![Umbraco Marketplace](https://img.shields.io/badge/Umbraco-Marketplace-%233544B1?style=flat&logo=umbraco)](https://marketplace.umbraco.com/package/jcdcdev.Umbraco.ExtendedMarkdownEditor)
5+
[![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)
6+
[![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)
7+
[![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)
8+
9+
10+
A lightweight custom property editor for Umbraco that sits on top of the default Umbraco.MarkdownEditor.
11+
12+
### Plug and Play
13+
14+
All existing and future properties using Umbraco.MarkdownEditor will automatically use the new editor.
15+
16+
Removing this package will revert to the default Umbraco.MarkdownEditor, **no data loss will occur**.
17+
18+
### Data Type
19+
20+
Extends the configuration to allow control over the transformation of Markdown to HTML
21+
22+
- **Header Offset** - The offset to apply to the header levels
23+
- For example: `-1` would transform `# Header 1` to `<h2>Header 1</h2>`
24+
- **External Links** Open In New Tab - Adds `target="_blank"` to external links
25+
26+
### Property Value Converter
27+
28+
Replaces `IHtmlEncodedString` with `MarkdownValue` which contains the following properties
29+
30+
- **Raw** - The raw markdown as a string
31+
- **Html** - The transformed HTML value
32+
- **Markdown** - The Markdig MarkdownDocument
33+
34+
## Quick Start
35+
36+
```csharp
37+
dotnet add package jcdcdev.Umbraco.ExtendedMarkdownEditor
38+
```
739

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

1041
## Contributing
1142

12-
Contributions to this package are most welcome! Please read
13-
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.
1444

15-
## Acknowledgments (thanks!)
45+
## Acknowledgements (Thanks)
1646

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

0 commit comments

Comments
 (0)