Vue實現一個MarkDown編輯器
Vue實現一個markdown編輯器
前段時間做專案的時候，需要一個Markdown編輯器，在網上找了一些開源的實現，但是都不滿足需求
說實話，這些開源專案也很難滿足需求公司專案的需求，與其實現一個大而全的專案，倒不如實現一個
簡單的，易於在原始碼上修改的專案，核心功能都有的，以供修改使用
本文的原始碼地址如下
https://github.com/jiulu313/HelloMarkDown
喜歡的朋友可以幫忙star一下，歡迎交流學習
先看一下本專案的效果圖（圖片經過壓縮）
本文的目的就是實現一個有核心功能的，簡單，易於修改的專案
話不多說，來看思路
1 markdown內容如何轉換成 html？
網上有一個開源的庫叫 marked，地址如下：
https://github.com/markedjs/marked.git
我們可以安裝這個庫，使用很簡單，就一個函式，傳進去markdown內容，就返回了html內容
2 markdown內容轉換成了html，如何進行語法高亮？
網上也有一個開源的庫，地址如下 ：
https://highlightjs.org/
我們可以使用這兩個庫
- 先把markdown內容解析成html內容
- 把html內容進行語法高亮
下面我們來一步一步實現程式碼
3 程式碼實現
預設你已經建立好了vue的專案 ， 建立vue專案 vue init webpack demo
這裡面不多講。
3.1 安裝兩個庫，分別執行下面兩條命令
npm install marked --save
npm install highlight.js --save
3.2 首先建立一個 HelloMarkDown 的 Vue元件
佈局檔案的程式碼如下：
<template> <div class="md_root_content" v-bind:style="{width:this.width,height: this.height}"> <!--功能按鈕區--> <div class="button_bar"> <span v-on:click="addBold"><B>B</B></span> <span v-on:click="addUnderline"><B>U</B></span> <span v-on:click="addItalic"><B>I</B></span> </div> <!--主要內容區--> <div class="content_bar"> <!--markdown編輯器區--> <div class="markdown_body"> <textarea ref="ref_md_edit" class="md_textarea_content" v-model="markString"> </textarea> </div> <!--解析成html區--> <div class="html_body"> <p v-html="htmlString"></p> </div> </div> </div> </template>
主要分為上下兩塊，上面是功能區的佈局
下面一塊，分左右兩部分，左邊是markdown，右邊是顯示html部分
對應的樣式程式碼如下：
<style scoped>
.md_root_content {
display: flex;
display: -webkit-flex;
flex-direction: column;
}
.button_bar {
width: 100%;
height: 40px;
background-color: #d4d4d4;
display: flex;
display: -webkit-flex;
align-items: center;
}
div.button_bar span {
width: 30px;
line-height: 40px;
text-align: center;
color: orange;
cursor: pointer;
}
.content_bar {
display: flex;
display: -webkit-flex;
width: 100%;
height: 100%;
}
.markdown_body {
width: 50%;
height: 100%;
display: flex;
display: -webkit-flex;
}
.html_body {
width: 50%;
height: 100%;
display: flex;
display: -webkit-flex;
background-color: #dfe9f1;
}
.md_textarea_content {
flex: 1;
height: 100%;
padding: 12px;
overflow: auto;
box-sizing: border-box;
resize: none;
outline: none;
border: none;
background-color: #f4f4f4;
font-size: 14px;
color: #232323;
line-height: 24px;
}
</style>
業務邏輯部分的程式碼如下：
<script>
import marked from 'marked' //解析mardown語法的庫
import hljs from 'highlight.js' //對程式碼進行語法高亮的庫
import testData from '../testData' //測試資料
export default {
name: "HelloMarkDown",
props: {
width: {
type: String,
default: '1000px'
},
height: {
type: String,
default: '600px'
}
},
data() {
return {
markString: '',
htmlString: '',
}
},
mounted(){
this.markString = testData
},
methods: {
//加粗
addBold() {
this.changeSelectedText("**","**")
},
//斜體
addItalic() {
this.changeSelectedText("***","***")
},
addUnderline() {
this.changeSelectedText("<u>","</u>")
},
changeSelectedText(startString,endString){
let t = this.$refs.ref_md_edit
if (window.getSelection) {
if (t.selectionStart != undefined && t.selectionEnd != undefined) {
let str1 = t.value.substring(0, t.selectionStart)
let str2 = t.value.substring(t.selectionStart, t.selectionEnd)
let str3 = t.value.substring(t.selectionEnd)
let result = str1 + startString + str2 + endString + str3
t.value = result
this.markString = t.value
}
}
}
},
watch: {
//監聽markString變化
markString: function (value) {
marked.setOptions({
renderer: new marked.Renderer(),
gfm: true,
tables: true,
breaks: true,
pedantic: false,
sanitize: false,
smartLists: true,
smartypants: false
})
this.htmlString = marked(value)
},
//監聽htmlString並對其高亮
htmlString: function (value) {
this.$nextTick(() => {
const codes = document.querySelectorAll(".html_body pre code");
// elem 是一個 object
codes.forEach(elem => {
elem.innerHTML = "<ul><li>" + elem.innerHTML.replace(/\n/g, "\n</li><li>") + "\n</li></ul>"
hljs.highlightBlock(elem);
});
});
}
}
}
</script>script中的程式碼解釋
props: {
width: {
type: String,
default: '1000px'
},
height: {
type: String,
default: '600px'
}
},width: 元件的寬度
height:元件的高度
data() {
return {
markString: '',
htmlString: '',
}
},markString：儲存我們輸入的markdown內容
htmlString：儲存markdown內容轉換成的html內容，也就是通過marked函式轉換過來的
mounted(){
this.markString = testData
},顯示預設資料
//加粗
addBold() {
this.changeSelectedText("**","**")
},
//斜體
addItalic() {
this.changeSelectedText("***","***")
},
//加下劃線
addUnderline() {
this.changeSelectedText("<u>","</u>")
},這三個函式都是呼叫了 changeSelectedText 函式
主要是對滑鼠選中的內容進行改變，比如加粗效果，是在選中文字的兩邊分別新增 **
所以changeSelectedText函式的作用就是在選中的文字兩邊新增不同的md的符號
比如
this.changeSelectedText("","") ，就是在選中的文字左邊和右邊都新增**
然後再把最新的內容賦值給 this.$refs.ref_md_edit.value，同時也兩會給markString
這樣就可以做到選中文字加粗效果了
//監聽markString變化
markString: function (value) {
marked.setOptions({
renderer: new marked.Renderer(),
gfm: true,
tables: true,
breaks: true,
pedantic: false,
sanitize: false,
smartLists: true,
smartypants: false
})
this.htmlString = marked(value)
},此時是監聽markString的變化
然後呼叫marked函式進行轉換成html內容，並賦值給htmlString
marked.setOptions 是設定一些配置，有興趣的可以查一下這些配置的作用
//監聽htmlString並對其高亮
htmlString: function (value) {
this.$nextTick(() => {
const codes = document.querySelectorAll(".html_body pre code");
// elem 是一個 object
codes.forEach(elem => {
elem.innerHTML = "<ul><li>" + elem.innerHTML.replace(/\n/g, "\n</li><li>") + "\n</li></ul>"
hljs.highlightBlock(elem);
});
});
}原本通過 highlight.js這個庫在顯示語法高亮的時候，是沒有行號的。這裡我進行了擴充套件
通過 document.querySelectorAll(".html_body pre code") 找到nodeList
然後對其迴圈，動態新增 ul , li, 這樣就可以顯示行號了
不過這需要對 highlight的css檔案新增幾個樣式
原始碼裡面我把highlight中的css檔案全部copy到專案中了，使用的是github.css
具體位置是在專案中的 assets/markdown/styles/github.css
如果想使用其它的主題，可以自己修改其它的對應的css檔案，這裡使用了github的主題，所以只修改了github.css這一個檔案
有興趣的可以檢視一下
github.css檔案的提交記錄
具體的思路就是這些，水平有限，難免有bug，如有發現，歡迎提