|
1 | 1 | # jcdcdev.Umbraco.ExtendedMarkdownEditor |
2 | 2 |
|
3 | | -[](https://marketplace.umbraco.com/package/jcdcdev.umbraco.extendedmarkdowneditor) |
4 | | -[](https://github.com/jcdcdev/jcdcdev.Umbraco.ExtendedMarkdownEditor/blob/main/LICENSE) |
5 | | -[](https://www.nuget.org/packages/jcdcdev.Umbraco.ExtendedMarkdownEditor/) |
6 | | - |
7 | | -A lightweight custom property editor for Umbraco that sits on top of the default Umbraco.MarkdownEditor. |
8 | | - |
9 | | -## Features |
10 | | - |
11 | | -### Property Value Converter |
12 | | - |
13 | | -Replaces `IHtmlEncodedString` with `MarkdownValue` which contains the following properties |
14 | | - |
15 | | -- **Raw** - The raw markdown as a string |
16 | | -- **Html** - The transformed HTML value |
| 3 | +[](https://marketplace.umbraco.com/package/jcdcdev.Umbraco.ExtendedMarkdownEditor) |
| 4 | +[](https://github.com/jcdcdev/jcdcdev.Umbraco.ExtendedMarkdownEditor?tab=MIT-1-ov-file) |
| 5 | +[](https://www.nuget.org/packages/jcdcdev.Umbraco.ExtendedMarkdownEditor) |
| 6 | +[](https://jcdc.dev/umbraco-packages/extended-markdown-editor) |
| 7 | + |
| 8 | + |
| 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 |
17 | 31 | - **Markdown** - The Markdig MarkdownDocument |
18 | 32 |
|
19 | | -### Data Type |
20 | | - |
21 | | -Extends the configuration to allow control over the transformation of Markdown to HTML |
22 | | - |
23 | | -- **Header Offset** - The offset to apply to the header levels |
24 | | - - For example: `-1` would transform `# Header 1` to `<h2>Header 1</h2>` |
25 | | -- **External Links** Open In New Tab - Adds `target="_blank"` to external links |
| 33 | +> [!IMPORTANT] |
| 34 | +> Version 10 will only receive security updates and no new features. |
26 | 35 |
|
27 | | -### Plug and Play |
28 | | - |
29 | | -All existing and future properties using Umbraco.MarkdownEditor will automatically use the new editor. |
30 | | - |
31 | | -Removing this package will revert to the default Umbraco.MarkdownEditor, **no data loss will occur**. |
| 36 | +> Please review the [security policy](https://github.com/jcdcdev/jcdcdev.Umbraco.ExtendedMarkdownEditor?tab=security-ov-file#supported-versions) for more information. |
32 | 37 |
|
33 | 38 | ## Quick Start |
34 | 39 |
|
35 | | -```csharp |
36 | | -dotnet add package jcdcdev.Umbraco.ExtendedMarkdownEditor |
| 40 | +```csharp |
| 41 | +dotnet add package jcdcdev.Umbraco.ExtendedMarkdownEditor |
37 | 42 | ``` |
38 | 43 |
|
| 44 | + |
| 45 | + |
39 | 46 | ## Contributing |
40 | 47 |
|
41 | | -Contributions to this package are most welcome! Please read |
42 | | -the [Contributing Guidelines](https://github.com/jcdcdev/jcdcdev.Umbraco.ExtendedMarkdownEditor/blob/main/.github/CONTRIBUTING.md). |
| 48 | +Contributions to this package are most welcome! Please visit the [Contributing](https://github.com/jcdcdev/jcdcdev.Umbraco.ExtendedMarkdownEditor/contribute) page. |
43 | 49 |
|
44 | | -## Acknowledgments (thanks!) |
| 50 | +## Acknowledgements (Thanks) |
45 | 51 |
|
46 | 52 | - LottePitcher - [opinionated-package-starter](https://github.com/LottePitcher/opinionated-package-starter) |
47 | | -- jcdcdev - [jcdcdev.Umbraco.PackageTemplate](https://github.com/jcdcdev/jcdcdev.Umbraco.PackageTemplate) |
| 53 | +- jcdcdev - [jcdcdev.Umbraco.PackageTemplate](https://github.com/jcdcdev/jcdcdev.Umbraco.PackageTemplate) |
| 54 | + |
| 55 | + |
| 56 | + |
0 commit comments