Files
Fu-Jie_openwebui-extensions/mkdocs.yml

215 lines
6.0 KiB
YAML
Raw Normal View History

# yaml-language-server: $schema=https://squidfunk.github.io/mkdocs-material/schema.json
# MkDocs Configuration for OpenWebUI Extras
# Site Information
site_name: OpenWebUI Extensions
site_description: A collection of enhancements, plugins, and prompts for OpenWebUI
site_author: Fu-Jie
site_url: https://fu-jie.github.io/openwebui-extensions/
# Repository
repo_name: Fu-Jie/openwebui-extensions
repo_url: https://github.com/Fu-Jie/openwebui-extensions
edit_uri: edit/main/docs/
# Copyright
copyright: Copyright © 2024 OpenWebUI Extensions Contributors
# Theme Configuration
theme:
name: material
language: en
# Logo and Icons
icon:
logo: material/robot-happy-outline
repo: fontawesome/brands/github
# Color Palette with Light/Dark Toggle
palette:
# Light mode
- media: "(prefers-color-scheme: light)"
scheme: default
primary: indigo
accent: blue
toggle:
icon: material/brightness-7
name: Switch to dark mode
# Dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: indigo
accent: blue
toggle:
icon: material/brightness-4
name: Switch to light mode
# Navigation Features
features:
- navigation.tabs
- navigation.tabs.sticky
- navigation.sections
- navigation.expand
- navigation.path
- navigation.top
- navigation.footer
- search.highlight
- search.suggest
- search.share
- content.code.copy
- content.code.annotate
- content.tabs.link
- toc.follow
# Custom fonts
font:
text: Roboto
code: Roboto Mono
# Plugins
plugins:
- search:
separator: '[\s\-,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
- i18n:
docs_structure: suffix
fallback_to_default: true
reconfigure_material: true
reconfigure_search: true
languages:
- locale: en
default: true
name: English
build: true
- locale: zh
name: 简体中文
build: true
nav_translations:
Home: 首页
Plugins: 插件
Actions: 动作
Filters: 过滤器
Pipes: 管道
Pipelines: 流水线
Prompts: 提示词
Enhancements: 增强功能
Development: 开发指南
Contributing: 贡献指南
Plugin Development Guide: 插件开发指南
Copilot Engineering Plan: Copilot 工程化配置
Documentation Guide: 文档编写指南
Smart Mind Map: 智能思维导图
Smart Infographic: 智能信息图
Flash Card: 闪记卡
Export to Excel: 导出到 Excel
Export to Word: 导出为 Word
Summary: 摘要
Async Context Compression: 异步上下文压缩
Context Enhancement: 上下文增强
Multi-Model Context Merger: 多模型上下文合并
Web Gemini Multimodal Filter: Web Gemini 多模态过滤器
MoE Prompt Refiner: MoE 提示词优化器
- minify:
minify_html: true
# Markdown Extensions
markdown_extensions:
# Python Markdown
- abbr
- admonition
- attr_list
- def_list
- footnotes
- md_in_html
- toc:
permalink: true
toc_depth: 3
# Python Markdown Extensions
- pymdownx.arithmatex:
generic: true
- pymdownx.betterem:
smart_enable: all
- pymdownx.caret
- pymdownx.details
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.inlinehilite
- pymdownx.keys
- pymdownx.magiclink:
normalize_issue_symbols: true
repo_url_shorthand: true
user: Fu-Jie
repo: openwebui-extensions
- pymdownx.mark
- pymdownx.smartsymbols
- pymdownx.snippets
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.tabbed:
alternate_style: true
combine_header_slug: true
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.tilde
# Extra Configuration
extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/Fu-Jie/openwebui-extensions
generator: false
# Analytics (optional - add your tracking ID)
# analytics:
# provider: google
# property: G-XXXXXXXXXX
# Extra CSS
extra_css:
- stylesheets/extra.css
# Navigation Structure
nav:
- Home: index.md
- Plugins:
- plugins/index.md
- Actions:
- plugins/actions/index.md
- Smart Mind Map: plugins/actions/smart-mind-map.md
- Smart Infographic: plugins/actions/smart-infographic.md
- Flash Card: plugins/actions/flash-card.md
- Export to Excel: plugins/actions/export-to-excel.md
- Export to Word: plugins/actions/export-to-word.md
- Filters:
- plugins/filters/index.md
- Async Context Compression: plugins/filters/async-context-compression.md
- Context Enhancement: plugins/filters/context-enhancement.md
- Multi-Model Context Merger: plugins/filters/multi-model-context-merger.md
- Web Gemini Multimodal Filter: plugins/filters/web-gemini-multimodel.md
- Pipes:
- plugins/pipes/index.md
- Pipelines:
- plugins/pipelines/index.md
- MoE Prompt Refiner: plugins/pipelines/moe-prompt-refiner.md
- Prompts:
- prompts/index.md
- prompts/library.md
- Enhancements:
- enhancements/index.md
- enhancements/guide.md
- Development:
- development/index.md
- Plugin Development Guide: development/plugin-guide.md
- Copilot Engineering Plan: development/copilot-engineering-plan.md
- Documentation Guide: development/documentation-guide.md
- Contributing: contributing.md