Я на самом деле удивлен, что никто на этой странице не предлагал никаких HTML-решений. Насколько я понял, файлы MarkDown могут включать в себя большую часть (если не все) тегов HTML. Поэтому выполните следующие действия:
С здесь : поместите ваши файлы MarkDown в теги <span style="display:block"> ... </span>
, чтобы убедиться, что они будут отображены как уценки. У вас есть множество других стилевых свойств, которые вы можете добавить. Мне больше нравится text-align:justify
.
С здесь : включить файлы в основной файл, используя <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 редактор с предварительным просмотром в реальном времени.