Есть желание написать userguide (многостраничный туториал, не сгенерированная документация к проекту). Основные требования:
1. Возможность экспорта в HTML (онлайн-версия)/PDF (оффлайн).
2. Желательно, чтобы была основана на файлах. Хочу потом вынести тексты в гитхаб.
3. Достаточно будет оффлайна, т.к. писать буду один.
4. Если для этой программы существуют плагины для редакторов — вообще хорошо.
5. В тексте планируются изображения, вставки кода и прочие няшки. Хочется, чтобы это все в итоге выглядело красиво, без лишних телодвижений с моей стороны (ага, я ленивый).
Почему же двусмысленный?
Вполне однозначный: я считаю, что техническую документацию удобнее всего в латехе делать. Да и вообще все, чей объем больше двух страниц, надо верстать в латехе.
Другое дело, что есть еще средства автоматизации. Тот же doxygen, например, помогает немного упростить разработку документации (опять-таки, в латехе) к программному продукту.
1. Markdown — язык разметки, а не конечное ПО для создания документов. Могли бы по аналогии в свой ответ и «HTML» написать.
2. Emacs Org-mode больше подходит для органайзеров, чем для документации (ИМХО).
3. LaTeX, опять же, не конечно решение, а язык разметки. Да и синтаксис его лично для меня выглядит черезчур сложным для поставленной задачи. Markdown намного проще.
В целом, такого рода комменты — не то, чего хотелось бы видеть. У Вас есть опыт работы с подобными задачами? Что использовали, какие проблемы/плюсы/минусы и т.д.
6ю версию не смотрел (сегодня узнал, что она есть). 5ю пробовал, пользуюсь 4й (по внутренним причинам).
1. Да/Да и много еще чего.
2. Начиная с 5й можно хранить проект в XML. Совместную работу не пробовал, но изменения при коммите хорошо видно.
5. Шаблоны есть. Базовый для PDF мне подошел, вполне профессионально получилось.
Простой
