poml/mkdocs.yml at main · microsoft/poml · GitHub - github.com

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
site_name: POML Documentation
site_url: https://microsoft.github.io/poml
repo_url: https://github.com/microsoft/poml
repo_name: microsoft/poml
edit_uri: edit/main/docs/

exclude_docs: |
  typescript/reference/README.md

hooks:
  - docs/hooks/commitlinks.py

theme:
  name: material
  custom_dir: docs/overrides
  logo: media/logo-64-white.png
  favicon: media/logo-16-purple.png
  features:
    - navigation.sections
    - navigation.instant
    - navigation.tracking
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.tooltips
  palette:
    - scheme: default
      primary: poml
      accent: poml
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: poml
      accent: poml
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
extra_css:
  - stylesheets/extra.css

extra_javascript:
  - https://cdnjs.cloudflare.com/ajax/libs/mermaid/10.6.1/mermaid.min.js

plugins:
  - search
  - git-revision-date-localized:
      enable_creation_date: true
      type: timeago
  - git-authors
  - timetoread
  - mkdocstrings:
      handlers:
        python:
          paths: [python]
          options:
            show_source: true
            show_root_heading: true
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            docstring_style: google
            heading_level: 2

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - admonition
  - pymdownx.details
  - pymdownx.tabbed:
      alternate_style: true
  - toc:
      permalink: true

nav:
  - Getting Started: index.md
  - Tutorial:
      - Quick Start: tutorial/quickstart.md
      - Travel Expense Agent:
          - Part 1 - Build Workflow: tutorial/expense_part1.md
          - Part 2 - Debug with VS Code Extension: tutorial/expense_part2.md
  - Language Spec:
      - Basic Syntax: language/basic.md
      - Template Engine: language/template.md
      - Meta: language/meta.md
      - Fine-grained Control:
          - White Space Control: language/white-space.md
          - Token Control: language/token.md
      - References:
          - Components: language/components.md
  - Visual Studio Code:
      - Overview: vscode/index.md
      - Features: vscode/features.md
      - Configuration: vscode/configuration.md
  - Python:
      - Overview: python/index.md
      - Tracing: python/trace.md
      - Integrations:
          - OpenAI: python/integration/openai.md
          - LangChain: python/integration/langchain.md
          - MCP: python/integration/mcp.md
          - MLflow: python/integration/mlflow.md
          - AgentOps: python/integration/agentops.md
          - Weave: python/integration/weave.md
      - References:
          - Core: python/reference/core.md
          - Integration: python/reference/integration.md
          - Prompt: python/reference/prompt.md
  - TypeScript:
      - Overview: typescript/index.md
      - References:
          - index: typescript/reference/index.md
          - base: typescript/reference/base.md
          - cli: typescript/reference/cli.md
          - essentials: typescript/reference/essentials.md
          - file: typescript/reference/file.md
          - writer: typescript/reference/writer.md
          - components: typescript/reference/components.md
  - Deep Dive:
      - IR Specification: deep-dive/ir.md
      - Proposals:
          - Extended POML: deep-dive/proposals/poml_extended.md
  - Miscellaneous:
      - Contributing: contributing.md

extra:
  version:
    provider: mike
    default: stable