Có bất kỳ ngã ba markdown nào cho phép bạn tham chiếu các tệp khác, giống như một tệp bao gồm không? Cụ thể, tôi muốn tạo một tệp đánh dấu riêng với các liên kết mà tôi gọi thường xuyên nhưng không phải lúc nào cũng được (gọi đây là B.md), sau đó khi tôi liên kết bằng cách tham chiếu trong tệp md tôi đang viết (A.md), tôi sẽ muốn nó kéo liên kết từ tệp khác (B.md) chứ không phải từ cuối tệp hiện tại (A.md).

Câu trả lời ngắn gọn là không. Câu trả lời dài là có. :-)

Markdown được thiết kế để cho phép mọi người viết văn bản đơn giản, dễ đọc, có thể dễ dàng chuyển đổi thành đánh dấu HTML đơn giản. Nó không thực sự làm bố cục tài liệu. Ví dụ, không có cách thực sự nào để căn chỉnh hình ảnh sang phải hoặc trái. Đối với câu hỏi của bạn, không có lệnh markdown để bao gồm một liên kết duy nhất từ ​​tệp này sang tệp khác trong bất kỳ phiên bản đánh dấu nào (theo như tôi biết).

Gần nhất bạn có thể đến với chức năng này là Pandoc . Pandoc cho phép bạn hợp nhất các tệp như một phần của phép chuyển đổi, cho phép bạn dễ dàng kết xuất nhiều tệp thành một đầu ra. Ví dụ: nếu bạn đang tạo một cuốn sách, thì bạn có thể có các chương như thế này:

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

Bạn có thể hợp nhất chúng bằng cách thực hiện lệnh này trong cùng một thư mục:

pandoc *.md > markdown_book.html

Vì pandoc sẽ hợp nhất tất cả các tệp trước khi thực hiện bản dịch, bạn có thể bao gồm các liên kết của mình trong tệp cuối cùng như thế này:

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

Vì vậy, một phần của bạn 01_preface.mdcó thể trông như thế này:

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

Và một phần của bạn 02_introduction.mdcó thể trông như thế này:

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

Miễn là tập tin cuối cùng của bạn bao gồm dòng:

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

... cùng một lệnh được sử dụng trước đó sẽ thực hiện hợp nhất và chuyển đổi trong khi bao gồm liên kết đó xuyên suốt. Chỉ cần đảm bảo rằng bạn để lại một hoặc hai dòng trống ở đầu tập tin đó. Các tài liệu pandoc nói rằng nó sẽ thêm một dòng trống giữa các tập tin được sáp nhập theo cách này, nhưng điều này không làm việc cho tôi mà không có dòng trống.

Tôi chỉ đề cập rằng bạn có thể sử dụng catlệnh để ghép các tệp đầu vào trước khi đặt chúng vào markdown_pyđó có tác dụng tương tự như pandocvới nhiều tệp đầu vào.

cat *.md | markdown_py > youroutputname.html

hoạt động khá giống với ví dụ pandoc ở trên cho phiên bản Python của Markdown trên máy Mac của tôi.

Bạn thực sự có thể sử dụng Bộ xử lý trước Markdown ( MarkdownPP ). Chạy với ví dụ cuốn sách giả thuyết từ các câu trả lời khác, bạn sẽ tạo .mdppcác tệp đại diện cho các chương của bạn. Các .mdpptệp sau đó có thể sử dụng lệnh !INCLUDE "path/to/file.mdpp", hoạt động đệ quy thay thế lệnh bằng nội dung của tệp được tham chiếu trong đầu ra cuối cùng.

chapters/preface.mdpp
chapters/introduction.mdpp
chapters/why_markdown_is_useful.mdpp
chapters/limitations_of_markdown.mdpp
chapters/conclusions.mdpp

Sau đó, bạn sẽ cần một index.mdppcái có chứa như sau:

!INCLUDE "chapters/preface.mdpp"
!INCLUDE "chapters/introduction.mdpp"
!INCLUDE "chapters/why_markdown_is_useful.mdpp"
!INCLUDE "chapters/limitations_of_markdown.mdpp"
!INCLUDE "chapters/conclusions.mdpp"

Để hiển thị sách của bạn, bạn chỉ cần chạy bộ tiền xử lý trên index.mdpp:

$ markdown-pp.py index.mdpp mybook.md

Đừng quên xem readme.mdpptrong kho lưu trữ MarkdownPP để biết các tính năng tiền xử lý phù hợp với các dự án tài liệu lớn hơn.

Giải pháp của tôi là sử dụng m4. Nó được hỗ trợ trên hầu hết các nền tảng và được bao gồm trong gói binutils.

Đầu tiên bao gồm một macro changequote()trong tệp để thay đổi các ký tự trích dẫn thành những gì bạn thích (mặc định là `'). Macro được loại bỏ khi tập tin được xử lý.

changequote(`{{', `}}')
include({{other_file}})

Trên dòng lệnh:

m4 -I./dir_containing_other_file/ input.md > _tmp.md
pandoc -o output.html _tmp.md

Gần đây tôi đã viết một cái gì đó như thế này trong Node gọi là markdown - bao gồm cho phép bạn bao gồm các tệp markdown với cú pháp kiểu C, như vậy:

#include "my-file.md"

Tôi tin rằng điều này phù hợp độc đáo với câu hỏi bạn đang hỏi. Tôi biết cái này cũ, nhưng tôi muốn cập nhật nó ít nhất.

Bạn có thể bao gồm điều này trong bất kỳ tập tin đánh dấu nào bạn muốn. Tập tin đó cũng có thể có nhiều bao gồm hơn và bao gồm đánh dấu sẽ tạo một liên kết nội bộ và thực hiện tất cả công việc cho bạn.

Bạn có thể tải nó qua npm

npm install -g markdown-include

Multimarkdown có điều này tự nhiên. Nó gọi nó là loại trừ tập tin :

{{some_other_file.txt}}

là tất cả những gì nó cần Tên lạ, nhưng đánh dấu vào tất cả các hộp.

Tôi sử dụng một includes.txttệp với tất cả các tệp của mình theo đúng thứ tự tôi thực hiện pandoc như thế này:

pandoc -s $(cat includes.txt) --quiet -f markdown -t html5 --css pandoc.css -o index.html

Hoạt động như một lá bùa!

Trong thực tế, bạn có thể sử dụng \input{filename}và \include{filename}đó là các lệnh latex, trực tiếp Pandoc, bởi vì nó hỗ trợ gần như tất cả htmlvà latexcú pháp.

Nhưng hãy cẩn thận, tập tin bao gồm sẽ được coi là latextập tin. Nhưng bạn có thể biên dịch của bạn markdownđể latexcó Pandoxmột cách dễ dàng.

Asciidoc ( http://www.methods.co.nz/asciidoc/ ) thực sự là một sự đánh dấu trên steroid. Nhìn chung, Asciidoc và Markdown sẽ trông rất giống nhau và khá dễ dàng để chuyển đổi. Một lợi ích to lớn của Asciidoc so với markdown là nó đã hỗ trợ bao gồm, cho các tệp Asciidoc khác mà còn cho bất kỳ định dạng nào bạn thích. Bạn thậm chí có thể bao gồm một phần các tệp dựa trên số dòng hoặc thẻ bên trong các tệp được bao gồm của bạn.

Bao gồm các tệp khác thực sự là một trình bảo vệ cuộc sống khi bạn viết tài liệu.

Ví dụ, bạn có thể có tệp asciidoc với nội dung như vậy:

// [source,perl]
// ----
// include::script.pl[]
// ----

và duy trì mẫu của bạn trong script.pl

Và tôi chắc chắn bạn sẽ tự hỏi nên có, Github cũng hỗ trợ asciidoc.

Tôi nghĩ rằng chúng ta nên áp dụng một cú pháp bao gồm tệp mới (vì vậy sẽ không gây rối với các khối mã, tôi nghĩ rằng việc bao gồm kiểu C là hoàn toàn sai) và tôi đã viết một công cụ nhỏ trong Perl, đặt tên cat.pl, vì nó hoạt động như thếcat ( cat a.txt b.txt c.txtsẽ hợp nhất ba tệp), nhưng nó hợp nhất các tệp theo chiều sâu , không theo chiều rộng . Sử dụng như thế nào?

$ perl cat.pl <your file>

Cú pháp chi tiết là:

• đệ quy bao gồm các tệp: @include <-=path=
• chỉ bao gồm một: %include <-=path=

Nó có thể xử lý đúng các vòng lặp bao gồm tệp (nếu a.txt <- b.txt, b.txt <- a.txt, thì bạn mong đợi điều gì?).

Thí dụ:

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 a.txt > c.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

Thêm ví dụ tại https://github.com/district10/cat/blob/master/tutorial_cat.pl_.md .

Tôi cũng đã viết một phiên bản Java có hiệu ứng giống hệt nhau (không giống nhau, nhưng gần gũi).

Tôi thực sự ngạc nhiên khi không ai trong trang này đưa ra bất kỳ giải pháp HTML nào. Theo tôi đã hiểu các tệp MarkDown có thể bao gồm phần rộng (nếu không phải tất cả) của các thẻ HTML. Vì vậy, hãy làm theo các bước sau:

1. Từ đây : đặt các tệp MarkDown của bạn vào <span style="display:block"> ... </span>các thẻ để đảm bảo chúng sẽ được hiển thị dưới dạng đánh dấu. Bạn có rất nhiều thuộc tính phong cách khác mà bạn có thể thêm. Một trong tôi như là text-align:justify.

2. Từ đây : Bao gồm các tệp trong tệp chính của bạn bằng cách sử dụng<iframe src="/path/to/file.md" seamless></iframe>

PS1. giải pháp này không hoạt động trên tất cả các công cụ / kết xuất MarkDown. Ví dụ Typora đã kết xuất các tệp một cách chính xác nhưng Visual Studio Code thì không. Sẽ thật tuyệt nếu những người khác có thể chia sẻ kinh nghiệm của họ với các nền tảng khác. Đặc biệt tôi muốn nghe về GitHub và GitLab ...

PS2. Khi điều tra sâu hơn, dường như có các vấn đề không tương thích lớn dẫn đến việc này không được hiển thị đúng trên nhiều nền tảng, bao gồm mã Typora, GitHub và Visual Studio. Xin vui lòng không sử dụng điều này cho đến khi tôi giải quyết chúng. Tôi sẽ không xóa câu trả lời chỉ vì mục đích thảo luận và nếu có thể bạn có thể chia sẻ ý kiến ​​của mình.

PS3. Để điều tra thêm về vấn đề này, tôi đã hỏi câu hỏi này ở đây trên StackOverflow và ở đây trên Reddit .

PS4. Sau một số nghiên cứu, tôi đã đi đến kết luận rằng hiện tại, AsciiDoc là một lựa chọn tốt hơn cho tài liệu. Nó đi kèm với chức năng bao gồm tích hợp, nó được GitHub kết xuất và các trình soạn thảo mã lớn như Atom và vscode có phần mở rộng để xem trước trực tiếp. Người ta có thể sử dụng Pandoc hoặc các công cụ khác để tự động chuyển đổi Mã MarkDown hiện tại sang AsciiDoc với những thay đổi nhỏ.

PS5. Một ngôn ngữ đánh dấu nhẹ khác với chức năng bao gồm tích hợp là reStructuredText. Nó đi kèm với .. include:: inclusion.txt cú pháp theo tiêu chuẩn. Có trình soạn thảo ReText với xem trước trực tiếp là tốt.

Tôi biết rằng đây là một câu hỏi cũ, nhưng tôi chưa thấy câu trả lời nào cho hiệu ứng này: Về cơ bản, nếu bạn đang sử dụng markdown và pandoc để chuyển đổi tệp của mình sang pdf, trong dữ liệu yaml của bạn ở đầu trang, bạn có thể đưa vào đại loại như thế này:

---
header-includes:
- \usepackage{pdfpages}
output: pdf_document
---

\includepdf{/path/to/pdf/document.pdf}

# Section

Blah blah

## Section 

Blah blah

Vì pandoc sử dụng latex để chuyển đổi tất cả các tài liệu của bạn, header-includesphần này gọi gói pdfpages. Sau đó, khi bạn đưa vào, \includepdf{/path/to/pdf/document.pdf}nó sẽ chèn bất cứ thứ gì có trong tài liệu đó. Hơn nữa, bạn có thể bao gồm nhiều tệp pdf theo cách này.

Như một phần thưởng thú vị, và điều này chỉ bởi vì tôi thường sử dụng markdown, nếu bạn muốn bao gồm các tệp khác ngoài markdown, ví dụ như các tệp latex. Tôi đã sửa đổi câu trả lời này một chút. Giả sử bạn có tệp markdown markdown1.md:

---
title: Something meaning full
author: Talking head
---

Và hai tập tin latex nghiện tài liệu1, trông như thế này:

\section{Section}

Profundity.

\subsection{Section}

Razor's edge.

Và một cái khác, document2.tex, trông như thế này:

\section{Section

Glah

\subsection{Section}

Balh Balh

Giả sử rằng bạn muốn bao gồm document1.tex và document2.tex vào markdown1.md, bạn sẽ chỉ làm điều này với markdown1.md

---
title: Something meaning full
author: Talking head
---

\input{/path/to/document1}
\input{/path/to/document2}

Chạy pandoc qua nó, ví dụ

trong thiết bị đầu cuối pandoc markdown1.md -o markdown1.pdf

Tài liệu cuối cùng của bạn sẽ trông giống như thế này:

Một cái gì đó có nghĩa đầy đủ

Đầu nói chuyện

Phần

Sự thành thạo.

Phần

Dao cạo cạnh.

Phần

Glah

Phần

Balh Balh

Tôi sử dụng Marked 2 trên Mac OS X. Nó hỗ trợ cú pháp sau để bao gồm các tệp khác.

<<[chapters/chapter1.md]
<<[chapters/chapter2.md]
<<[chapters/chapter3.md]
<<[chapters/chapter4.md]

Đáng buồn thay, bạn không thể cung cấp cho pandoc vì nó không hiểu cú pháp. Tuy nhiên, viết một kịch bản để loại bỏ cú pháp để xây dựng một dòng lệnh pandoc là đủ dễ dàng.

Một giải pháp phía máy khách, dựa trên HTML khác sử dụng markdown-it và jQuery . Dưới đây là một trình bao bọc HTML nhỏ dưới dạng tài liệu chính, hỗ trợ không giới hạn bao gồm các tệp đánh dấu, nhưng không bao gồm lồng nhau. Giải thích được cung cấp trong các ý kiến ​​JS. Xử lý lỗi được bỏ qua.

<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>

IMHO, Bạn có thể nhận được kết quả của mình bằng cách ghép các tệp * .md đầu vào của bạn như:

$ pandoc -s -o outputDoc.pdf inputDoc1.md inputDoc2.md outputDoc3.md