语法

Go语言解析markdown

1. 概述

Markdown 是一种轻量级的标记语言。设计的目的是通过简单、轻量级的方式来添加格式，而不需要使用 HTML。

相关文档如下：

• Markdown语法文档http://www.hellokang.net/
• Markdown语法文档（官方）https://daringfireball.net/projects/markdown/syntax/
• Markdown语法文档（翻译）http://alfred-sun.github.io/markdown-syntax-zhtw/

2. 安装 Blackfriday

Go 语言中解析 MarkDown 最知名的库就是 russross/blackfriday 了。github 地址为：https://github.com/russross/blackfriday.

下面的命令可以将 russross/blackfriday 安装到 GOPATH 所设置的目录：

go get -u gopkg.in/russross/blackfriday.v2

3. 解析 MarkDown 内容

使用函数 func Run(input []byte, opts ...Option) []byte 完成 MarkDown 的解析，演示如下：

import (
    "gopkg.in/russross/blackfriday.v2"
)

// 通用的解析方式
output := blackfriday.Run(input)

// 若仅需要最基本的功能，使用 blackfriday.WithNoExtensions() 选项
output := blackfriday.Run(input, blackfriday.WithNoExtensions())

4. 安全过滤

blackfriday 库仅实现了 MarkDown 的解析，没有做关于安全注入方面的过滤。若不能保证待解析的内容安全性，例如来自于用户提供的内容，则需要进行内容过滤来保证安全。推荐使用 microcosm-cc/bluemonday 完成。项目 github 地址：https://github.com/microcosm-cc/bluemonday

安装

下面的命令可以将 microcosm-cc/bluemonday 安装到 GOPATH 所设置的目录：

go get -u github.com/microcosm-cc/bluemonday

使用

使用过程如下：

import (
    "github.com/microcosm-cc/bluemonday"
    "gopkg.in/russross/blackfriday.v2"
)

// 利用 bluemonday 解析
html := bluemonday.UGCPolicy().SanitizeBytes(unsafe)

本文由 创作，采用 知识共享署名4.0 国际许可协议进行许可。本站文章除注明转载/出处外，均为本站原创或翻译，转载前请务必署名。最后编辑时间为: 2020/06/28 09:42