文档章节

将markdown文件转换成html格式

阿dai学长
 阿dai学长
发布于 10/14 17:38
字数 412
阅读 17
收藏 0

【推荐】2019 Java 开发者跳槽指南.pdf(吐血整理) >>>

概述

在写说明文档的时遇到一个问题:因为习惯了使用markdown写文档,在向nginx去发布的时候遇到一个语法格式不兼容的问题。

解决思路:

  1. nginx添加markdown格式支持;
  2. 更改文档为html格式(推荐)。

将markdown转换为html格式

用js实现。

依赖于node环境:部署node环境

创建一个html模板

template.html

<!DOCTYPE html>
<html lang="zh-CN">
    <head>
        <meta charset="utf-8">
        <meta http-equiv="X-UA-Compatible" content="IE=edge">
        <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1, user-scalable=no">
        <meta name="author" content="Yaofeng">
        <title>文档</title>
        <link rel="stylesheet" href="./markdown.min.css">
        <style>
            
        </style>
    </head>
    <body>
        @markdown
    </body>
    <script></script>
</html>

js脚本

trans.js

const fs = require('fs');
const marked = require('marked');
// 模板文件地址
fs.readFile('./template.html', 'utf8', (err, template)=>{  
    if(err){  
        throw err  
    }else{  
        // 源文件地址
        fs.readFile('./test.md', 'utf8', (err,markContent)=>{  
            if(err){  
                throw err  
            }else{  
                // 转化好的html字符串  
                let htmlStr = marked(markContent.toString())  
                // 将html模板文件中的 '@markdown' 替换为html字符串  
                template = template.replace('@markdown', htmlStr)  
                // 将新生成的字符串template重新写入到文件中==>模板文件地址  
                fs.writeFile('./test.html', template, err=>{  
                    if(err){  
                        throw err  
                    }else{  
                        console.log("success")  
                    }  
                })  
            }  
        })  
    }  
})

转换

  • 在trans.js中指定markdown文件地址;
  • 指定输出文件地址
  • 执行 node trans.js

如果执行过程中出现错误,一般是因为缺少某些依赖的包,直接根据提示信息 npm install xxx 安装即可!

© 著作权归作者所有

阿dai学长
粉丝 76
博文 263
码字总数 337363
作品 0
朝阳
运维
私信 提问
Markdown的Ruby实现--BlueCloth

BlueCloth是一个Markdown的Ruby实现,一个提供给网页文字撰写者将文本转成HTML的工具。Markdown令你可以写出容易阅读、容易撰写的文本格式,然后将它转换成结构化的XHTML(或者HTML)。 和其...

匿名
2009/04/01
920
0
Markdown 语法说明

NOTE: This is Simplelified Chinese Edition Document of Markdown Syntax. If you are seeking for English Edition Document. Please refer to Markdown: Syntax. 声明: 这份文档派生(fo......

憬薇
2017/05/04
0
0
Markdown 语法说明 (简体中文版)

此文档用 Markdown 语法编写,你可以到这里查看它的源文件。 概述 宗旨 Markdown 的目标是实现「易读易写」。 可读性,无论如何,都是最重要的。一份使用 Markdown 格式撰写的文件应该可以直...

tsl0922
2012/08/22
1K
3
使用 Pandoc 将你的书转换成网页和电子书

通过 Markdown 和 Pandoc,可以做到编写一次,发布两次。 Pandoc 是一个命令行工具,用于将文件从一种标记语言转换为另一种标记语言。在我 对 Pandoc 的简介 一文中,我演示了如何把 Markdo...

作者: Kiko Fernandez-reyes
2018/11/28
0
0
[译] 化 Markdown 为 HTML:用 Node.js 和 Express 搭建接口

原文地址:Building A Node.js Express API To Convert Markdown To HTML 原文作者:Sameer Borate 译文出自:掘金翻译计划 本文永久链接:github.com/xitu/gold-m… 译者:Baddyo 校对者:f...

👊Badd
05/16
0
0

没有更多内容

加载失败,请刷新页面

加载更多

交换机switch 的shutdown 与 no shutdown

shutdown是关闭接口(端口),接口状态会变为DOWN,no shutdown是激活接口(端口),状态变为UP,一般在给vlan或者端口配置管理ip或者端口ip后使用。 有时候我们配置某个端口前会需要把端口关闭到...

刘日辉
37分钟前
5
0
AOP底层源码分析

思维导图 AOP AOP: 面向切面编程[底层就是动态代理] 指程序在运行期间动态的将某段代码切入到指定方法位置进行运行的编程方式。 AOP通知方式 前置通知: logStart(),在目标方法(div)运行之前运...

volc1612
51分钟前
5
0
OSChina 周六乱弹 —— 别听他们的,你不胖你只是毛茸茸的

Osc乱弹歌单(2019)请戳(这里) 【今日歌曲】 @且无需多言 :分享Rise Against的单曲《Audience Of One (Ghost Note Symphonies)》: 硬核朋克不插电版本,隐藏在喧嚣下的柔情! 《Audienc...

小小编辑
今天
34
2
apache httpClient实现代理发送Post请求

CredentialsProvider credsProvider = new BasicCredentialsProvider(); credsProvider.setCredentials( new AuthScope("host", port), new UsernamePasswordCredentials(username, password......

huangkejie
今天
6
0
SpringCloud

单体应用存在的问题 ● 随着业务的发展,开发变得越来越复杂。 ● 修改、新增某个功能,需要对整个系统进行测试,重新部署。 ● 一个模块出现问题,很可能导致整个系统崩溃。 ● 多个开发团队...

Star永恒
今天
5
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部