Кому це
Документація в Markdown без прибирання
Перенесення документації зазвичай означає, що ви конвертуєте HTML, а потім довше прибираєте те, що конвертер лишив. Прибирання – це саме те, заради чого зроблено Clean Clipper, і саме те, що виміряно на 512 сторінках.
Ціна ручного прибирання
Сторінка довідника приносить із собою бічне дерево розділів, перемикач версій, хлібні крихти, блок «чи була ця сторінка корисною» і підвал із трьома десятками посилань. У Markdown усе це лягає списками, які зовні не відрізняються від змісту. На двадцятій сторінці ви вже прибираєте автоматично й перестаєте помічати, що заодно викидаєте потрібне.
Далі йдуть дрібниці, які коштують найдорожче: врізки з попередженнями стають звичайними абзацами, огорожі коду втрачають мітку мови, таблиці параметрів розсипаються, а порожні заголовки від навігаційних блоків лишаються в структурі. Готовий набір після цього доводиться вичитувати повністю, і перенесення перетворюється на переписування.
Що змінюється
- Заголовки, списки, таблиці, блоки коду й виноски лягають у стандартний Markdown
- Мітки мови на блоках коду зберігаються: 73 блоки зі 156 проти 20 і 0 у порівнюваних рушіїв
- Нуль вцілілих тегів HTML на всіх 512 виміряних сторінках
- Бічну навігацію, хлібні крихти й перемикачі версій зрізано, а не сконвертовано
- Врізки й попередження стають цитатами – вміст лишається, коли формат не має для нього синтаксису
- Шаблон імені файлу й підтека тримають перенесений набір у порядку
## Автентифікація Кожен запит підписується токеном із заголовка `Authorization`. ```http POST /api/v1/auth/token Content-Type: application/json ``` > Токен живе 60 хвилин. Після цього потрібен окремий запит на оновлення. | Поле | Тип | Обов’язкове | | --- | --- | --- | | client_id | string | так | | client_secret | string | так |
Чого воно не робить
Обхідника сайтів тут немає взагалі: одна сторінка за раз, та, яку ви відкрили. Розширення не будує змісту й не переписує посилань між сторінками – після перенесення вони й далі ведуть на початковий сайт. Зображення й діаграми лишаються посиланнями, файли поруч не кладуться. Врізки, вкладки й розкривні блоки втрачають своє оформлення, бо в Markdown для них немає стандартного синтаксису.