Add comprehensive documentation for SnapForm features and workflows
Some checks failed
构建扩展 / build (push) Failing after 24s
Some checks failed
构建扩展 / build (push) Failing after 24s
- Introduced new guides for Depth Plane, Surface, and animation workflows. - Added installation instructions and FAQs to assist users in setup and troubleshooting. - Created a quick-start guide for first-time users to convert images to Depth Planes. - Documented the process for removing backgrounds from images. - Established a models and storage section to clarify data management. - Included a stylesheets file for improved documentation styling. - Updated mkdocs configuration for better navigation and theme settings.
This commit is contained in:
86
mkdocs.yml
Normal file
86
mkdocs.yml
Normal file
@@ -0,0 +1,86 @@
|
||||
site_name: SnapForm 文档
|
||||
site_url: https://docs.omoolab.xyz/snapform/
|
||||
site_author: OmooLab
|
||||
site_description: SnapForm 是一款将图片、视频和序列帧转换为立体面片的 Blender 扩展。
|
||||
|
||||
repo_name: OmooLab/SnapForm
|
||||
repo_url: https://git.omoolab.xyz/icrdr/SnapForm
|
||||
|
||||
nav:
|
||||
- SnapForm:
|
||||
- index.md
|
||||
- 开始使用:
|
||||
- 安装与首次配置: installation.md
|
||||
- 五分钟上手: quick-start.md
|
||||
- 使用指南:
|
||||
- 选择转换方式: workflows.md
|
||||
- Depth Plane: guide-depth-plane.md
|
||||
- Surface: guide-surface.md
|
||||
- 去除背景: remove-background.md
|
||||
- 视频与序列帧: animation.md
|
||||
- 模型、设备与存储: models-and-storage.md
|
||||
- 常见问题: faq.md
|
||||
- 参考与开发:
|
||||
- 功能参考: features.md
|
||||
- Depth Plane 实现: depth-plane.md
|
||||
- Surface 实现: surface.md
|
||||
- 输出格式: outputs.md
|
||||
- Job Server: server.md
|
||||
- 程序设计与开发: development.md
|
||||
|
||||
theme:
|
||||
name: material
|
||||
language: zh
|
||||
font:
|
||||
text: Open Sans
|
||||
code: Cascadia Code
|
||||
palette:
|
||||
- media: "(prefers-color-scheme)"
|
||||
primary: black
|
||||
toggle:
|
||||
icon: fontawesome/solid/circle-half-stroke
|
||||
name: 切换到浅色模式
|
||||
- media: "(prefers-color-scheme: light)"
|
||||
scheme: default
|
||||
primary: black
|
||||
toggle:
|
||||
icon: fontawesome/regular/moon
|
||||
name: 切换到深色模式
|
||||
- media: "(prefers-color-scheme: dark)"
|
||||
scheme: slate
|
||||
primary: black
|
||||
toggle:
|
||||
icon: fontawesome/solid/moon
|
||||
name: 跟随系统外观
|
||||
features:
|
||||
- header.autohide
|
||||
- navigation.footer
|
||||
- navigation.indexes
|
||||
- navigation.sections
|
||||
- navigation.tabs
|
||||
- navigation.tabs.sticky
|
||||
- navigation.top
|
||||
- search.highlight
|
||||
- search.suggest
|
||||
- content.code.copy
|
||||
|
||||
extra:
|
||||
version:
|
||||
provider: mike
|
||||
|
||||
extra_css:
|
||||
- stylesheets/extra.css
|
||||
|
||||
copyright: Copyright © 2026 OmooLab
|
||||
|
||||
plugins:
|
||||
- search
|
||||
|
||||
markdown_extensions:
|
||||
- attr_list
|
||||
- md_in_html
|
||||
- admonition
|
||||
- pymdownx.details
|
||||
- pymdownx.superfences
|
||||
- pymdownx.tabbed:
|
||||
alternate_style: true
|
||||
Reference in New Issue
Block a user