markdown
Возник, страшно сказать, в 2004.
Связь с html, лучше понимать, во что конвертируется конкретный элемент разметки.
- https://daringfireball.net/projects/markdown/ - markdown (https://en.wikipedia.org/wiki/Markdown), https://www.markdownguide.org
- Кажется, самая давняя у меня ссылка про markdown с меткой времени: Daring Fireball: Markdown Syntax Documentation http://daringfireball.net/projects/markdown/syntax (2011-03-30 Срд 15:56) (2014-04-10 Чт 11:34)
- стартовое https://daringfireball.net/2004/03/introducing_markdown
- https://markdown-guide.readthedocs.io/en/latest/index.html – чей-то гайд.
- https://starkovden.github.io/More-about-Markdown.html – про маркдаун в документировании api :)
- https://metacpan.org/dist/Markdown-Perl/view/script/pmarkdown
- https://github.com/yshavit/mdq – типа, возможность выгрести и как-то обработать элементы из маркдауна. Типа, как jq для json.
- https://github.com/yshavit/mdq/wiki/Tutorial – тут в количестве примеров, что может.
- mdx
- якоря, там, где инструмент не делает автоякоря (и автоякоря так-то ненадёжны, поменяли заголовок или ешё что-то такое, и кранты) — html-ные:
<a id="my-anchor"></a>. Ссылка –[Anchor или якорь](#my-anchor).
Для emacs или опосредованно для него ж
- markdown-mode для emacs - https://github.com/jrblevin/markdown-mode, https://www.emacswiki.org/emacs/MarkdownMode, https://github.com/jrblevin/markdown-mode-guide -> https://leanpub.com/markdown-mode/read, https://jblevins.org/projects/markdown-mode/
- https://leanpub.com/markdown-mode/read#leanpub-auto-keeping-notes-in-a-local-wiki и следующий заголовок навели меня на мысель, что markdown-mode что-то типа минимального цеттеля позволяет при минимальной настройке.
- https://idiomdrottning.org/markdown-mode - прикопала на случай, если надо будет что-то много делать в markdown. 2023-11-15 Последнее время у меня либо конфлюенс, либо «как мне удобно», то есть оргмод.
- https://github.com/jasonm23/markdown-soma, https://github.com/jcs-elpa/impatient-showdown, https://github.com/ancane/markdown-preview-mode - пишуть, живой предпросмотр.
- https://github.com/artempyanykh/marksman — LSP-сервер Marksman для markdown.
- https://alexschroeder.ch/view/2024-07-23-eglot – про настройки eglot (в emacs) для этого.
- выделенное в markdown — M-| (shell-command-on-region). Команда:
pandoc -f html -t gfm, вместо gfm может быть другой знакомый pandoc диалект. Результат в новом буфере shell output. - ещё есть пакет html-to-markdown, работает похоже. Особенно если narrow применять перед тем, как что-то делать с буфером.
О диалектах
- https://fletcherpenney.net/multimarkdown/ - расширение к markdown, (https://en.wikipedia.org/wiki/MultiMarkdown)
- PHP markdown extra - https://michelf.ca/projects/php-markdown/extra/
- pandoc (конвертер между форматами), знает ряд вариантов, в т.ч.
- commonmark,
- gfm (GitHub-Flavored Markdown), or the deprecated and less accurate markdown_github; use markdown_github only if you need extensions not supported in gfm.
- markdown (Pandoc's Markdown)
- markdown_mmd (MultiMarkdown)
- markdown_phpextra (PHP Markdown Extra)
- markdown_strict (original unextended Markdown)
- https://kramdown.gettalong.org/ – рубёвая либа, которая поддерживает markdown с всякими занятными добавлениями
- https://github.com/mkende/pmarkdown – very configurable Markdown processor supporting the CommonMark spec and many extensions.
- https://mystmd.org/ – MyST, superset к commonmark.
- https://mystmd.org/guide/notebooks-with-markdown – замахиваются на исполняемость, подобно org-babel :)
commonmark
commonmark (CommonMark Markdown) - https://spec.commonmark.org/
Кажется, первая попытка стандарта, на которую много кто опирается.
yandex flavoured
Yandex Flavored markdown - https://ydocs.tech/ru/ → https://diplodoc.com/docs/ru/index-yfm, https://diplodoc.com/docs/ru/syntax/
Кажется, для меня загадка, как сделать тут комментарий. В смысле, в доке есть, но у меня почему-то не срабатывает). Зато можно переменные и ветвления. В результате в один документ можно засунуть несколько версий, задавать нужную настройками при сборке. Рассчитано на многофайловый проект. (Впечатление откуда-то из 2023)
- https://diplodoc.com/docs/ru/syntax/tables/multiline — тут есть про объединение ячеек в таблице.
- https://ydocs.tech/ru/project/toc#when - условия видимости разделов.
github flavoured
- Github Flavored markdown – https://github.github.com/gfm/
На базе commonmark.
gitlab flavoured
На основе commonmark и github flavoured, с особенностями
- https://docs.gitlab.com/user/markdown/
- https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/user/markdown.md#change-image-or-video-dimensions некоторые образцы отображения
- https://github.com/gjtorikian/html-pipeline/blob/v2.12.3/lib/html/pipeline/sanitization_filter.rb#L42 – что отфильтровывают на gitlab
- https://docs.gitlab.com/administration/integration/plantuml/#include-diagram-files
- https://docs.gitlab.com/user/markdown/#diagrams-and-flowcharts
- https://docs.gitlab.com/user/markdown/#collapsible-section
- https://docs.gitlab.com/user/project/wiki/markdown/ — конкретно для вики
- https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/details — удобный html-ик, о нем же с другого боку https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/summary
Линтеры и форматтеры
- https://github.com/DavidAnson/markdownlint - проверялка корректности разметки, Node.js.
- https://github.com/markdownlint/markdownlint - аналогично, но на руби. 2023-11-07 - обнаружился в репозитории дебиана.
- https://github.com/webhintio/markdown-link-validator – проверялка ссылок.
- https://github.com/notslang/markdown-styleguide - типа, рекомендации по красивой разметке. И https://github.com/notslang/tidy-markdown - типа, наводилка красоты в соответствии.
- https://github.com/shurcooL/markdownfmt - и ещё.
- https://github.com/executablebooks/mdformat и https://mdformat.rtfd.io/, https://mdformat.readthedocs.io/en/stable/users/installation_and_usage.html – opinionated Markdown formatter that can be used to enforce a consistent style in Markdown files. Судя по https://mdformat.readthedocs.io/en/stable/users/installation_and_usage.html, умеет ряд плагинов.
Минусы маркдауна по мне
- невозможность семантической разметки.
- рассыпание ссылок
Таблицы
- https://habr.com/ru/articles/836620/ — соображения про неудобство таблиц. В комментариях хвалят asciidoc.
- https://github.com/tgrosinger/md-advanced-tables – тоже про таблицы, но про другое. В принципе, почти аналог оргмодных таблиц получается.
- https://github.com/smartboyathome/Markdown-GridTables/blob/master/mdx_grid_tables.py — вариант таблиц для markdown.
Курсы
Внезапно на степике есть курсы по Markdown.
