flowllm/mkdocs.yml at main · FlowLLM-AI/flowllm · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
site_name: FlowLLM
site_url: https://flowllm-ai.github.io/flowllm/
site_description: "FlowLLM: Simplifying LLM-based HTTP/MCP Service Development"
repo_url: https://github.com/flowllm-ai/flowllm
repo_name: flowllm-ai/flowllm

theme:
  name: shadcn
  image: figure/logo.png
  show_stargazers: true
  locale: zh_CN

plugins:
  - search
  - excalidraw

nav:
  - 欢迎: index.md
  - 快速开始:
      - 安装: zh/guide/installation.md
      - 配置: zh/guide/config_guide.md
  - 学习资料分享:
      - HaluMem解读: zh/reading/20251114-halumem.md
      - Gemini-CLI上下文管理: zh/reading/20251113-gemini-cli-context-management.md
      - 上下文管理指南: zh/reading/20251110-manus-context-report.md
      - 上下文管理视频材料: zh/reading/20251110-manus-context-raw.md
  - 操作开发:
      - 操作介绍: zh/guide/op_introduction.md
      - 简单操作指南: zh/guide/async_op_minimal_guide.md
      - LLM 操作指南: zh/guide/async_op_llm_guide.md
      - 高级操作指南: zh/guide/async_op_advance_guide.md
      - 工具操作指南: zh/guide/async_tool_op_guide.md
      - File Tool Op 指南: zh/guide/file_tool_op_guide.md
      - 向量存储指南: zh/guide/vector_store_guide.md
  - 流程编排:
      - 流程指南: zh/guide/flow_guide.md
  - 服务使用:
      - HTTP 服务指南: zh/guide/http_service_guide.md
      - HTTP 流指南: zh/guide/http_stream_guide.md
      - MCP 服务指南: zh/guide/mcp_service_guide.md
      - CMD 服务指南: zh/guide/cmd_service_guide.md
      - 客户端指南: zh/guide/client_guide.md
  - 贡献:
      - 贡献指南: zh/guide/contribution.md

markdown_extensions:
  admonition:
  codehilite:
  fenced_code:
  footnotes:
  extra:
  pymdownx.blocks.details:
  pymdownx.tabbed:
  pymdownx.blocks.tab:
    combine_header_slug: true
    separator: ___
  pymdownx.progressbar:
  pymdownx.snippets:
  pymdownx.arithmatex:
    generic: true
  shadcn.extensions.echarts.alpha:
  shadcn.extensions.codexec:
  shadcn.extensions.iconify:

# pip install mkdocs-shadcn
# mkdocs build
# mkdocs serve
# mkdocs gh-deploy --force