towxml的使用,在微信小程序中快速将markdown格式渲染为wxml文本

towxml的使用,在微信小程序中快速将markdown格式渲染为wxml文本

  • Towxml概述
  • [安装下载 Towxml](#安装下载 Towxml)
  • [在小程序中使用 towxml](#在小程序中使用 towxml)

Towxml概述

towxml3.0 支持以下功能:

● echarts图表,默认禁用,需自行构建以开启此功能

● LaTeX数学公式,默认禁用,需搭建解析服务并自行构建以开启此功能

● yuml图表,默认禁用,需要搭建解析服务并自行构建以开启此功能

● highlight代码高亮,默认开启(默认仅开启bash、javascript、json、python、html、css、php、scss、shell),其它语言高亮支持需自行构建以开启

安装下载 Towxml

  1. 先使用命令克隆到本地中(使用git进行安装)
shell 复制代码
git clone https://github.com/sbfkcel/towxml.git
  1. 对克隆的下的文件进行依赖安装和npm重构
shell 复制代码
npm install  # 安装依赖
npm run build # npm 重构

构建完成后,会在当前的目录中生成一个dist目录(按照提示找到对应的文件夹),然后将其拷贝到微信小程序项目中(根下),重命名为towxml即可。

在小程序中使用 towxml

  1. 引入towxml库到 App.js中
javascript 复制代码
// app.js
App({
  towxml: require('./towxml/index'),
  onLaunch() {
  },
})
  1. 在具体页面的配置文件中引入towxml组件

注意:这里的组件路径根据自己的页面去找相对路径。

json 复制代码
{
    "usingComponents": {
        "towxml": "../../towxml/towxml"
    }
}
  1. 在wxml页面中使用towxml组件
html 复制代码
<view class="content-info">
  <towxml nodes="{{article}}"/>
</view>
  1. 在具体页面的js中对需要进行markdown转换wxml的业务进行处理解析

下面是官方给出的例子:

javascript 复制代码
//获取应用实例
const app = getApp();
Page({
  data: {
    isLoading: true,					// 判断是否尚在加载中
    article: {}						// 内容数据
  },
  onLoad: function () {
    let result = app.towxml(`# Markdown`,'markdown',{
      base:'https://xxx.com',				// 相对资源的base路径
      theme:'dark',					// 主题,默认`light`
      events:{					// 为元素绑定的事件方法
        tap:(e)=>{
          console.log('tap',e);
        }
      }
    });

    // 更新解析数据
    this.setData({
      article:result,
      isLoading: false
    });

  }
})

其实就是调用app.towxml(str,type,options)函数

javascript 复制代码
const app = getApp(); // 应用实例
Page({
  // ....
   onLoad:function(){
     // 这是一个伪代码
     let 解析的结果 = app.towxml('想要被解析的数据','markdown',[options])
   } 
})

其中的options选项都是可选的,可以一个都不加,选项说明如下:
app.towxml(str,type,options)有三个参数

str 必选,html或markdown字符串

type 必选 ,需要解析的内容类型html或markdown

options [object] 可选,可以该选项设置主题、绑定事件、设置base等

base [string] 可选,用于指定静态相对资源的base路径。例如:https://xx.com/static/

theme [string] 可选,默认:light,用于指定主题'light'或'dark',或其它自定义

events [object] 可选,用于为元素绑定事件。key为事件名称,value则必须为一个函数。例如:{tap:e=>{console.log(e)}}

  1. 页面显示效果
相关推荐
阿拉斯加的头头儿35 分钟前
小程序下载图片问题处理
小程序
一 乐5 小时前
校园墙|校园社区|基于Java+vue的校园墙小程序系统(源码+数据库+文档)
java·前端·数据库·vue.js·spring boot·后端·小程序
vx_bscxy3225 小时前
告别毕设焦虑!Python 爬虫 + Java 系统 + 数据大屏,含详细开发文档 基于微信小程序的民宿预约系统22398 (上万套实战教程,赠送源码)
java·spring boot·mysql·微信小程序·课程设计
LXA08096 小时前
在 UniApp 中为小程序实现视频播放记录功能
小程序·uni-app·音视频
千寻技术帮10 小时前
50015_基于微信小程序的红色旅游系统
微信小程序·小程序·源码·ppt·项目文档
sg_knight10 小时前
微信小程序中 WebView 组件的使用与应用场景
前端·javascript·微信·微信小程序·小程序·web·weapp
2501_9160074714 小时前
iOS性能调试工具终极指南,从系统底层到多端协同的全方位优化实践(2025版)
android·ios·小程序·https·uni-app·iphone·webview
2501_9159214314 小时前
iOS崩溃日志深度分析与工具组合实战,从符号化到自动化诊断的完整体系
android·ios·小程序·uni-app·自动化·cocoa·iphone
我很苦涩的21 小时前
使用微信小程序实现多格验证码效果
微信小程序·小程序
阿里花盘21 小时前
花店微信小程序怎么做,创建一个小程序需要多少钱
微信小程序·小程序