docs: сайт документации на MkDocs Material

- Контент-дерево docs/: пользователь, REST API, библиотека, архитектура,
  разработчику, эксплуатация; навигация обязательна (strict-сборка).
- docs/agent/ и docs/standards/ из сайта исключены (exclude_docs),
  ссылки на них — внешние, на Gitea.
- Javadoc публичного API core попадает на сайт как docs/apidocs (gitignored).
This commit is contained in:
Pjandro
2026-11-22 21:39:08 +03:00
parent ae7c8b755a
commit b3511f8b74
27 changed files with 1616 additions and 0 deletions
+76
View File
@@ -0,0 +1,76 @@
site_name: «Word → PDF конвертер» — документация
site_description: "docx4j + Apache FOP на чистой Java: библиотека, REST API, веб-интерфейс"
docs_dir: docs
site_dir: site
exclude_docs: |
/agent/
/standards/
/requirements.txt
# javadoc-копия (docs/apidocs, заполняет docs-deploy) — статика вне навигации;
# её md-файлы (legal/*) mkdocs иначе показывает как страницы вне nav
not_in_nav: |
/apidocs/**/*.md
theme:
name: material
language: ru
palette:
- scheme: default
primary: indigo
toggle:
icon: material/weather-sunny
name: Тёмная тема
- scheme: slate
primary: indigo
toggle:
icon: material/weather-night
name: Светлая тема
features:
- navigation.sections
- navigation.top
- toc.follow
- search.suggest
markdown_extensions:
- admonition
- attr_list
- footnotes
- toc:
permalink: true
- pymdownx.details
- pymdownx.superfences
- pymdownx.highlight:
anchor_linenums: true
plugins:
- search:
lang: ru
nav:
- Главное: index.md
- Пользователю: user.md
- REST API:
- api/index.md
- Аутентификация: api/authentication.md
- Эндпоинт конвертации: api/convert-endpoint.md
- Коды ошибок: api/errors.md
- Лимиты: api/limits.md
- Примеры клиентов: api/examples.md
- Библиотека wordpdf-core:
- library/getting-started.md
- library/api.md
- library/dependencies.md
- Архитектура:
- architecture/overview.md
- architecture/doc-bridge.md
- architecture/charts.md
- architecture/fonts.md
- architecture/limitations.md
- Разработчику:
- development/setup.md
- development/testing.md
- development/contributing.md
- Эксплуатация:
- operations/stack.md
- operations/configuration.md
- operations/deployment.md
- operations/troubleshooting.md
- operations/docs-site.md
- "Отчёт: потребление памяти": MEM_USAGE_UPGRADE.md
- Внутренние справочники репозитория: internal-guides.md