markdown语法转换成html渲染到页面

markdown 转换html

需要用到三个库

  • EJS 可以帮助我们在HTML中潜入动态内容
  • Marked 一个流行的解析器和编译器,可以将markdown转换成html标记
  • BrowserSync 可以实施帮助你同步和更换你的网页修改,当你对markdown文件进行编辑将其转换成html时,browserSync可以自动刷新你的浏览器,使你能够及时查看你转换后的结果
建立ejs模版,template.ejs

入门语法 https://ejs.bootcss.com/#install

<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="UTF-8" />
    <meta http-equiv="X-UA-Compatible" content="IE=edge" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <title><%= title %></title>
    <!-- index.css 为markdown转html后需要的样式模版 -->
    <link rel="stylesheet" href="./index.css" />
  </head>
  <body>
    <!-- % 代表可以动态插入  -->
    <%- content %>
  </body>
</html>

建立markdown模版文件,README.md(随便写了点内容)
### 命名路由,编程式跳转

```js
const routes: RouteRecordRaw[] = [
  {
    path: "/",
    name: "A",
    component: () => import("../A.vue"),
  },
  {
    path: "/B",
    name: "B",
    component: () => import("../B.vue"),
  },
];
### 处理markdown转换成html的逻辑语法,建立index.js文件
```js
const ejs = require("ejs");

// 读取文件
const fs = require("fs");

// 编译为html
const marked = require("marked");

// 创建一个全局变量
let browser;
// 浏览器自动启服务,加载相应页面
const browserSync = require("browser-sync");

const server = () => {
  // 创建一个服务
  browser = browserSync.create();
  // 调用init启动
  browser.init({
    server: {
      // 根目录
      baseDir: "./",
      index: "index.html",  // 渲染index.html页面
    },
  });
};

// 通过ejs读取文件
const init = (callback) => {
  // 读取markdown里的内容
  const md = fs.readFileSync("README.md", "utf-8");

  // 通过parse方法转换成html
  //   console.log(marked.parse(md));
  // 把转换的markdown语法插入到html中
  ejs.renderFile(
    "template.ejs",  // 使用此模版
    {
      content: marked.parse(md),  // 替换模版里的内容
      title: "markdown 转换成 html",
    },
    (err, data) => {
      if (err) throw err;
      fs.writeFileSync("index.html", data); // 根目录下创建一个index.html,若是存在,则会替换
      // 调用当前服务
      callback && callback();
    }
  );
};

// 监听文件变动,保持实时更新
fs.watchFile("README.md", (curr, prev) => {
  console.log("curr", curr);
  // 若是md有修改,则时间会是最新的
  if (curr.mtime !== prev.mtime) {
    init(() => {
      browser.reload(); // 当前启动的服务里重新加载,不会再启动第二个服务
    });
  }
});

// 初始化调用
init(() => {
  server();
});

### 使用 jQuery 渲染 Markdown 内容 尽管 jQuery 并不直接支持解析和渲染 Markdown,但它可以与其他库结合实现这一功能。通常情况下,会使用专门用于处理 MarkdownJavaScript 库(如 `marked` 或 `showdown`),并通过 jQuery 来动态加载这些库并操作 DOM。 以下是具体方法: #### 方法概述 1. **引入必要的库** 需要同时引入 `jquery` 和一个 Markdown 解析器(例如 `marked`)。可以通过 CDN 加载它们[^3]。 2. **编写脚本逻辑** 利用 jQuery 获取 Markdown 原始内容,并通过 Markdown 解析器将其转换为 HTML 后插入到页面中。 #### 示例代码 以下是一个完整的示例,展示如何利用 jQuery 和 `marked` 将 Markdown 转换为 HTML渲染页面上。 ```javascript // 引入必要资源 <script src="https://code.jquery.com/jquery-3.6.0.min.js"></script> <script src="https://cdn.jsdelivr.net/npm/marked/marked.min.js"></script> $(document).ready(function() { // 定义一段 Markdown 文本 var markdownText = "# Hello, World!\nThis is an example of **Markdown** being rendered using *jQuery* and `marked`.\n\n- Item 1\n- Item 2"; // 使用 marked 将 Markdown 转换为 HTML var htmlContent = marked(markdownText); // 找到目标容器并将生成的 HTML 插入其中 $('#content').html(htmlContent); }); ``` #### 页面结构 为了使上述代码正常工作,需在 HTML 中定义一个目标容器供插入内容。 ```html <div id="content"> <!-- 这里将显示渲染后的 Markdown --> </div> ``` 以上代码展示了如何通过 jQuery 动态获取 Markdown 数据并调用外部工具完成渲染过程[^1]。 #### 关键点说明 - **依赖管理**:确保正确加载所有必需的第三方库。如果启用了 HTTPS,请始终使用 HTTPS 协议加载文件。 - **性能优化**:对于较大的文档或频繁更新的内容,考虑异步加载数据以提高用户体验。 ---
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值