mirror of
https://gitee.com/pnoker/iot-dc3.git
synced 2026-11-03 03:32:08 +08:00
pnoker
bca6d7aedc
Set up an end-to-end documentation site so contributors and users have a unified, searchable, and publishable entry point for project docs. - Add mkdocs.yml: Chinese-first language, light/dark palette, tabbed navigation, indexed sections, glightbox for diagrams, and pymdownx.snippets so community pages can pull from root governance files (CONTRIBUTING.md, CODE_OF_CONDUCT.md, SECURITY.md) without duplicating content. - Add requirements-docs.txt pinning mkdocs-material and mkdocs-glightbox. - Build the docs/ skeleton: index, quickstart, guide, architecture, development, modules, community. Migrate the seven generic manuals from dc3/doc/ (QUICKSTART, ENVIRONMENT, LOGGING, TROUBLESHOOTING, MODULES, DRIVER-AUTHORING, TESTING) and rewire their cross-doc links. CHANGE.md, TITLE.md, and USAGE.md stay in dc3/doc/ because docker-ci.yml depends on them; the docs site references them via mkdocs snippets to keep a single source of truth. - Add .github/workflows/docs.yml that builds with --strict on push to release and deploys via actions/deploy-pages. - Rewrite dc3/doc/README.md as a migration pointer to the new site and to the three retained release-flow files. Verification: mkdocs build --strict passes locally; snippets render correctly; GitHub Pages already enabled in workflow mode via gh api.
129 lines
3.2 KiB
YAML
129 lines
3.2 KiB
YAML
site_name: IoT DC3
|
|
site_description: 基于 Spring Cloud 的开源分布式物联网平台
|
|
site_url: https://pnoker.github.io/iot-dc3/
|
|
site_author: pnoker
|
|
copyright: Copyright © 2017-2026 pnoker. Licensed under AGPL-3.0.
|
|
|
|
repo_name: pnoker/iot-dc3
|
|
repo_url: https://github.com/pnoker/iot-dc3
|
|
edit_uri: edit/release/docs/
|
|
|
|
docs_dir: docs
|
|
site_dir: site
|
|
|
|
theme:
|
|
name: material
|
|
language: zh
|
|
logo: assets/images/logo-blue.zh.png
|
|
favicon: assets/images/logo-blue.zh.png
|
|
palette:
|
|
- media: "(prefers-color-scheme: light)"
|
|
scheme: default
|
|
primary: indigo
|
|
accent: indigo
|
|
toggle:
|
|
icon: material/weather-night
|
|
name: 切换到深色模式
|
|
- media: "(prefers-color-scheme: dark)"
|
|
scheme: slate
|
|
primary: indigo
|
|
accent: indigo
|
|
toggle:
|
|
icon: material/weather-sunny
|
|
name: 切换到浅色模式
|
|
features:
|
|
- navigation.tabs
|
|
- navigation.tabs.sticky
|
|
- navigation.sections
|
|
- navigation.indexes
|
|
- navigation.top
|
|
- navigation.footer
|
|
- search.suggest
|
|
- search.highlight
|
|
- search.share
|
|
- content.code.copy
|
|
- content.code.annotate
|
|
- content.action.edit
|
|
- content.tabs.link
|
|
- toc.follow
|
|
icon:
|
|
repo: fontawesome/brands/github
|
|
|
|
plugins:
|
|
- search:
|
|
lang:
|
|
- zh
|
|
- en
|
|
- glightbox:
|
|
touchNavigation: true
|
|
loop: false
|
|
effect: zoom
|
|
width: 90%
|
|
|
|
markdown_extensions:
|
|
- admonition
|
|
- attr_list
|
|
- md_in_html
|
|
- tables
|
|
- footnotes
|
|
- def_list
|
|
- toc:
|
|
permalink: true
|
|
permalink_title: 锚链接
|
|
- pymdownx.superfences:
|
|
custom_fences:
|
|
- name: mermaid
|
|
class: mermaid
|
|
format: !!python/name:pymdownx.superfences.fence_code_format
|
|
- pymdownx.tabbed:
|
|
alternate_style: true
|
|
- pymdownx.highlight:
|
|
anchor_linenums: true
|
|
line_spans: __span
|
|
pygments_lang_class: true
|
|
- pymdownx.inlinehilite
|
|
- pymdownx.snippets:
|
|
base_path:
|
|
- .
|
|
- docs
|
|
check_paths: true
|
|
- pymdownx.details
|
|
- pymdownx.tasklist:
|
|
custom_checkbox: true
|
|
- pymdownx.emoji:
|
|
emoji_index: !!python/name:material.extensions.emoji.twemoji
|
|
emoji_generator: !!python/name:material.extensions.emoji.to_svg
|
|
|
|
extra:
|
|
social:
|
|
- icon: fontawesome/brands/github
|
|
link: https://github.com/pnoker/iot-dc3
|
|
name: GitHub
|
|
- icon: fontawesome/brands/git-alt
|
|
link: https://gitee.com/pnoker/iot-dc3
|
|
name: Gitee
|
|
|
|
nav:
|
|
- 首页: index.md
|
|
- 快速开始:
|
|
- quickstart/index.md
|
|
- 环境变量: quickstart/environment.md
|
|
- 使用指南:
|
|
- guide/index.md
|
|
- 镜像与部署: guide/usage.md
|
|
- 日志规范: guide/logging.md
|
|
- 故障排查: guide/troubleshooting.md
|
|
- 架构:
|
|
- architecture/index.md
|
|
- 模块与依赖: architecture/modules.md
|
|
- 开发:
|
|
- development/index.md
|
|
- 驱动开发: development/driver-authoring.md
|
|
- 测试: development/testing.md
|
|
- 变更日志: development/changelog.md
|
|
- 模块: modules/index.md
|
|
- 社区:
|
|
- 贡献指南: community/contributing.md
|
|
- 行为准则: community/code-of-conduct.md
|
|
- 安全策略: community/security.md
|