GithubHelp home page GithubHelp logo

agjackie / markdown-nice Goto Github PK

View Code? Open in Web Editor NEW

This project forked from mdnice/markdown-nice

0.0 1.0 0.0 3.16 MB

支持自定义样式的微信 Markdown 排版工具

Home Page: https://mdnice.com/

License: GNU General Public License v3.0

HTML 0.43% CSS 4.12% JavaScript 95.46%

markdown-nice's Introduction

Markdown Nice

简介

  • 支持自定义样式的 Markdown 编辑器
  • 支持微信公众号、知乎、开源**、稀土掘金、博客园和 CSDN 等一系列平台
  • 更多用户和开发者文档请参考 Markdown Nice Docs
  • 欢迎在线使用

示例

欢迎提供更多文章示例~~

组件使用

React

1、安装 markdown-nice

$ yarn add markdown-nice

或者

$ npm install markdown-nice --save

若 npm install 过慢,建议使用yarn作为包管理工具。

其中的 mathjax 包下载速度可能比较慢,如果不需要公式支持,可以在 package.json 中删除 mathjax 部分

$ yarn remove mathjax

2、愉快使用

import React from "react";
import MarkdownNice from "markdown-nice";

// 编辑器默认的内容
const defaultText = `编辑器默认的内容`;
// 标题,是一个字符串
const defaultTitle = "Markdown Nice";

function App() {
  return (
    <MarkdownNice
      defaultTitle={defaultTitle}
      defaultText={defaultText}
      onTextChange={(t) => console.log("text => ", t)}
    />
  );
}

export default App;

更多开发者文档请参考 Markdown Nice Docs

Vue(临时)

当前组件没有正式支持 Vue,可以使用 vuera 在 Vue 中引入组件,参考示例

关于

mdnice 社区组建了微信用户群,欢迎反馈意见和公众号大佬们一起交流,关注公众号回复「排版」拉你入群。

同时也欢迎打赏哟,您的支持是我们最大的动力!

入群码 打赏码

markdown-nice's People

Contributors

guanpengchn avatar 375ro avatar lxfriday avatar linfeng1997 avatar zhning12 avatar views63 avatar baskinwind avatar zq-jhon avatar

Watchers

James Cloos 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.