Code Monkey home page Code Monkey logo

blazor.cherrydown's Introduction

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 InputFile component).
  • Add auto numbers for TOC.
  • Other functionalities that cherry-markdown provided.

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 javascript and CSS, Blazor.Cherrydown will 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}" };
    }
}

blazor.cherrydown's People

Contributors

balder1840 avatar zhouzhenhua-uster avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.