Документация в формате Markdown

О шаблоне
Документация генерируется из одноименного раздела, объединяя по порядку все дочерние документа.

Как использовать этот шаблон
Название пунктов в разделе "Документация" рекомендуется давать на английском языке без пробелов и специальных символов, в конце не указывается расширение (.md и т.п.). Эти имена будут названиями файлов в скомпилированной документации.

В корневом разделе должен быть файл REDAME. Это основной файл документации. Как правило в него вносят навигационные ссылки на другие документы.

Каждый документ может быть в будущем перемещен, переименован или удален.

Техническое описание
Вставка текста в редактор из буфера обмена происходит без сохранения форматирование. Это создано для того, чтобы не повредить структуру документа при вставке из MS Word и страниц сайтов.

При редактировании документа, соответствующий пункт дерева рукописи подсвечивается красным. Это означает, что документ изменен и не сохранен.

Сохранение организовано автоматически в течение первых 10 секунд после внесения правки. Сохранённый документ подсвечивается зеленым. Благодаря этому Вы можете определить, в какие документы были внесены изменения в течение данной сессии.

Реализована защита от удаления. Документ после удаления отображается зачеркнутым и в компиляции не участвует. Позже Вы можете либо удалить документ навсегда, либо восстановить его.

Вкладка «Структура» содержит информационные заметки, с помощью которых возможно кратко изложить структуру текущей части, главы и т.п. Вкладка «Структура» раздела «Документация» может содержать краткую структуру всей документации.

Заметки являются дополнительным информационным функционалом для автора, в компиляции не участвуют.

Экспорт возможен в форматы: Markdown (MD), MS Word (DOCX), Open Document (ODT), Portable Document (PDF), простой текст (TXT), веб страницы (HTML) и электронная книга (EPUB, FB2).