Implement documentation setup and Docker configuration for LWC project

This commit is contained in:
Даниил Грабарь
2026-05-20 13:49:21 +10:00
parent a06470c0c9
commit dedf3e3467
12 changed files with 704 additions and 16 deletions
+14
View File
@@ -0,0 +1,14 @@
FROM squidfunk/mkdocs-material
RUN apk add --no-cache \
cairo \
pango \
gdk-pixbuf \
libffi \
fontconfig \
ttf-dejavu \
gcc \
g++ \
musl-dev \
python3-dev \
&& pip install mkdocs-with-pdf \
&& apk del --no-cache gcc g++ musl-dev python3-dev
+28
View File
@@ -0,0 +1,28 @@
document.addEventListener("DOMContentLoaded", function () {
const btn = document.createElement("a");
btn.href = "/pdf/document.pdf";
btn.download = "lwc-documentation.pdf";
btn.title = "Скачать всю документацию в PDF";
btn.style.cssText = [
"position: fixed",
"bottom: 24px",
"right: 24px",
"z-index: 9999",
"background: var(--md-primary-fg-color, #1976d2)",
"color: #fff",
"padding: 12px 18px",
"border-radius: 24px",
"text-decoration: none",
"font-weight: 600",
"font-size: 14px",
"box-shadow: 0 3px 10px rgba(0,0,0,0.25)",
"display: flex",
"align-items: center",
"gap: 8px",
"transition: opacity .2s",
].join(";");
btn.innerHTML = "📄 Скачать PDF";
btn.onmouseenter = () => (btn.style.opacity = "0.85");
btn.onmouseleave = () => (btn.style.opacity = "1");
document.body.appendChild(btn);
});
+17
View File
@@ -0,0 +1,17 @@
# Welcome to MkDocs выq
For full documentation visit [mkdocs.org](https://www.mkdocs.org).
## Commands
* `mkdocs new [dir-name]` - Create a new project.
* `mkdocs serve` - Start the live-reloading docs server.
* `mkdocs build` - Build the documentation site.
* `mkdocs -h` - Print help message and exit.
## Project layout
mkdocs.yml # The configuration file.
docs/
index.md # The documentation homepage.
... # Other markdown pages, images and other files.
+54
View File
@@ -0,0 +1,54 @@
site_name: Документация LWC
site_description: Документация по использованию коллаборативного робота KUKA LBR iiwa 7 и его программированию в среде ROS 2.
site_author: Даниил Грабарь
theme:
name: material
language: ru
features:
- navigation.tabs
- navigation.tabs.sticky
- navigation.sections
- navigation.expand
- navigation.top
- search.highlight
plugins:
- search
- with-pdf:
author: Даниил Грабарь
cover_title: Документация LWC
cover_subtitle: KUKA LBR iiwa7 ROS2 Control Framework
output_path: pdf/document.pdf
extra_javascript:
- assets/pdf_button.js
markdown_extensions:
- admonition
- pymdownx.highlight
- pymdownx.superfences
nav:
- Главная: index.md
# - Обзор проекта:
# - Введение: overview/intro.md
# - Архитектура: overview/architecture.md
# - Зависимости: overview/dependencies.md
# - Установка:
# - Требования: install/requirements.md
# - ROS2: install/ros2.md
# - KUKA FRI: install/fri.md
# - Разработка:
# - Структура пакетов: dev/packages.md
# - Камеры RealSense: dev/realsense.md
# - Управление KUKA: dev/kuka.md
# - Сборка: dev/build.md
# - API:
# - Обзор: api/overview.md
# - Топики: api/topics.md
# - Сервисы: api/services.md