Почему вы должны выбрать стиль заголовков уценки ATX или SETEXT?
Я создаю простой редактор Markdown (стиль WYSIWYG, пользователь не видит Markdown). Каковы последствия с точки зрения управления git, когда вы используете Atx или Setext, какие-либо рекомендации?
Может быть, я путаюсь с некоторыми именами. Изначально я хочу сохранить то, что писатель создает с помощью уценки. Я использую конвертер js из HTML в Markdown (не уверен, что это «что-то» со вкусом уценки). Один из вариантов - определить, являются ли заголовки: Setext (тире под названием заголовка) или ATX (знаки # перед заголовком, но в той же строке). Уценка Github использует ATX. Я полагаю, мне просто интересно, почему вы взяли один вместо разное. github.com/domchristie/turndown#options
Ответы 2
С точки зрения управления Git: очень мало последствий, поскольку он остается простым текстовым файлом.
Выбор больше зависит от поддержки вашего механизма Markdown (по сравнению здесь), которую вы в конечном итоге будете использовать при чтении этого преобразованного файла markdown.
Спасибо, мне просто интересно, было ли сознательное решение использовать стиль заголовка в другой строке. Похоже, что для управления git он разделяет контент и стиль, но это только для заголовков, поэтому я не думаю, что это действительно причина.
@YoannMaingon Если и было, то это не было связано с Git. Создатель уценки упоминает эти два стиля (daringfireball.net/projects/markdown/основы). Atx обычно предпочтительнее (brettirpstra.com/2015/08/24/write-better-markdown), в том числе по общим меткам (spec.commonmark.org/0.29/#atx-заголовки), что является однозначной спецификацией.
Выбор стиля заголовка может иметь значение при использовании в сообщениях git. Например, если вы хотите автоматизировать генерацию фиксации сообщений из содержимого уценки, необходимо использовать setext. Рассмотрим ваш журнал изменений в ATX:
# v1.1.1 2020-06-20
## Changed
- foo
## Added
- bar
Если ваш процесс выпуска преобразует это в аннотированный тег, вы получите
- foo
- bar
В вашем теге, потому что заголовки видны git как комментарии. С setext такого не будет.
Хотя я предпочитаю ATX (как и многие другие) и скорее советую использовать это в процессе автоматизации.
вопрос не касался сообщений фиксации, но это имеет смысл. Спасибо за дополнение.
Я заметил, что немного не по теме, но я искал тех, кто сталкивался с этой проблемой. И это было самое близкое, что я мог найти на SO, где я смог поделиться своей текущей проблемой (которая, похоже, не стоит вопроса :))
Странный вопрос. Форматы ATX и SETEXT были источником вдохновения для Markdown, но они не используются в Markdown. Не могли бы вы уточнить свой вопрос?