wxpath/mkdocs.yml at main · rodricios/wxpath · 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
site_name: wxpath
site_description: Declarative web crawling with XPath
site_author: Rodrigo Palacios
site_url: https://rodricios.github.io/wxpath/

repo_name: wxpath
repo_url: https://github.com/rodricios/wxpath

theme:
  name: material
  font:
    text: 'Courier New'
    code: 'Courier New'
  palette:
    - scheme: default
      primary: green
      accent: green
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: green
      accent: lime
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.code.annotate

dev_addr: 127.0.0.1:8000

# Resize workflow: put large images in docs/assets/images-large/;
# the plugin resizes them and writes to docs/assets/images/.
plugins:
  - search
  - glightbox
  - resize-images:
      source-dir: images-large
      target-dir: images
      size: [800, 600]
      enable_cache: true
  - macros:
      module_name: docs/macros
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: google
            show_source: true
            show_root_heading: true
            show_root_full_path: false

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - admonition
  - pymdownx.details
  - attr_list
  - md_in_html
  - toc:
      permalink: true

nav:
  - Home: index.md
  - Getting Started: getting-started.md
  - User Guide:
      - Language Design: guide/language-design.md
      - CLI: guide/cli.md
      - Configuration: guide/configuration.md
      - Hooks: guide/hooks.md
      # - Caching: guide/caching.md
  - TUI:
    - Quickstart: tui/quickstart.md
    - Overview: tui/index.md
  - API Reference:
      - Overview: api/index.md
      - Core:
          - Overview: api/core/index.md
          - Engine: api/core/engine.md
          # - Parser: api/core/parser.md
          # - Models: api/core/models.md
          - Operations: api/core/ops.md
          # - DOM Utilities: api/core/dom.md
      - HTTP:
          - Overview: api/http/index.md
          - Crawler: api/http/crawler.md
#           - Request: api/http/request.md
#           - Response: api/http/response.md
#           - Cache: api/http/cache.md
#           - Policy:
#               - Retry: api/http/policy/retry.md
#               - Robots: api/http/policy/robots.md
#               - Throttler: api/http/policy/throttler.md
#               - Backoff: api/http/policy/backoff.md
#           - Stats: api/http/stats.md
#       - Hooks:
#           - Overview: api/hooks/index.md
#           - Registry: api/hooks/registry.md
#           - Built-in Hooks: api/hooks/builtin.md
#       - Utilities:
#           - Logging: api/util/logging.md
#           - Serialize: api/util/serialize.md
      - Integrations:
          - LangChain: api/integrations/langchain.md
      - Settings: api/settings.md
  - Examples: examples.md

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/rodricios/wxpath

extra_css:
  - assets/matrix-theme.css