Markdown和包括多个文件

是否有任何markdown fork允许你引用其他文件，比如包含文件?具体来说，我想创建一个单独的markdown文件，其中包含我经常调用但不总是调用的链接(调用此B.md)，然后当我通过引用链接到我正在写入的md文件(A.md)时，我希望它从另一个文件(B.md)中拉出链接，而不是从当前文件(A.md)的末尾。

当前回答

我认为我们最好采用一种新的文件包含语法(这样就不会搞砸了代码块，我认为C风格的包含是完全错误的)，我用Perl写了一个小工具，命名为cat.pl，因为它的工作方式像cat (cat a.txt b.txt c.txt将合并三个文件)，但它合并文件的深度，而不是宽度。如何使用?

$ perl cat.pl <your file>

详细语法为:

递归包含文件:@include <-=path= 只包含一个:%include <-=path=

它可以正确地处理文件包含循环(如果a.txt <- b.txt, b.txt <- a.txt，那么您期望什么?)

例子:

a.txt:

a.txt

    a <- b

    @include <-=b.txt=

a.end

b.txt:

b.txt

    b <- a

    @include <-=a.txt=

b.end

Perl cat.pl .txt > c.txt

a.txt

    a <- b

    b.txt

        b <- a

        a.txt

            a <- b

            @include <-=b.txt= (note：won't include, because it will lead to infinite loop.)

        a.end

    b.end

a.end

更多例子请访问https://github.com/district10/cat/blob/master/tutorial_cat.pl_.md。

我还编写了一个Java版本，具有相同的效果(不相同，但接近)。

2016-12-31 14:04:23

其他回答

我只想提一下，在将输入文件输送到markdown_py之前，可以使用cat命令连接输入文件，这与pandoc处理多个输入文件的效果相同。

cat *.md | markdown_py > youroutputname.html

在我的Mac上，Python版本的Markdown与上面的pandoc示例几乎相同。

2013-03-16 14:33:34

简短的回答是否定的。长一点的答案是肯定的。: -)

Markdown的设计目的是让人们能够编写简单、可读的文本，这些文本可以很容易地转换为简单的HTML标记。它不做文档布局。例如，没有真正的方法来将图像向左或向右对齐。至于你的问题，在任何版本的markdown中都没有包含从一个文件到另一个文件的单个链接的markdown命令(据我所知)。

与此功能最接近的是Pandoc。Pandoc允许您将文件合并为转换的一部分，这允许您轻松地将多个文件呈现为单个输出。例如，如果你正在创建一本书，那么你可以有这样的章节:

01_preface.md
02_introduction.md
03_why_markdown_is_useful.md
04_limitations_of_markdown.md
05_conclusions.md

你可以在同一个目录下执行这个命令来合并它们:

pandoc *.md > markdown_book.html

因为pandoc会在翻译之前合并所有的文件，你可以像这样在最后一个文件中包含你的链接:

01_preface.md
02_introduction.md
03_why_markdown_is_useful.md
04_limitations_of_markdown.md
05_conclusions.md
06_links.md

这是你序言的一部分。Md可以是这样的:

I always wanted to write a book with [markdown][mkdnlink].

也是你02_introduction的一部分。Md可以是这样的:

Let's start digging into [the best text-based syntax][mkdnlink] available.

只要你的最后一个文件包含这行:

[mkdnlink]: http://daringfireball.net/projects/markdown

.．.之前使用的相同命令将执行合并和转换，同时始终包含该链接。只要确保在文件的开头留下一到两行空白即可。pandoc文档说，它在以这种方式合并的文件之间添加了一个空行，但如果没有空行，这对我来说行不通。

2011-04-03 12:13:38

受@Oliver Matthews回答的启发，你可以创建一个perl脚本，递归地查找语法!md]]，并将其替换为B.md content

让我们创建名为parsem .sh的递归脚本

#!/usr/bin/env bash
perl -ne 's#^!\[\[(.+?)\]\].*#`'$0' "$1"`#e;print' "$@"

像这样使用它

./parseMd.sh A.md > result.md

使用它和pandoc一起导出为pdf

pandoc <(./parseMd.sh A.md) -o result.pdf

2022-07-27 00:23:48

另一个使用markdown-it和jQuery的基于html的客户端解决方案。下面是一个小的HTML包装作为主文档，它支持无限的markdown文件的include，但不支持嵌套include。在JS注释中提供了解释。错误处理略。

<script src="/markdown-it.min.js"></script>
<script src="/jquery-3.5.1.min.js"></script>

<script> 
  $(function() {
    var mdit = window.markdownit();
    mdit.options.html=true;
    // Process all div elements of class include.  Follow up with custom callback
    $('div.include').each( function() {
      var inc = $(this);
      // Use contents between div tag as the file to be included from server
      var filename = inc.html();
      // Unable to intercept load() contents.  post-process markdown rendering with callback
      inc.load(filename, function () {
        inc.html( mdit.render(this.innerHTML) );
      });
  });
})
</script>
</head>

<body>
<h1>Master Document </h1>

<h1>Section 1</h1>
<div class="include">sec_1.md</div>
<hr/>
<h1>Section 2</h1>
<div class="include">sec_2.md</div>

2020-06-05 00:39:08

就在最近，我在Node中写了一些类似的东西，叫做markdown-include，它允许你用C风格的语法包含markdown文件，像这样:

#include "my-file.md"

我相信这和你问的问题很吻合。我知道这是一个旧的，但我至少想更新它。

您可以将此包含在任何您希望的标记文件中。该文件还可以有更多的include, markdown-include将创建一个内部链接，并为您完成所有工作。

你可以通过npm下载它

npm install -g markdown-include

2015-02-19 21:45:05

Markdown和包括多个文件

推荐文章

最新文章

标签