melodyn
@melodyn
Лучше нативная смерть, чем фреймворковая жизнь.

Какие есть инструменты для markdown?

Есть задача по составлению документации проекта на Markdown. Первые очевидные проблемы:
1. Автоматизировать вставку содержания, кнопки "наверх" в конце страниц;
2. Автоматизированная навигация*;
3. Поддержка каких-нибудь фич, типа mermaid;
4. Таблицы, изображения, etc...

* под автоматизированной навигацией подразумевается, что в каталоге файлы расположены по алфавиту, а порядок чтения, естественно, иной. Поэтому я бы хотел добавлять снизу навигацию с кнопкой "далее" и "назад". Автоматизация нужна для тех случаев, когда поменялась структура каталогов и файлов или их имена.

Работаю в PhpStorm, он собственными силами немного облегчает жизнь, но этого не достаточно.

Если я правильно понимаю, то для моих задач подходит LaTeX Editor или, возможно, плагин плагин Markdown Navigator для Шторма.

Вопрос:
Те ли инструменты я выбрал и можете ли дополнить / предложить иное?
  • Вопрос задан
  • 445 просмотров
Решения вопроса 1
melodyn
@melodyn Автор вопроса
Лучше нативная смерть, чем фреймворковая жизнь.
Теперь я точно знаю, что плагин Markdown Navigator умеет формировать формировать оглавление автоматически, работает с Mermaid и вообще имеет много ништяков, так что оставил его, как основной инструмент.

С автонавигацией решил упороться самостоятельно или забить на неё, зависит от того, как пойдёт.
Ответ написан
Пригласить эксперта
Ответы на вопрос 3
alexgearbox
@alexgearbox
Вики с поддержкой маркдаун-разметки.
Ответ написан
Ranwise
@Ranwise
есть же системы для доков, например mkdocs, поищите аналоги, теоретически вам может подойти какой то генератор статических сайтов, сделаете свой шаблон
Ответ написан
eduardtibet
@eduardtibet
Technical Writer / Documentation Engineer
Если вам именно Маркдаун, посмотрите на проект Фолиант: https://github.com/foliant-docs/foliant
Ответ написан
Ваш ответ на вопрос

Войдите, чтобы написать ответ

Войти через центр авторизации
Похожие вопросы