小程序如何进行 Twoxml 配置以完美支持 Markdown

why 1098 2024-06-25

本篇文章给大家分享绍一下让小程序完美支持markdown的详细教程，希望对大家有所帮助！

小程序怎么配置Twoxml，让其完美支持Markdown！

最近在做需要展示文章详情的功能，详情打算用Markdown展示，发现微信小程序在支持Markdown方面不是很友好，小蛋我无意中发现一个好用的组件，Twoxml，完美支持Markdown，下面就带大家手把手实现Markdown功能。【相关学习推荐：小程序开发教程】

Towxml 介绍

｜Towxml 官网： https://github.com/sbfkcel/towxml

Towxml是一个可将HTML、Markdown转为微信小程序WXML的渲染库，支持以下功能：

使用Towxml可以实现如下的Markdown效果

在小程序中引入Twoxml

构建Twoxml

克隆项目到本地

1	`git clone https://github.com/sbfkcel/towxml.git`

如果没有安装过npm依赖，先安装依赖
1
npm install 或 yarn
编辑配置文件towxml/config.js
根据自己的实际需求保留你需要的功能即可
运行 npm run build 或 yarn run build 即可
构建好后出来的文件在dist目录下，将dist目录复制到小程序项目根目录中并将目录名称改为towxml即可使用

在小程序中使用Twoxml

上一步我们已经把towxml文件夹引入到小程序中：

1. 引入库 /app.js

// app.js
App({
  // 引入`towxml3.0`解析方法
  towxml:require(&#39;/towxml/index&#39;),
})

2. 在具体页面的配置文件中引入twoxml组件

// pages/content-detail/content-detail.json
{
  "usingComponents": {
    "towxml":"/towxml/towxml"
  }
}

3. 在页面中插入组件

// pages/content-detail/content-detail.wxml
<view class="content-info">
  <towxml nodes="{{article}}"/>
</view>

4. 在js中解析内容

解析内容的方式我这边给出了两种版本，一种是plus无忧版，一种是基础版，我先说说plus版

plus无忧版

正常来说，markdown源数据都应该是从服务端获取，那我们就先封装一个请求方法(我是在App.js中进行封装)

App({
  // 引入`towxml3.0`解析方法
  towxml:require(&#39;/towxml/index&#39;),
    //声明一个数据请求方法
  getText: (url, callback) => {
    wx.request({
      url: url,
      header: {
        &#39;content-type&#39;: &#39;application/x-www-form-urlencoded&#39;
      },
      success: (res) => {
        if (typeof callback === &#39;function&#39;) {
          callback(res);
        };
      }
    });
  }
  })

然后在具体页面的js文件中处理解析内容

// pages/content-detail/content-detail.js
const app = getApp();
Page({
 
  /**
   * 页面的初始数据
   */
  data: {
   article:{}
  },
 
  /**
   * 生命周期函数--监听页面加载
   */
  onLoad: function (options) {
    app.getText(&#39;https://www.vvadd.com/wxml_demo/demo.txt?v=2&#39;,res => {
      let obj = app.towxml(res.data,&#39;markdown&#39;,{
        theme:&#39;light&#39;, //主题 dark 黑色，light白色，不填默认是light
        base:"www.xxx.com",
        events:{      //为元素绑定的事件方法
          tap:e => {
            console.log(&#39;tap&#39;,e);
          },
          change:e => {
            console.log(&#39;todo&#39;,e);
          }
        }
      });
      //更新解析数据
      this.setData({
        article:obj,
      });
    });
  },
})

这里我是请求一个网址www.vvadd.com/wxml_demo/d…，这个网址会给我返回markdown源数据，我们先来看下这个请求地址里面有啥

我们获取到markdown数据后将其进行赋值，然后在页面就能直接展示出来，激动人心的时候到来了，看下最终的效果

效果是不是很完美，完美实现markdown展示

基础版

说完plus版本再来说说基础版，因为大家可能会有对markdown数据源的自定义处理的操作，所以就再来看看基础版的实现

// pages/content-detail/content-detail.js
const app = getApp();
Page({
 
  /**
   * 页面的初始数据
   */
  data: {
   article:{}
  },
 
  /**
   * 生命周期函数--监听页面加载
   */
  onLoad: function (options) {
    //markdown数据源
      let content= "<h1>h1h1h1h1h1h1</h1><h2>h2h2h2h2</h2><h3>123456</h3>"
    let result = app.towxml(content,&#39;markdown&#39;,{
       base:&#39;www.xxx.com&#39;,             // 相对资源的base路径
       theme:&#39;light&#39;,                   // 主题，默认`light`
      events:{                    // 为元素绑定的事件方法
           tap:(e)=>{
               console.log(&#39;h4&#39;,e);
           }
       }
   });
   // 更新解析数据
   this.setData({
      article:result
   });
  },
})