https://github.com/vokseverk/vokseverk.markdowntextstring
A property editor for Umbraco that handles simple Markdown syntax within a single paragraph
https://github.com/vokseverk/vokseverk.markdowntextstring
markdown property-editor umbraco
Last synced: 20 days ago
JSON representation
A property editor for Umbraco that handles simple Markdown syntax within a single paragraph
- Host: GitHub
- URL: https://github.com/vokseverk/vokseverk.markdowntextstring
- Owner: vokseverk
- License: mit
- Created: 2021-03-09T17:04:36.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2023-02-03T15:44:25.000Z (about 2 years ago)
- Last Synced: 2025-03-19T13:18:02.544Z (about 1 month ago)
- Topics: markdown, property-editor, umbraco
- Language: C#
- Homepage: https://our.umbraco.com/packages/backoffice-extensions/markdown-textstring/
- Size: 101 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Markdown TextString for Umbraco
A property editor for those times where one just needs to be able to
emphasize a word or two in a property that's created as a textstring.
The accompanying PropertyValueConverter allows for rendering either the raw
text value or the parsed HTML. Both are readily available.
**NOTE:**
Since the real value is in the PropertyValueConverter, it's installed with the
property editor - as a `*.cs` file in the `~/App_Code/` folder. This also means
there's two different versions of this package - one for Umbraco 7 and another
for Umbraco 8 - make sure you install the right one for your site.
## Screenshot
## Rendering
The raw value stored in the property editor is a `string` of the Markdown text.
To convert it to HTML you call `.ToHTML()`:
```razor
@Model.PageTitle.ToHTML()
```
(That method's been aliased as `.ToHtml()` in case you prefer that... :-)
## Developing & Building
On macOS you can run the `build.sh` script from the terminal, which will
build two ZIP files in the `dist` folder that is installable from
Umbraco 8's _Packages_ section or Umbraco 7's _Developer > Packages_ section.
The build script versions the files so it's easier to test the package inside
an Umbraco installation by uninstalling the existing version and then
installing a new build. Existing data-types keep their data as long as their
alias and/or storage type isn't changed.
To update the version number, increment the `packageVersion` entity in the
`src/package.ent` file.