Уценка и в том числе несколько файлов - PullRequest
157 голосов
/ 24 января 2011

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

Ответы [ 13 ]

2 голосов
/ 14 марта 2019

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

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

  2. С здесь : включить файлы в основной файл, используя <iframe src="/path/to/file.md" seamless></iframe>

P.S.1. это решение работает не на всех движках / рендерах MarkDown. Например, Typora правильно отображала файлы, а код Visual Studio - нет. Было бы здорово, если бы другие могли поделиться своим опытом с другими платформами. Особенно хотелось бы услышать о GitHub и GitLab ...

P.S.2. При дальнейшем исследовании, как представляется, возникают серьезные проблемы несовместимости, приводящие к тому, что это неправильно отображается на многих платформах, включая Typora, GitHub и код Visual Studio. Пожалуйста, не используйте это, пока я не разрешаю их. Я не буду удалять ответ только ради обсуждения и, если возможно, вы можете поделиться своим мнением.

P.S.3. Для дальнейшего изучения этой проблемы я задал следующие вопросы здесь, в StackOverflow и , здесь, в Reddit .

P.S.4. После некоторого изучения я пришел к выводу, что на данный момент AsciiDoc является лучшим вариантом для документирования. Он поставляется со встроенной функцией включения, он обрабатывается GitHub, а основные редакторы кода, такие как Atom и vscode, имеют расширения для предварительного просмотра в реальном времени. Можно использовать Pandoc или другие инструменты для автоматического преобразования существующего кода MarkDown в AsciiDoc с небольшими изменениями.

P.S.5. Другой легкий язык разметки со встроенной функцией включения - reStructuredText. Стандартно поставляется с .. include:: inclusion.txt синтаксисом. Также имеется ReText редактор с предварительным просмотром в реальном времени.

0 голосов
/ 14 октября 2018

ИМХО, Вы можете получить свой результат, объединив свои входные * .md файлы вроде:

$ pandoc -s -o outputDoc.pdf inputDoc1.md inputDoc2.md outputDoc3.md
0 голосов
/ 21 февраля 2015

Я использую Marked 2 в Mac OS X. Он поддерживает следующий синтаксис для включения других файлов.

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

К сожалению, вы не можете передать это Пандоку, так как он не понимает синтаксис.Однако написание сценария для удаления синтаксиса для построения командной строки pandoc достаточно просто.

Добро пожаловать на сайт PullRequest, где вы можете задавать вопросы и получать ответы от других членов сообщества.
...