pipelex-api/mkdocs.yml at main · Pipelex/pipelex-api · 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
site_name: Pipelex API Documentation

site_url: https://pipelex.github.io/pipelex-api/
site_description: "Official API documentation for Pipelex - REST API for executing Pipelex pipelines and validating PLX files"
docs_dir: docs
repo_url: "https://github.com/Pipelex/pipelex"
repo_name: "Pipelex on GitHub"

theme:
  name: material
  favicon: https://pipelex-web.s3.amazonaws.com/logo/pipelex-favicon-32.png
  logo: https://pipelex-web.s3.amazonaws.com/logo/Pipelex-logo-wot-mono-560x176.png
  features:
    - navigation.footer
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.top
  palette:
    - scheme: default
      primary: teal
      accent: deep purple
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - scheme: slate
      primary: teal
      accent: purple
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode

copyright: "© 2025 Evotis S.A.S. <br/>Pipelex is a trademark of Evotis S.A.S."

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/Pipelex/pipelex
      name: Pipelex on GitHub
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/pipelex/
      name: pipelex on PyPI
    - icon: fontawesome/brands/twitter
      link: https://x.com/PipelexAI
      name: Pipelex on X
    - icon: fontawesome/brands/discord
      link: https://go.pipelex.com/discord
      name: Pipelex on Discord
  generator: false

plugins:
  - search
  - glightbox:
      touchNavigation: true
      loop: false
      effect: zoom
      slide_effect: slide
      width: 100%
      height: auto
      zoomable: true
      draggable: true
      auto_caption: false
      caption_position: bottom

markdown_extensions:
  - meta
  - attr_list
  - md_in_html
  - pymdownx.blocks.caption
  - pymdownx.highlight
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.snippets:
      base_path: .
  - admonition
  - pymdownx.details

extra_css:
  - stylesheets/mermaid.css
  - stylesheets/general.css

nav:
  - Home: https://docs.pipelex.com/
  - API:
    - Overview: index.md
    - Pipe Builder: pipe-builder.md
    - Pipe Run: pipe-run.md
    - Pipe Validate: pipe-validate.md
    - Contribute:
      - Contributing: contributing.md
      - Code of Conduct: CODE_OF_CONDUCT.md
      - License: license.md
    - Changelog: changelog.md
  - MCP: https://pipelex.github.io/pipelex-mcp/
  - n8n: https://pipelex.github.io/n8n-nodes-pipelex/
  - Contribute: https://docs.pipelex.com/pages/contributing/
  - Changelog: https://docs.pipelex.com/pages/changelog/