#github #markdown #indentation #manpage #github-flavored-markdown
Вопрос:
Я пытаюсь написать справочную страницу в markdown, чтобы она правильно отображалась на Github, но также могла быть преобразована в настоящую справочную страницу.
Чтобы преобразовать его, я использую pandoc
. В основном это работает нормально, за исключением части «параметры».
Если я напишу нормальную уценку, как это:
# OPTIONS
**-h**
: Display help
**-v**
: Verbose
**-o**, **--other**
: Some other option with a much longer description
spanning several lines
это прекрасно работает, чтобы создать настоящую справочную страницу с
pandoc mytest.1.md -s -t man -o mytest.1
Но на Github файл md отображается с описаниями, начинающимися с «: «и без отступов. И на самом деле, я только что понял, что здесь то же самое, так что:
Опции
-ч
: Отображение справки
-в
: Многословно
-о, —другое
: Какой-нибудь другой вариант с гораздо более длинным описанием, охватывающим несколько строк
Как я могу написать справочную страницу в Markdown, которая правильно отображается на Github, с отступами, а также может быть преобразована в настоящую справочную страницу?