Разработка текстов

Markdown

Документация разрабатывается на языке разметки Markdown.

Подробнее о синтаксисе см. статьи:

• Официальный сайт
• Использование языка разметки Markdown для написания документации
• Markdown Cheatsheet
• Python-Markdown

Для работы с Markdown можно использовать любой текстовый редактор.

Visual Studio Code

При создание этого проекта использовался редактор Visual Studio Code с плагинами.

Полезные ссылки:

• Официальная документация;
• Вебинар "Настройте Visual Studio Code под свои предпочтения".

Плагины

Docs Authoring Pack

Набор плагинов содержит:

• Docs Markdown
• Docs Preview
• Docs YAML
• Docs Images
• Docs Metadata
• Docs Article Templates
• Docs Linting
• markdownlint
• Code Spell Checker
• LinkCheckMD

Документация: https://docs.microsoft.com/en-us/contribute/how-to-write-docs-auth-pack.

Для Markdown

• HTTP/s and relative link checker. Проверяет ссылки;
• Markdown All in One. Горячие клавиши, содержание, превью;
• Markdown Preview Enhanced. Превью;
• Markdown Table Formatter. Форматирование таблиц;
• Markdown Table Prettifier. Форматирование таблиц;
• markdownlint. Линтер;
• Vale. Линтер.

Для Git

• GitHub Pull Requests and Issues. Управляет ревью и пулл реквестами;
• GitLens — Git supercharged. Визуализирует изменения в коде.

Остальные

• colorize. Визуализирует CSS-цвета;
• Code Spell Checker. Проверяет орфографию;
• Russian - Code Spell Checker. Словарь русского языка для проверки орфографии;
• Docker;
• Draw.io Integration;
• LaTeX Workshop. Поддержка работы с LaTeX;
• PlantUML;
• Python;
• YAML.

Добавление страниц

Чтобы добавить страницу в проект Foliant:

1. Перейдите в папку src.
2. Создайте файл с расширением *.md.
3. Откройте конфигурационный файл foliant.yml.
4. Добавьте имя созданного файла в список chapters.