Чи є вилка розмітки, яка дозволяє посилатися на інші файли, на кшталт файлу, що включає? Зокрема, я хочу створити окремий файл розмітки із посиланнями, які я дзвоню часто, але не завжди (називаю це B.md), тоді, коли я посилаюся за посиланням у файлі md, який я пишу (A.md), я б як-небудь, щоб перетягнути посилання з іншого файлу (B.md), а не з кінця поточного файлу (A.md).

Коротка відповідь - ні. Довга відповідь - так. :-)

Розмітка була розроблена, щоб люди могли писати простий, читабельний текст, який можна було легко перетворити на просту розмітку HTML. Насправді це не макет документа. Наприклад, немає реального способу вирівняти зображення праворуч або ліворуч. Що стосується вашого питання, то жодної команди розмітки немає, щоб включати одне посилання з одного файлу на інший у будь-яку версію розмітки (наскільки я знаю).

Найближчий ви могли б підійти до цієї функціональності - 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

Отже, частина вашого 01_preface.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 говорить, що вона додає порожній рядок між файлами, об'єднаними таким чином, але це не спрацювало для мене без порожнього рядка.

Я хотів би лише зазначити, що ви можете використовувати catкоманду для об'єднання вхідних файлів перед тим, як їх передати markdown_py, тим самим ефектом, що pandocі для кількох вхідних файлів.

cat *.md | markdown_py > youroutputname.html

працює майже так само, як приклад pandoc, наведений вище для версії Markton в Python на моєму Mac.

Ви можете фактично використовувати препроцесор Markdown ( MarkdownPP ). Запускаючи гіпотетичний приклад книги з інших відповідей, ви створювали б .mdppфайли, що представляють ваші глави. Потім .mdppфайли можуть використовувати !INCLUDE "path/to/file.mdpp"директиву, яка працює рекурсивно, замінюючи директиву вмістом згаданого файлу у кінцевому висновку.

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

Тоді вам знадобиться такий, index.mdppякий містив би таке:

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

Для надання вашої книги просто запустіть препроцесор index.mdpp:

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

Не забудьте подивитися readme.mdppв сховищі MarkdownPP для експозиції функцій препроцесора, що підходять для більш великих документаційних проектів.

Моє рішення - використовувати m4. Він підтримується на більшості платформ і входить у пакет binutils.

Спочатку включіть changequote()у файл макрос, щоб змінити символи котирування на те, що вам подобається (за замовчуванням - `'). Макрос видаляється, коли файл обробляється.

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

У командному рядку:

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

Нещодавно я написав щось подібне в Node під назвою markdown-include, що дозволяє включати файли розмітки з синтаксисом стилю C, наприклад:

#include "my-file.md"

Я вважаю, що це добре узгоджується з питанням, яке ви задаєте. Я знаю це старе, але хотів оновити його принаймні.

Ви можете включити це у будь-який файл розмітки, який бажаєте. Цей файл також може мати більше включень, а розмітка-включення зробить внутрішнє посилання та зробить всю роботу за вас.

Ви можете завантажити його через npm

npm install -g markdown-include

Multimarkdown має це споконвічно. Це називає переключення файлів :

{{some_other_file.txt}}

це все, що потрібно. Дивна назва, але галочки всі коробки.

Я використовую includes.txtфайл із усіма своїми файлами у потрібному порядку, я виконую такий парадок:

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

Працює як шарм!

Насправді ви можете використовувати \input{filename}і \include{filename}які є латексними командами безпосередньо в Pandoc, оскільки він підтримує майже всі htmlта latexсинтаксис.

Але будьте обережні, включений файл буде розглядатися як latexфайл. Але ви можете скомпілювати markdownTo latexз Pandoxлегкістю.

Asciidoc ( http://www.methods.co.nz/asciidoc/ ) - насправді відмітка стероїдів. В цілому, Ассідок і Маркдаун будуть виглядати дуже схоже, і їх досить легко переключити. Величезна перевага над Asciidoc уцінкою, що він підтримує вже включає, для інших файлів Asciidoc , але і як будь-який формат. Ви навіть можете частково включати файли на основі номерів рядків або тегів всередині доданих файлів.

Включення інших файлів насправді зберігає життя під час написання документів.

Наприклад, ви можете мати файл asciidoc з таким вмістом:

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

і підтримувати свій зразок в script.pl

І я впевнений, що ви здивуєтеся так, Github також підтримує асцидок.

Я думаю, що нам краще прийняти новий синтаксис включення файлів (так що не зіпсується з кодовими блоками, я думаю, що включення стилю 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 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

Більше прикладів на веб-сторінці https://github.com/district10/cat/blob/master/tutorial_cat.pl_.md .

Я також написав версію Java з однаковим ефектом (не однаковий, але близький).

Я насправді здивований, що ніхто на цій сторінці не запропонував жодних HTML-рішень. Наскільки я зрозумів, файли MarkDown можуть включати широку частину (якщо не всі) тегів HTML. Тому виконайте наступні дії:

1. Від сюди : покласти ваші файли уцінка в <span style="display:block"> ... </span>тегах , щоб переконатися , що вони будуть візуалізуються як уцінка. У вас є маса інших властивостей стилю, які ви можете додати. Мені подобається той text-align:justify.

2. Від сюди : Включити файли в основний файл , використовуючи<iframe src="/path/to/file.md" seamless></iframe>

PS1. це рішення працює не у всіх двигунах / рендерах MarkDown. Наприклад, Typora візуалізувала файли правильно, але Visual Studio Code не виконала. Було б чудово, якби інші могли поділитися своїм досвідом з іншими платформами. Особливо я хотів би почути про GitHub та GitLab ...

PS2. При подальшому дослідженні, мабуть, є основні проблеми несумісності, що призводять до того, що це не належним чином відображається на багатьох платформах, включаючи код Typora, GitHub та Visual Studio. Будь ласка, не використовуйте це, поки я не вирішу їх. Я не видаляю відповідь лише заради обговорення, і якщо, можливо, ви зможете поділитися своєю думкою.

PS3. Для подальшого дослідження цього питання я задав ці питання тут на StackOverflow та тут на Reddit .

PS4. Після деяких досліджень, я прийшов до висновку, що на даний момент AsciiDoc є кращим варіантом для документації. Він оснащений вбудованою функцією включення, він надається GitHub, а основні редактори коду, такі як Atom та vscode, мають розширення для попереднього перегляду. Можна використовувати Pandoc або інші інструменти для автоматичного перетворення існуючого коду MarkDown в AsciiDoc з незначними змінами.

PS5. Ще одна легка мова розмітки із вбудованою функціональністю включає reStructuredText. Він поставляється із .. include:: inclusion.txt синтаксисом за стандартом. Є також редактор ReText з попереднім попереднім переглядом.

Я знаю, що це давнє запитання, але я не бачив відповідей на цей ефект: По суті, якщо ви використовуєте markdown та pandoc для перетворення свого файлу в pdf, у ваші дані yaml у верхній частині сторінки ви можете включити щось на зразок цього:

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

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

# Section

Blah blah

## Section 

Blah blah

Оскільки pandoc використовує латекс для перетворення всіх ваших документів, header-includesрозділ викликає пакет pdfpages. Тоді, коли ви включите \includepdf{/path/to/pdf/document.pdf}його, ви вставите все, що є у цьому документі. Крім того, ви можете включити кілька файлів у форматі PDF таким чином.

Як веселий бонус, і це лише тому, що я часто використовую розмітку, якщо ви хочете включити файли, відмінні від розмітки, наприклад файли з латексу. Я дещо змінив цю відповідь . Скажіть, що у вас є файл розмітки markdown1.md:

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

І два додаткові файли латексу document1, який виглядає приблизно так:

\section{Section}

Profundity.

\subsection{Section}

Razor's edge.

І ще, document2.tex, який виглядає приблизно так:

\section{Section

Glah

\subsection{Section}

Balh Balh

Припускаючи, що ви хочете включити document1.tex і document2.tex в markdown1.md, ви просто зробите це для markdown1.md

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

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

Виконати пандок над ним, наприклад

в терміналі pandoc markdown1.md -o markdown1.pdf

Ваш заключний документ буде виглядати приблизно так:

Щось означає повне

Говорить голова

Розділ

Проникливість.

Розділ

Бритва краю.

Розділ

Глах

Розділ

Balh Balh

Я використовую Marked 2 на Mac OS X. Він підтримує наступний синтаксис для включення інших файлів.

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

На жаль, ви не можете подати його до pandoc, оскільки він не розуміє синтаксис. Однак написати сценарій для зняття синтаксису для побудови командного рядка pandoc досить просто.

Ще одне на базі HTML, клієнтське рішення, що використовує markdown-it та jQuery . Нижче наведено невелику обгортку HTML як основний документ, який підтримує необмежену кількість файлів розмітки, але не вкладених включає. Пояснення надано в коментарях до СВ. Помилка обробки відхилена.

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

Синтаксис @import підтримується в програмі vscode-markdown-preview

https://github.com/shd101wyy/vscode-markdown-preview-enhanced

що, ймовірно, означає його частину основного інструментального муму

https://github.com/shd101wyy/mume

та інші інструменти, побудовані на мумі

https://github.com/gabyx/TechnicalMarkdown

IMHO, Ви можете отримати свій результат, об'єднавши вхідні файли * .md на зразок:

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