将多个markdown文件发布为一个html或pdf文件的方法梳理

最新推荐文章于 2025-06-29 13:39:06 发布

汀桦坞

最新推荐文章于 2025-06-29 13:39:06 发布

阅读量9.8k

点赞数 1

CC 4.0 BY-SA版权

分类专栏： Office 文章标签： Markdown

本文链接：https://blog.youkuaiyun.com/wiborgite/article/details/86530298

Office 专栏收录该内容

13 篇文章

订阅专栏

本文介绍三种高效整合多文档的方法：使用gitbook的SUMMARY.md文件、pandoc命令结合描述文件及AsciidocFX工具，详细展示了如何通过这些工具将分散的markdown文件整合成结构化的文档集。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

1、借助gitbook
gitbook通过一个名称为SUMMARY.md的文件来组织文档，示例内容如下：

# Summary

* [Introduction](README.md)
* [Installation](installation.md)
* [CLI Tools](cli_tools.md)
   * [Getting started](getting_started.md)
   * [Interactive Console](interactive_console.md)
   * [Mining](mining.md)
   * [ethkey](ethkey.md)
* [Whisper](whisper.md)
* Recipes and How-tos
   * [Cold Wallet Storage Device](cold_wallet_storage_device.md)

2、利用pandoc命令实现
利用pandoc将多个文件发布为一个输出件时，也需要一个描述文件，如命令为title.txt，示例内容如下所示：

---
title: Pro Git
author: Scott Chacon
rights:  Creative Commons Non-Commercial Share Alike 3.0
language: en_US
...

发布命令：

pandoc -o progit.html title.txt \
  01-introduction/01-chapter1.markdown \
  02-git-basics/01-chapter2.markdown \
  03-git-branching/01-chapter3.markdown \
  04-git-server/01-chapter4.markdown \

3、利用AsciidocFX
asciidoctor用户手册：https://asciidoctor.org/docs/user-manual
AsciidocFX与gitbook处理的方式类似，在一个adoc文件中关联其它文件，并用该文件进行发布即可。也即使用一个adoc文件来关联markdown文件。
假设使用的adoc文件名称为book.adoc，示例内容如下所示：

= XXX 用户手册
author name

:doctype: book
:encoding: utf-8
:lang: en
:toc: left
:toclevels: 2
:numbered:

include::1-introduction/01-chapter1.markdown[]

include::02-git-basics/01-chapter2.markdown[]

include::03-git-branching/01-chapter3.markdown[]

AsciidocFX界面截图：