Blazor.Cherrydown
0.1.17
dotnet add package Blazor.Cherrydown --version 0.1.17
NuGet\Install-Package Blazor.Cherrydown -Version 0.1.17
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Blazor.Cherrydown" Version="0.1.17" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Blazor.Cherrydown" Version="0.1.17" />
<PackageReference Include="Blazor.Cherrydown" />
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add Blazor.Cherrydown --version 0.1.17
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: Blazor.Cherrydown, 0.1.17"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package Blazor.Cherrydown@0.1.17
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=Blazor.Cherrydown&version=0.1.17
#tool nuget:?package=Blazor.Cherrydown&version=0.1.17
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
Blazor.Cherrydown
A blazor markdown editor wraps of cherry-markdown from Tencent.
Features
- Edit and preview mode.
- Pre-defined toolbar.
- Streaming file uploading(inspired by the built-in
InputFilecomponent). - Add auto numbers for TOC.
- Other functionalities that
cherry-markdownprovided.
Getting started
Install the package, or download the project and reference it.
dotnet add package Blazor.Cherrydown
Add the following using statement in _Imports.razor.
@using Blazor.Cherrydown
do not need to add the reference to the
javascriptandCSS,Blazor.Cherrydownwill do it for you. for more into, you can refer to blazor initializer
Add Cherrydown in a page
<button @onclick="ChangeMarkdown">Change Markdown</button>
<Cherrydown @bind-Markdown="_markdown" OnFileUpload="@SaveFile" />
@code {
private string? _markdown = "# CherrydownEditor";
protected override void OnParametersSet()
{
using var reader = new System.IO.StreamReader(@"basic.md");
_markdown = reader.ReadToEnd();
base.OnParametersSet();
}
void ChangeMarkdown()
{
_markdown = "# Changed Markdown";
}
private async Task<FileUploadResult> SaveFile(FileUpload.IBrowserFile file)
{
var workDir = _config.GetValue<string>("WorkDir");
var workDirVirtualPath = _config.GetValue<string>("WorkDirVirtualPath");
await using FileStream fs = new(Path.Combine(workDir, file.Name), FileMode.Create);
await file.OpenReadStream(15 * 1024 * 1024).CopyToAsync(fs);
return new FileUploadResult { FileUri = $"{workDirVirtualPath}/{file.Name}" };
}
}
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 was computed. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 was computed. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
net8.0
- Microsoft.AspNetCore.Components.Web (>= 8.0.2)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.