Size: a a a

DocOps-сообщество

2019 December 01

NV

Nick Volynkin in DocOps-сообщество
Фичи вроде интерактивных примеров на JS наверняка уже реализованы там, либо есть плагин. В крайнем случае как виджеты от jsfiddle или подобного.
источник

NV

Nick Volynkin in DocOps-сообщество
Мобильная версия зависит от выбранной темы оформления. Это выбор уже после выбора SSG.

Пререндер HTML есть почти везде, на то они и static site generator'ы.

Метаданные в head есть везде, где можно редактировать шаблоны страниц, то есть во всех популярных SSG. А если нет, то вы их легко добавите, это должно быть несложной задачей.
источник

NV

Nick Volynkin in DocOps-сообщество
Место для чейнджлогов это просто страница.
источник

NV

Nick Volynkin in DocOps-сообщество
Егор Гуща
Подскажите, существует ли либа, которая будет соотвествовать этим требованиям?
или все же придется писать свое
— подсветка жс/тс
— возможность вывода всей доки единым списком (искать по страницам порой слишком долго)
— подсветка аннотаций оверлоадов
— возможность интеграции стороннего кода в разметку (встроить движок от репла для интерактивных примеров)
— место для чейнджлогов
— нормально расставленные мета-теги <head>
— нормальная мобильная версия
— пререндер html (не spa)
А вы хотите автогенерацию доки из кода? Вытащить классы и сигнатуры методов, прицепить к ним комментарии из кода, вот это всё?
источник

ЕГ

Егор Гуща in DocOps-сообщество
Nick Volynkin
А вы хотите автогенерацию доки из кода? Вытащить классы и сигнатуры методов, прицепить к ним комментарии из кода, вот это всё?
да, именно так
источник

ЕГ

Егор Гуща in DocOps-сообщество
docosaurus ужасен (для нас)
источник

NV

Nick Volynkin in DocOps-сообщество
А что используют для документирования стандартной библиотеки JS? Или для React?
источник

ЕД

Егор Доронин in DocOps-сообщество
Есть ещё highlight.js
источник

ЕГ

Егор Гуща in DocOps-сообщество
Nick Volynkin
А что используют для документирования стандартной библиотеки JS? Или для React?
Gitbook, docosaurus  это основные насколько мне известно еще vuepress есть
источник

NV

Nick Volynkin in DocOps-сообщество
Ага, сайт reactjs.org сделан на Gatsby. https://github.com/reactjs/reactjs.org#running-locally
источник
2019 December 03

NV

Nick Volynkin in DocOps-сообщество
👋
источник

KZ

Kate Ziateva in DocOps-сообщество
Всем привет!
источник
2019 December 10

AY

Andrei Yemelianov in DocOps-сообщество
Коллеги, привет! кто-нибудь писал panflute-фильтры для pandoc?
источник

NV

Nick Volynkin in DocOps-сообщество
Andrei Yemelianov
Коллеги, привет! кто-нибудь писал panflute-фильтры для pandoc?
Предлагаю тебе задать вопрос на StackOverflow и кинуть сюда ссылку :)
источник

SB

Sergey Bronnikov in DocOps-сообщество
Тьюториал по написанию документации для Unix - https://manpages.bsd.lv/mdoc.html
источник

iv

iakov v in DocOps-сообщество
Я предпочитаю писать man в Markdown и потом конвертировать в nroff с помощью pandoc :)
источник

iv

iakov v in DocOps-сообщество
Разметка типа mdoc и ms морально устарела :)
источник

СФ

Семён Факторович in DocOps-сообщество
в юниксе не ищут легких путей:)
источник

NV

Nick Volynkin in DocOps-сообщество
Жду дня, когда мы будем писать в какой-то ещё разметке и её конвертировать в Markdown.
источник

L

Lana in DocOps-сообщество
Nick Volynkin
Жду дня, когда мы будем писать в какой-то ещё разметке и её конвертировать в Markdown.
у меня уже такой день давно настал)
источник