finai-research/mkdocs.yml at main · csmar432/finai-research · 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
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
# mkdocs.yml — Documentation site configuration
# Built with Material for MkDocs

site_name: FinResearch Agent 文档
site_description: 经济金融领域 AI 学术研究工作流文档
site_author: FinAI Research Workflow Contributors
site_url: https://csmar432.github.io/finai-research

repo_name: csmar432/finai-research
repo_url: https://github.com/csmar432/finai-research
edit_uri: ""

site_dir: .site

docs_dir: docs

# Exclude internal plan documents and legacy files
exclude_docs: |
  README.md
  !tutorials/README.md
  plans/
  论文写作工作流使用指南.md
  zhihu-publish/


theme:
  name: material
  language: zh
  palette:
    - scheme: default
      primary: blue
      accent: blue
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: blue grey
      accent: blue
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.tabs
    - navigation.sections
    - toc.follow
    - content.code.copy
    - content.code.annotate

plugins:
  - search:
      lang:
        - en
        - zh
  - mkdocstrings:
      handlers:
        python:
          options:
            show_source: false

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.superfences
  - pymdownx.snippets
  - pymdownx.inlinehilite
  - admonition
  - pymdownx.details
  - tables
  - attr_list
  - md_in_html
  - pymdownx.mark
  - pymdownx.keys

nav:
  - Home: index.md
  - 快速入门:
      - 教程总览: tutorials/README.md
      - 安装配置: tutorials/01-quickstart.md
      - 金融研究报告: tutorials/02-financial-report.md
      - 研究方向设计: tutorials/03-research-directions.md
  - MCP 工具:
      - MCP 市场: tutorials/04-mcp-marketplace.md
      - 数据源参考: external_data_sources.md
  - 进阶:
      - 事件驱动研究: tutorials/05-event-driven-research.md
      - API 参考: api_reference.md
  - 项目:
      - 架构设计: ARCHITECTURE.md