react实现markdown

一、概要

最近想实现个人博客,博客文章想采用markdown来进行编辑。参考了网上一些markdown的实现,要么都是比较老的方法,要么是vue的方法,而相对于vue来说,我更熟悉react一下,所以这些方法都不太让我满意。于是自己摸索了一种方法来实现react中的markdown效果。

二、所需第三方库

1. react-markdown

1) 作用

用来转换markdown语法

2) 下载

$ npm install react-markdown --save

2. highlight.js

1) 作用

博客中不仅包含普通文本,还有代码,光使用react-markdown无法实现代码高亮,所以这里就需要用到highlight.js

2) 下载

$ npm install highlight.js --save

3. prop-types

1) 作用

稍后定义代码块组件时会用到

2) 下载

$ npm install prop-types --save

三、代码编写

1. 定义CodeBlock组件,以供稍后调用

1) 首先引入库

import React,{PureComponent} from 'react'; //引入react
import PropTypes from 'prop-types';  //引入prop-types
import hljs from 'highlight.js'  
import 'highlight.js/styles/androidstudio.css'  //代码块样式

这里引入了androidstudio样式,也可以引入别的样式:

import 'highlight.js/styles/xxx.css';

这里的xxx具体有哪些,可以去highlightjs的官网查看https://highlightjs.org/

样式预览.png

点击图片中箭头指向的位置切换样式进行预览,然后用“style:”后面的名字替换上面代码块中的xxx

2)代码主体

代码主体参考https://github.com/rexxars/react-markdown/blob/master/demo/src/code-block.js

class CodeBlock extends PureComponent{
    constructor(props){
        super(props);
        this.setRef = this.setRef.bind(this)
    }
    setRef(el){
        this.codeEl = el
    }
    componentDidMount() {
        this.highlightCode()
    }
    componentDidUpdate(prevProps, prevState, snapshot) {
        this.highlightCode()
    }
    highlightCode(){
        hljs.highlightBlock(this.codeEl)
    }
    render() {
        return(
            <pre>
                <code ref={this.setRef} className={`language-${this.props.language}`}>
                    {this.props.value}
                </code>
            </pre>
        )
    }
}
CodeBlock.defaultProps = {
    language:''
};
CodeBlock.protoTypes = {
    value:PropTypes.string.isRequired,
    language: PropTypes.string
};
export default CodeBlock;

2. 编写简单的组件Editor进行展示

1) 先引入库

import React,{Component} from 'react';
import MarkDown from 'react-markdown/with-html'; 

上面需要注意引入的是react-markdown/with-html而不是react-markdown。

import CodeBlock from '../../../components/codeBlock' //代码块组件

这里引入我们刚刚写好的代码块组件,这里的引入路径根据自己的代码来写

2) 代码主体

代码主体参考https://github.com/rexxars/react-markdown/blob/master/demo/src/demo.js
对原代码进行了简化以便于理解

class Editor extends Component{
    constructor(props){
        super(props);
        this.state={
            content:""
        }
    }
    onChange = (e) => {
        this.setState({
            content:e.currentTarget.value
        })
    };
    render() {
        return(
            <div className="result-pane">
                <textarea onChange={this.onChange}/>
                <MarkDown className="result" source={this.state.content} renderers={{code:CodeBlock}}/>
            </div>
        )
    }
}
export default Editor;

可以在代码主体中看到,在<MarkDown/>组件里有个renders属性,就是这里指向了我们之前写的代码块组件。

3) 组件调用

编写完上述代码,就可以import Editor组件来展示效果了,这里就不多说了,如果需要可以留言

四、效果展示

想看看效果的话,可以进入我的个人网站https://www.nbucedog.com/blog

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 213,014评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,796评论 3 386
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 158,484评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,830评论 1 285
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,946评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,114评论 1 292
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,182评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,927评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,369评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,678评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,832评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,533评论 4 335
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,166评论 3 317
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,885评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,128评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,659评论 2 362
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,738评论 2 351