quantdb/mkdocs.yml at main · franksunye/quantdb · 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
site_name: QuantDB
site_description: High-performance stock data toolkit with intelligent AKShare caching (import as 'qdb')
site_url: https://franksunye.github.io/quantdb/
repo_url: https://github.com/franksunye/quantdb
repo_name: franksunye/quantdb
copyright: "Copyright © 2025 Ye Sun"

use_directory_urls: true

theme:
  name: material
  language: en
  features:
    - navigation.tabs
    - navigation.instant
    - content.code.copy
    - search.suggest
    - search.highlight

plugins:
  - search

markdown_extensions:
  - admonition
  - toc:
      permalink: true
  - codehilite
  - tables

extra:
  analytics:
    provider: google
    property: G-RFT3ZQSRX2  # TODO: Replace with actual GA4 property ID
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/franksunye/quantdb
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/quantdb/
  generator: false

nav:
  - Home: index.md
  - Getting Started:
    - Get Started: get-started.md
    - User Guide: user-guide.md
  - API Reference:
    - Overview: api-reference.md
    - Detailed Reference: api-reference-detailed.md
  - Guides:
    - Overview: guides/index.md
    - Hong Kong Index Guide: guides/hong-kong-index-guide.md
    - Migration from AKShare: guides/migration_akshare_to_quantdb.md
  - AI Agent:
    - Overview: ai-agent/index.md
    - Developer Guide: ai-agent/developer-guide.md
    - API Schema: ai-agent/api-schema.md
  - Blog:
    - Overview: blog/index.md
    - Technical Deep Dive:
      - Performance Benchmark Report: blog/quantdb-performance-benchmark-report.md
      - Visual Performance Guide: blog/visual-guide-quantdb-performance-advantages.md
      - Architecture Analysis: blog/architecture-deep-dive.md
      - Performance Optimization: blog/performance-optimization-guide.md
    - Business Value & ROI:
      - Business Value Quantified: blog/business-value-quantified-time-cost-savings.md
    - User Guides:
      - Migration Guide: blog/migration-guide-practical.md
      - Performance Comparison: blog/performance-comparison-study.md
      - AKShare vs QuantDB: blog/akshare_vs_quantdb_performance_and_devexp.md
      - AKShare Performance Optimization: blog/akshare-performance-optimization.md
    - Industry Insights:
      - Future of Financial Data: blog/future-of-financial-data.md
  - FAQ: faq.md
  - Changelog: changelog.md