Сборка и публикация документации

HTML¶

Выбор и настройка шаблона MkDocs¶

По умолчанию проект Foliant конвертируется в HTML с помощью шаблона mkdocs.

Чтобы сменить шаблон:

Выберите шаблон на странице MkDocs Themes.
Установите шаблон. Например, шаблон Materials:
```
pip install mkdocs-material
```
Откройте конфигурационный файл foliant.yml и добавьте строки:
```
theme:
  name: 'material'
```

Шаблон настраивается в файле foliant.yml. Описание параметров см. в документации для конкретного шаблона. Например, для шаблона Materials см. статью Getting Started.

При необходимости можно создать собственный шаблон. Подробнее см. статью Custom themes.

Локальная сборка сайта¶

Чтобы локально собрать сайт:

Выполните команду:
```
foliant make site --with mkdocs
```
В папке проекта создается папка "<Название проекта>.mkdocs".
Перейдите в папку с сайтом:
```
cd flnt-test.mkdocs
```
Запустите веб-сервер:
```
python -m http.server
```
В браузере откройте страницу: http://localhost:8000/.

Публикация на GitHub¶

Чтобы опубликовать сайт на GitHub:

Откройте настройки репозитория и перейдите в раздел Danger Zone.
Убедитесь, что ваш репозиторий публичный. Если нет, нажмите на кнопку Make public.
Перейдите в раздел GitHub Pages и в выпадающем списке Source выберите ветку gh-pages branch.
Выполните команду:
```
foliant make ghp -p \my-project
```

PDF¶

md-to-pdf¶

Библиотека md-to-pdf генерирует PDF-файлы, которые можно настроить с помощью CSS и highlight.js.

Чтобы создать PDF-файл, выполните команду:

foliant make pdf --with mdtopdf

Pandoc¶

Pandoc — универсальная утилита для работы с текстовыми форматами.

Чтобы создать PDF-файл, выполните команду:

foliant make pdf -p \my-project --with pandoc

DOCX¶

DOCX-файлы создаются с помощью Pandoc.

Чтобы создать DOCX-файл, выполните команду:

foliant make docx -p my-project