n8n-docs/mkdocs.yml at main · yepcode/n8n-docs · 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
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
site_name: n8n Documentation
theme:
  name: material
  custom_dir: overrides
  favicon: _images/favicon.ico
  font: false
  language: en
  logo: _images/n8n-docs-icon.svg
  palette:
      scheme: light
  features:
    # https://squidfunk.github.io/mkdocs-material/reference/code-blocks/#code-annotations
    - content.code.annotate
    # https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/?h=navigation+tabs#navigation-tabs
    - navigation.tabs
    - navigation.tabs.sticky
    # https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/?h=navigation+tabs#anchor-tracking
    - navigation.tracking
# https://squidfunk.github.io/mkdocs-material/customization/?h=#additional-css
extra_css:
  - _extra/css/extra.css
# https://squidfunk.github.io/mkdocs-material/customization/?h=#additional-javascript
extra_javascript:
  - _extra/javascript/extra.js
markdown_extensions:
  # https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/?h=attr#attribute-lists attr_list is required for several other features. Always enable.
  - attr_list
  # https://squidfunk.github.io/mkdocs-material/reference/admonitions/?h=admoni
  - admonition
  # https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#superfences Superfences is required for several other features. Always enable.
  - pymdownx.superfences
  # https://squidfunk.github.io/mkdocs-material/reference/images/
  - md_in_html
  - pymdownx.details
  # https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#superfences Used for tags, setting unique templates for certain pages, and other custom frontmatter.
  - meta
  - pymdownx.details
  # https://squidfunk.github.io/mkdocs-material/reference/icons-emojis/
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg
  # https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#highlight
  - pymdownx.highlight:
      linenums: true
  # https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#superfences Superfences is required for several other features. Always enable.
  - pymdownx.superfences
  - pymdownx.tasklist:
      custom_checkbox: true
  # https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#inlinehilite
  - pymdownx.inlinehilite
  # https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#snippets
  - pymdownx.snippets
  # https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#tabbed
  - pymdownx.tabbed:
      alternate_style: true
  - tables
  # https://www.mkdocs.org/user-guide/writing-your-docs/#linking-to-pages
  - toc:
      permalink: "#"
plugins:
  - search
  # https://github.com/oprypin/mkdocs-literate-nav
  - literate-nav
nav:
  - Using n8n:
    - Welcome: index.md
    - Try it out:
      - Overview: try-it-out/index.md
      - A very quick quickstart: try-it-out/quickstart.md
      - A longer introduction: try-it-out/longer-introduction.md
    - Editor UI: editor-ui.md
    - Understand workflows:
      - Overview: workflows/index.md
      - Workflows: workflows/workflows.md
      - Connections: workflows/connections.md
      - Nodes: workflows/nodes.md
      - Items: workflows/items.md
      - Sticky Notes: workflows/sticky-notes.md
    - Flow logic:
      - Overview: flow-logic/index.md
      - Merging: flow-logic/merging.md
      - Looping: flow-logic/looping.md
      - Error handling: flow-logic/error-handling.md
    - Data:
      - Overview: data/index.md
      - Data structure: data/data-structure.md
      - Transforming data: data/transforming-data.md
      - Using code: data/code.md
      - Data mapping: data/data-mapping.md
      - Data pinning: data/data-pinning.md
      - Data editing: data/data-editing.md
    - Code examples:
      - Overview: code-examples/index.md
      - Expressions:
        - Overview: code-examples/expressions/index.md
        - Methods: code-examples/expressions/methods.md
        - Variables: code-examples/expressions/variables.md
        - Date and time with Luxon: code-examples/expressions/luxon.md
        - JSON with JMESPath: code-examples/expressions/jmespath.md
      - JavaScript for workflows:
        - Overview: code-examples/javascript-functions/index.md
        - Methods: code-examples/javascript-functions/methods.md
        - Variables: code-examples/javascript-functions/variables.md
        - Date and time with Luxon: code-examples/javascript-functions/luxon.md
        - JSON with JMESPath: code-examples/javascript-functions/jmespath.md
        - Get number of items returned by last node: code-examples/javascript-functions/number-items-last-node.md
        - Split binary file data into individual items: code-examples/javascript-functions/split-binary-file-data.md
        - Get the binary data buffer: code-examples/javascript-functions/get-binary-data-buffer.md
        - Check incoming data: code-examples/javascript-functions/check-incoming-data.md
    - Reference:
      - Overview: reference/index.md
      - Release notes: reference/release-notes.md
      - CLI commands: reference/cli-commands.md
      - Keyboard shortcuts: reference/keyboard-shortcuts.md
      - Glossary: reference/glossary.md
      - License: reference/license.md
      - Data collection: reference/data-collection.md
  - Integrations:
    - Overview: integrations/index.md
    - Built-in nodes:
      - Overview: integrations/builtin/index.md
      - Core nodes: integrations/builtin/core-nodes/
      - App nodes: integrations/builtin/app-nodes/
      - Trigger nodes: integrations/builtin/trigger-nodes/
      - Credentials: integrations/builtin/credentials/
    - Custom API actions for existing nodes: integrations/custom-operations.md
    - Community nodes:
      - Overview: integrations/community-nodes/index.md
      - Installation and management: integrations/community-nodes/installation.md
      - Risks: integrations/community-nodes/risks.md
      - Blocklist: integrations/community-nodes/blocklist.md
      - Using community nodes: integrations/community-nodes/usage.md
      - Troubleshooting: integrations/community-nodes/troubleshooting.md
      - Building community nodes: integrations/community-nodes/build-community-nodes.md
    - Creating nodes:
      - Overview: integrations/creating-nodes/index.md
      - Plan your node:
        - Overview: integrations/creating-nodes/plan/index.md
        - Choose a node building style: integrations/creating-nodes/plan/choose-node-method.md
        - Node UI design: integrations/creating-nodes/plan/node-ui-design.md
        - Choose node file structure: integrations/creating-nodes/build/reference/node-file-structure.md
      - Build your node:
        - Overview: integrations/creating-nodes/build/index.md
        - Set up your development environment: integrations/creating-nodes/build/node-development-environment.md
        - "Tutorial: Build a declarative-style node": integrations/creating-nodes/build/declarative-style-node.md
        - Reference:
          - Overview: integrations/creating-nodes/build/reference/index.md
          - Node UI elements: integrations/creating-nodes/build/reference/ui-elements.md
          - Code standards: integrations/creating-nodes/build/reference/code-standards.md
          - Versioning: integrations/creating-nodes/build/reference/node-versioning.md
          - File structure: integrations/creating-nodes/build/reference/node-file-structure.md
          - Base files: integrations/creating-nodes/build/reference/node-base-files.md
          - Codex files: integrations/creating-nodes/build/reference/node-codex-files.md
          - Credentials files: integrations/creating-nodes/build/reference/credentials-files.md
          - HTTP request helpers: integrations/creating-nodes/build/reference/http-helpers.md
          - Paired items: integrations/creating-nodes/build/reference/paired-items.md
      - Test your node:
        - Overview: integrations/creating-nodes/test/index.md
        - Run your node locally: integrations/creating-nodes/test/run-node-locally.md
        - Node linter: integrations/creating-nodes/test/node-linter.md
        - Troubleshooting: integrations/creating-nodes/test/troubleshooting-node-development.md
      - Deploy your node:
        - Overview: integrations/creating-nodes/deploy/index.md
        - Submit community nodes: integrations/creating-nodes/deploy/submit-community-nodes.md
        - Install private nodes: integrations/creating-nodes/deploy/install-private-nodes.md
  - Hosting n8n:
    - Overview: hosting/index.md
    - Installation and hosting options: hosting/options.md
    - Installation:
      - Overview: hosting/installation/index.md
      - Desktop app: hosting/installation/desktop-app.md
      - npm: hosting/installation/npm.md
      - Docker: hosting/installation/docker.md
      - Cloud: hosting/installation/cloud.md
    - Configuration: hosting/configuration.md
    - Environment variables: hosting/environment-variables.md
    - User management: hosting/user-management.md
    - Security: hosting/security.md
    - Logging: hosting/logging.md
    - Server setups:
      - Overview: hosting/server-setups/index.md
      - Docker Compose: hosting/server-setups/docker-compose.md
      - Caddy: hosting/server-setups/caddy.md
    - Databases:
      - Overview: hosting/databases/index.md
      - Supported databases and settings: hosting/databases/supported-databases-settings.md
      - Database structure: hosting/databases/structure.md
    - Updating:
      - Overview: hosting/updating/index.md
      - npm: hosting/updating/npm.md
      - Docker: hosting/updating/docker.md
      - Desktop app: hosting/updating/desktop.md
      - Cloud: hosting/updating/cloud.md
    - Scaling:
      - Overview: hosting/scaling/index.md
      - Execution data: hosting/scaling/execution-data.md
      - Execution modes and processes: hosting/scaling/execution-modes-processes.md
      - Configuring queue mode: hosting/scaling/queue-mode.md
  - API:
    - The n8n public API: api/index.md
    - Authentication: api/authentication.md
    - Pagination: api/pagination.md
    - Using the API playground: api/using-api-playground.md
    - API reference: api/api-reference.md
  - Embed:
    - n8n Embed: embed/index.md
    - Prerequisites: embed/prerequisites.md
    - Deployment: embed/deployment.md
    - Configuration: embed/configuration.md
    - Workflow management: embed/managing-workflows.md
    - Workflows templates: embed/workflow-templates.md
  - Courses:
      - Overview: courses/index.md
      - Level one:
        - Overview: courses/level-one/index.md
        - Navigating the editor UI: courses/level-one/chapter-1.md
        - Building a mini-workflow: courses/level-one/chapter-2.md
        - Automating a (real-world) use case: courses/level-one/chapter-3.md
        - Designing the workflow: courses/level-one/chapter-4.md
        - Building the workflow:
          - Getting data from the data warehouse: courses/level-one/chapter-5/chapter-5.1.md
          - Inserting data into airtable: courses/level-one/chapter-5/chapter-5.2.md
          - Filtering orders: courses/level-one/chapter-5/chapter-5.3.md
          - Setting values for processing orders: courses/level-one/chapter-5/chapter-5.4.md
          - Calculating booked orders: courses/level-one/chapter-5/chapter-5.5.md
          - Notifying the team: courses/level-one/chapter-5/chapter-5.6.md
          - Scheduling the workflow: courses/level-one/chapter-5/chapter-5.7.md
          - Activating and examining the workflow: courses/level-one/chapter-5/chapter-5.8.md
        - Exporting and importing workflows: courses/level-one/chapter-6.md
        - Test your knowledge: courses/level-one/chapter-7.md
      - Level two:
        - Overview: courses/level-two/index.md
        - Understanding the data structure: courses/level-two/chapter-1.md
        - Processing different data types: courses/level-two/chapter-2.md
        - Merging and splitting data: courses/level-two/chapter-3.md
        - Dealing with errors in workflows: courses/level-two/chapter-4.md
        - Automating a business workflow:
          - Use case: courses/level-two/chapter-5/chapter-5.0.md
          - Workflow 1: courses/level-two/chapter-5/chapter-5.1.md
          - Workflow 2: courses/level-two/chapter-5/chapter-5.2.md
          - Workflow 3: courses/level-two/chapter-5/chapter-5.3.md
        - Test your knowledge: courses/level-two/chapter-6.md
  - Contributing: contributing.md