LeJob/mkdocs.yml at main · bachbouch/LeJob · 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
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
# Website Info
site_name: LaVague
site_url: https://docs.lavague.ai/en/latest/
site_author: LaVague

# Repository
repo_name: lavague-ai/LaVague
repo_url: https://github.com/lavague-ai/LaVague

# Configuration
theme:
  name: material
  custom_dir: docs/material_theme_customization
  features:
    - navigation.instant
    - search.highlight
    - content.tabs.link
    - navigation.sections
    - navigation.indexes

  logo: assets/logo.png
  favicon: assets/logo.png
  palette:
    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

  icon:
    admonition:
      note: material/pencil-circle # blue pencil
      abstract: material/list-box-outline
      info: material/information-outline
      tip: material/fire #green fire
      success: material/check
      question: material/help-circle
      warning: material/alert
      failure: material/window-close
      danger: material/lightning-bolt-circle
      bug: material/shield-bug
      example: material/test-tube
      quote: material/format-quote-close

# Plugins
plugins:
  - search
  - mkdocs-jupyter

# Customization
extra:
  homepage: https://lavague.ai
  social:
    - icon: fontawesome/brands/discord
      link: https://discord.gg/invite/SDxn9KpqX9
    - icon: fontawesome/brands/github
      link: https://github.com/lavague-ai/
    - icon: fontawesome/brands/linkedin
    - icon: fontawesome/brands/twitter

extra_css:
  - stylesheets/extra.css

extra_javascript:
  - "https://code.jquery.com/jquery-3.3.1.min.js"

# Extensions
markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - pymdownx.details
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.critic
  - pymdownx.highlight:
      use_pygments: true
      pygments_style: monokai
  - pymdownx.superfences

# Documentation tree
nav:
- 🏠 Home: 'index.md'

- ⚡ Getting Started:
  - Installation: 'docs/get-started/installation.md'
  - Quick tour: 'docs/get-started/quick-tour.md'
  - Gradio: 'docs/get-started/gradio.md'
  # - Under the hood: 'docs/get-started/under-the-hood.md'
  - Customization: 'docs/get-started/customization.md'

- 📚 Learn:
  - Architecture: 'docs/learn/architecture.md'
  - World Model: 'docs/learn/world-model.md'
  - Action Engine: 'docs/learn/action-engine.md'
  - Navigation Engine: 'docs/learn/navigation-engine.md'
  - Logger: 'docs/learn/local-log.md'
  - Drivers: 'docs/learn/browser-drivers.md'

# - 🤝 Integrations:
#   - Overview: 'docs/integrations/home.md'
#   - API:
#     - Azure OpenAI: 'docs/integrations/api/azure-openai.ipynb'
#     - HuggingFace: 'docs/integrations/api/hugging-face.ipynb'
#     - OpenAI: 'docs/integrations/api/openai.ipynb'
#     - Litellm: 'docs/integrations/api/litellm.ipynb'
#     - Groq: 'docs/integrations/api/groq.ipynb'
#     - Anthropic: 'docs/integrations/api/anthropic.ipynb'
#   - Local:
#     - DeepSeek Coder: 'docs/integrations/local/local-inference.ipynb'

# - 🌎 Word Model:

- ✅ Use cases:
  - Knowledge Retrieval:
    - Navigate through Notion: "docs/use-cases/notion.md"
  - Data Entry:
    - Fill out forms: "docs/use-cases/forms.md"

- 📝 End to end examples:
  - Automated job application: "docs/examples/job-application.md"
  - QA Automation: "docs/examples/qa-automation.md"

- 🤗 Contributing:
  - Home: "docs/contributing/contributing.md"
  - General guidelines: "docs/contributing/general.md"
  - Documentation: "docs/contributing/documentation.md"

- 🛠️ API reference:
  - API reference home: 'docs/core/index.html'