Как стать автором
Поиск
Написать публикацию
Обновить

Простенький лендинг/wiki для вас и вашего проекта или как покорить Diplodoc'а и опубликовать на GitHub Pages

Уровень сложностиПростой
Время на прочтение8 мин
Количество просмотров2.1K
Всего голосов 4: ↑4 и ↓0+5
Комментарии6

Комментарии 6

Документация без версионирования - это не дело.

мы используем классический Markdown.

{% note info %}

И тут же лёгким движением руки Markdown превращается в чёрти что, не понимаемое никакими редакторами.

С выводами про классически Mardown поспешил, прошу прощения.

Данная конструкция создает следующую сноску:

Подробнее про синтаксис можно почитать здесь -> https://diplodoc.com/docs/ru/syntax/

Интересно. У меня нечто похожее работает на Hugo + docsy theme

  • Работа с изображениями - вставка картинок по ссылкам и локальных файлов

Документация - это про картинки \ схемы. Хотелось бы их вставлять в нативных форматах: visio, drawio, yEd и т.п. Как с этим?
Какие аналогичные проекты с поддержкой visio, drawio, yEd есть?

Еще не углубился поддерживаются ли нативные форматы. Уделю время и дополню статью примерами более функциональных возможностей.

Пока можете посмотреть на документацию Y.Cloud - https://github.com/yandex-cloud/docs, возможно, найдете примеры поддержки других форматов.

Зарегистрируйтесь на Хабре, чтобы оставить комментарий

Публикации