style(docs): привести разметку markdown к rumdl - #195
Open
mokevnin wants to merge 2 commits into
Open
Conversation
Автофикс rumdl по 88 файлам: маркеры списков, курсив подчёркиванием, пустые строки у заголовков и блоков кода, отступы вложенных списков, выравнивание колонок таблиц. Правила и конфигурация живут в hexlet-exercise-kit (docs/markdown-lint-sweep.md, .rumdl.toml), справка входит в объём кампании. Кроме механики: - в четырнадцати статьях было по два и более заголовка первого уровня, из-за чего разделы вроде «Виды ошибок» и «Отладка кода» рендерились как ещё один заголовок страницы. Всё, что ниже первого, понижено на уровень, вложенность сохранена — заодно эти разделы попадают в боковое оглавление; - kak-pomenyat-yazyk-na-saite: «Важный момент» из жирной строки в заголовок; - sposoby-oplaty: третьи «Условия» вложены под «Т-банк Кредит Брокер», иначе два одноимённых заголовка стояли на одном уровне; - asinhronnyi-format: ссылка на статью о сроках обучения записана относительным путём от файла, как её разбирает Docusaurus. MD025 при этом настроен не считать заголовком `title:` из frontmatter: на странице `<h1>` ровно один, а `title` уходит в метаданные и боковое меню.
MD034 обернул голые адреса и почту в угловые скобки, а Docusaurus 3 компилирует `.md` как MDX, где угловая скобка открывает JSX-тег. Сборка падала на `<b2b@hexlet.io>`: «Unexpected character `@` (U+0040) in name, expected a name character». Автоссылок на main не было ни одной, то есть форма пришла с этой правкой. Адреса возвращены в голый вид, как и были. Правило выключено для справки в `.rumdl.toml` кита (`per-file-ignores`), чтобы следующий прогон его не вернул.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Часть кампании по разметке markdown во всём контенте Хекслета: регламент и конфигурация правил лежат в
hexlet-exercise-kit(docs/markdown-lint-sweep.md,.rumdl.toml), справка входит в объём.Механика
Автофикс
rumdlпо 88 файлам: маркеры списков, курсив подчёркиванием, пустые строки у заголовков и блоков кода, отступы вложенных списков, выравнивание колонок таблиц. Второй прогон автофикса пустой — инструмент сошёлся сам с собой.Кроме механики
kak-pomenyat-yazyk-na-saite: «Важный момент» из жирной строки в заголовок.sposoby-oplaty: третьи «Условия» вложены под «Т-банк Кредит Брокер» — раньше два одноимённых заголовка стояли на одном уровне.asinhronnyi-format: ссылка на статью о сроках обучения записана относительным путём от файла, как её разбирает Docusaurus.Про frontmatter
MD025 настроен не считать заголовком
title:из frontmatter. Проверено на живой странице:<h1>там ровно один, аtitleуходит в метаданные и боковое меню. Без этой настройки правило объявляло дублем каждый заголовок страницы.Проверки
rumdl checkчистый, второй прогонrumdl fmtпустой;