Docusaurus — помощник для сбора документации

 Публичный пост

Если вы когда-нибудь собирали документацию для пользователей (особенно если ваши пользователи это разработчики), вы знаете какая-то это боль.

Поэтому дико рекомендую docusaurus, он помогает собрать документацию для вашей библиотеки, сервиса, чего-угодно.

Работает шустро и быстро, большие возможности кастомизации.
По факту с ним занимаешься только написанием контента и всё, остальное он делает за тебя.

Моя любимая там возможность, это поддержка в маркдауне https://mermaid.js.org/ , что позволяет клёвые схемы описывать.

5 комментариев 👇
Nikolai Lopin Фронтендмейстер 3 марта 2023

Расскажи про свой опыт с ним!

Мы сейчас используем docz, но он почил в бозе

  Развернуть 1 комментарий

@lopin, Привет, давай я прям подробно и популярно расскажу, что у меня есть и как я его готовлю. Сегодня-завтра распишу и закину сюда

  Развернуть 1 комментарий

@lopin, у меня есть внутренний продукт: виджет, который открывается в iframe (с разной кастомизацией под сервис) и реакт-библиотека, которая является оберткой над этим iframe (общение окон, прокидывание параметров из пропсов в фрейм, разные прочие штуки)

Был сторибук для реакт обертки, но его как документацию использовать не очень, потому что нужна большая гибкость и возможность подробнее объяснить пользователю, что делать.

Соответственно с доказаурусом я рассказываю пользователям, как пользоваться продуктом.
Очень удобно писать mdx, показывать примеры, выводить таблицы.
У меня там в основном картинки и текст, есть немного кода, есть раздел с блогом. (Удобно, что можно по нажатию на карандаш в статье пойти в исходники и через интерфейс гитхаба можно тут же поправить что-то)

В пул реквесте собираю бетку и выкладываю в s3 в папку с номер пр, проверяю, что всё ок, вливаю и обновляю мастер.

В общих чертах как-то так, но я могу прям конкретнее ответить о том, что беспокоит, смело спрашивай)

  Развернуть 1 комментарий

@axaxaman, сейчас меня беспокоит, куда переехать с умершего docz

  Развернуть 1 комментарий

Разрабатываю свой пет-проджект, тоже выбрал docusaurus. Ждем гайд!

  Развернуть 1 комментарий

😎

Автор поста открыл его для большого интернета, но комментирование и движухи доступны только участникам Клуба

Что вообще здесь происходит?


Войти  или  Вступить в Клуб