# biu-markdown

**Repository Path**: hcsp/biu-markdown

## Basic Information

- **Project Name**: biu-markdown
- **Description**: biu-markdown 是一款构建于鸿蒙之上基于ArkTS+ArkUI实现的原生 Markdown 解析库，支持自定义主题，可方便快捷实现在鸿蒙设备上进行markdown的解析。
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 5
- **Forks**: 0
- **Created**: 2023-12-25
- **Last Updated**: 2025-03-23

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# biu-markdown原生 Markdown 解析器(鸿蒙+ArkTS+ArkUI)

## 1.概述

biu-markdown是一个可以用于鸿蒙设备上进行解析markdown的解析器，该解析器支持markdown原生语法包括，并且支持自定义主题，内置黑白两款主题，解析渲染效果如下

![深色模式](./doc/image/dark.png)

![浅色模式](./doc/image/light.png)

## 2.biu-markdown 安装

a.按照biu-markdown包

``` shell
ohpm install @hcs/biu-markdown
```

b.在项目中引入组件

``` javascript
import { BiuMarkdown } from '@hcs/biu-markdown'
```

c.在代码中使用

``` javascript
BiuMarkdown({ content: '文本内容'})
```

## 3.主题定制与使用

### 3.1.内置主题

``` javascript
// 导入 主题
import { darkTheme } from '@hcs/biu-markdown'
// 使用黑色主题
BiuMarkdown({ content: this.message, style: darkTheme })
```

### 3.2.主题定制

```javascript
import { BaseStyle } from './BaseStyle'
import { BiuMarkdownStyle, mergeStyleToDefault } from '@hcs/biu-markdown'

const baseStyle: BaseStyle = {
  backgroundColor: '#000',
  fontSize: 16,
  fontColor: '#fff',
  specialFontColor: '#FF79C6',
  space: 10
}

export const myTheme: BiuMarkdownStyle = mergeStyleToDefault(<BiuMarkdownStyle> {
  base: {
    backgroundColor: baseStyle.backgroundColor,
    fontColor: baseStyle.fontColor,
  },
  //各种组件样式
  ...
})
```