# 百度版wemark

**Repository Path**: sootou/wemark

## Basic Information

- **Project Name**: 百度版wemark
- **Description**: 百度小程序Markdown渲染组件，转成小程序可识别的富文本
- **Primary Language**: JavaScript
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2019-03-20
- **Last Updated**: 2022-05-24

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

#### 百度版wemark：百度小程序Markdown渲染组件
![输入图片说明](https://images.gitee.com/uploads/images/2019/0320/135735_aa2d6076_1544331.jpeg "011.jpg")

#### 来源
修改自TooBug的wemark,由于不支持百度小程序使用，所以改造了一下，原wemark作者github地址：https://github.com/TooBug/wemark，对于wemark的详细使用请参考原作者的说明。

#### 介绍
用于在小程序中渲染Markdown文本。
在小程序诞生之前，Markdown的渲染一般需要解析成HTML，然后渲染解析后的HTML。然而小程序并没有提供HTML渲染的功能，因此在wemark诞生之前，几乎所有的Markdown渲染库全部无法在小程序下正常工作。

wemark可以实现在小程序下渲染Markdown内容，支持图片、表格在内的大部分Markdown特性。

#### 特性

- 以小程序自定义组件形式提供，可直接引入使用
- 支持大部分markdown标记的解析、渲染（详细支持情况见下方附录）
- 支持代码表格、代码高亮、HTML视频等特性
- 支持使用原生rich-text进行渲染
- 兼容mpvue等开发框架

#### 使用教程

1、下载并拷贝wemark目录到百度小程序根目录
2、在页面的配置文件中引用wemark组件

```
{
	"usingComponents": {
		"wemark": "/wemark/wemark"
	}
}
```
（请使用绝对路径）

3、swan中使用：<wemark md="{{md}}" link highlight type="wemark"></wemark>


 参数说明：
 
- md，必填，需要渲染的Markdown字符串；
- link，是否解析链接，如果解析，会使用小程序navigator组件展现，可在小程序内跳转，默认为false；
- highlight，是否对代码进行高亮处理，默认为false；
- type，渲染方式，wemark会使用wemark的数据结构和模板进行渲染，rich-text会使用小程序内置的rich-text组件进行渲染（不支持链接跳转、视频）。

> 注：代码高亮会使标签数量和解析后的数据量增大，不排除产生渲染性能问题，请根据实际需要酌情使用。

#### 不足之处
对原作者的css做了部分调整，在wemark.css下新增代码：

```
.wemark_block_code text{
	display: inline;
	white-space: normal;
}
```
增加white-space: normal;是为了防止对父css的white-space: pre的继承，父css造成换行问题，很不美观，但是改成white-space: normal之后，会造成代码片段的空格消失，希望大家想办法支持改造一下！

#### 修改部分

- 1、修改wemark目录下的wxml为swan，修改wxss为css
- 2、修改wemark.js中的wx:for,wx:if wx:index等兼容百度小程序
- 3、新增部分css，并注释掉css中所有：last的css，

### 参与贡献

- 开发者：腾石建站
- 官网:http://www.tengcee.com
- 原作者github：https://github.com/TooBug/wemark