Jeicex commited on
Commit
0a84888
·
0 Parent(s):

Subindo documentação do n8n limpa

Browse files
This view is limited to 50 files because it contains too many changes.   See raw diff
Files changed (50) hide show
  1. .editorconfig +20 -0
  2. .gitattributes +59 -0
  3. .github/ISSUE_TEMPLATE/bug_report.md +24 -0
  4. .github/ISSUE_TEMPLATE/new-docs-request.md +19 -0
  5. .github/workflows/build-test.yml +39 -0
  6. .github/workflows/lexi.yml +18 -0
  7. .github/workflows/lint.yml +12 -0
  8. .github/workflows/lychee-pr-check.yml +37 -0
  9. .github/workflows/lychee.yml +20 -0
  10. .github/workflows/support.yml +30 -0
  11. .gitignore +23 -0
  12. .gitmodules +3 -0
  13. .vale.ini +9 -0
  14. CNAME +1 -0
  15. CODE_OF_CONDUCT.md +76 -0
  16. CONTRIBUTING.md +99 -0
  17. CONTRIBUTOR_LICENSE_AGREEMENT.md +5 -0
  18. LICENSE.md +230 -0
  19. README.md +72 -0
  20. _doctools/change_link_style.py +54 -0
  21. _doctools/pageinfo.py +94 -0
  22. _glossary/ai-glossary.md +7 -0
  23. _glossary/main.md +0 -0
  24. _overrides/404.html +31 -0
  25. _overrides/api.html +102 -0
  26. _overrides/main.html +156 -0
  27. _overrides/partials/actions.html +57 -0
  28. _overrides/partials/footer.html +62 -0
  29. _overrides/partials/header.html +136 -0
  30. _overrides/partials/javascripts/consent.html +87 -0
  31. _overrides/partials/languages/custom.html +12 -0
  32. _overrides/partials/sub-footer.html +365 -0
  33. _overrides/partials/tabs.html +16 -0
  34. _snippets/code/ai-how-to.md +14 -0
  35. _snippets/data-function-code/smartjoin.md +6 -0
  36. _snippets/data/data-mapping/item-linking-code-node.md +97 -0
  37. _snippets/data/data-mapping/item-linking-node-creators.md +34 -0
  38. _snippets/data/how-to-pin-data.md +8 -0
  39. _snippets/embed-license.md +3 -0
  40. _snippets/examples-color-key.md +12 -0
  41. _snippets/flow-logic/create-set-error-workflow.md +8 -0
  42. _snippets/flow-logic/data-flow-nodes.md +16 -0
  43. _snippets/flow-logic/subworkflow-data-flow.md +4 -0
  44. _snippets/flow-logic/subworkflow-usage.md +57 -0
  45. _snippets/integrations/builtin/app-nodes/ai-tools.md +3 -0
  46. _snippets/integrations/builtin/app-nodes/googlesheets/node-options.md +14 -0
  47. _snippets/integrations/builtin/app-nodes/operation-not-supported.md +11 -0
  48. _snippets/integrations/builtin/cluster-nodes/cluster-nodes-summary.md +3 -0
  49. _snippets/integrations/builtin/cluster-nodes/langchain-doc-loaders-link.md +1 -0
  50. _snippets/integrations/builtin/cluster-nodes/langchain-overview-link.md +1 -0
.editorconfig ADDED
@@ -0,0 +1,20 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ root = true
2
+
3
+ [*]
4
+ charset = utf-8
5
+ indent_style = tab
6
+ end_of_line = lf
7
+ indent_size = 4
8
+ insert_final_newline = true
9
+ trim_trailing_whitespace = false
10
+
11
+ [package.json]
12
+ indent_style = space
13
+ indent_size = 2
14
+
15
+ [*.yml]
16
+ indent_style = space
17
+ indent_size = 2
18
+
19
+ [*.ts]
20
+ quote_type = single
.gitattributes ADDED
@@ -0,0 +1,59 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ *.7z filter=lfs diff=lfs merge=lfs -text
2
+ *.arrow filter=lfs diff=lfs merge=lfs -text
3
+ *.bin filter=lfs diff=lfs merge=lfs -text
4
+ *.bz2 filter=lfs diff=lfs merge=lfs -text
5
+ *.ckpt filter=lfs diff=lfs merge=lfs -text
6
+ *.ftz filter=lfs diff=lfs merge=lfs -text
7
+ *.gz filter=lfs diff=lfs merge=lfs -text
8
+ *.h5 filter=lfs diff=lfs merge=lfs -text
9
+ *.joblib filter=lfs diff=lfs merge=lfs -text
10
+ *.lfs.* filter=lfs diff=lfs merge=lfs -text
11
+ *.lz4 filter=lfs diff=lfs merge=lfs -text
12
+ *.mds filter=lfs diff=lfs merge=lfs -text
13
+ *.mlmodel filter=lfs diff=lfs merge=lfs -text
14
+ *.model filter=lfs diff=lfs merge=lfs -text
15
+ *.msgpack filter=lfs diff=lfs merge=lfs -text
16
+ *.npy filter=lfs diff=lfs merge=lfs -text
17
+ *.npz filter=lfs diff=lfs merge=lfs -text
18
+ *.onnx filter=lfs diff=lfs merge=lfs -text
19
+ *.ot filter=lfs diff=lfs merge=lfs -text
20
+ *.parquet filter=lfs diff=lfs merge=lfs -text
21
+ *.pb filter=lfs diff=lfs merge=lfs -text
22
+ *.pickle filter=lfs diff=lfs merge=lfs -text
23
+ *.pkl filter=lfs diff=lfs merge=lfs -text
24
+ *.pt filter=lfs diff=lfs merge=lfs -text
25
+ *.pth filter=lfs diff=lfs merge=lfs -text
26
+ *.rar filter=lfs diff=lfs merge=lfs -text
27
+ *.safetensors filter=lfs diff=lfs merge=lfs -text
28
+ saved_model/**/* filter=lfs diff=lfs merge=lfs -text
29
+ *.tar.* filter=lfs diff=lfs merge=lfs -text
30
+ *.tar filter=lfs diff=lfs merge=lfs -text
31
+ *.tflite filter=lfs diff=lfs merge=lfs -text
32
+ *.tgz filter=lfs diff=lfs merge=lfs -text
33
+ *.wasm filter=lfs diff=lfs merge=lfs -text
34
+ *.xz filter=lfs diff=lfs merge=lfs -text
35
+ *.zip filter=lfs diff=lfs merge=lfs -text
36
+ *.zst filter=lfs diff=lfs merge=lfs -text
37
+ *tfevents* filter=lfs diff=lfs merge=lfs -text
38
+ # Audio files - uncompressed
39
+ *.pcm filter=lfs diff=lfs merge=lfs -text
40
+ *.sam filter=lfs diff=lfs merge=lfs -text
41
+ *.raw filter=lfs diff=lfs merge=lfs -text
42
+ # Audio files - compressed
43
+ *.aac filter=lfs diff=lfs merge=lfs -text
44
+ *.flac filter=lfs diff=lfs merge=lfs -text
45
+ *.mp3 filter=lfs diff=lfs merge=lfs -text
46
+ *.ogg filter=lfs diff=lfs merge=lfs -text
47
+ *.wav filter=lfs diff=lfs merge=lfs -text
48
+ # Image files - uncompressed
49
+ *.bmp filter=lfs diff=lfs merge=lfs -text
50
+ *.gif filter=lfs diff=lfs merge=lfs -text
51
+ *.png filter=lfs diff=lfs merge=lfs -text
52
+ *.tiff filter=lfs diff=lfs merge=lfs -text
53
+ # Image files - compressed
54
+ *.jpg filter=lfs diff=lfs merge=lfs -text
55
+ *.jpeg filter=lfs diff=lfs merge=lfs -text
56
+ *.webp filter=lfs diff=lfs merge=lfs -text
57
+ # Video files - compressed
58
+ *.mp4 filter=lfs diff=lfs merge=lfs -text
59
+ *.webm filter=lfs diff=lfs merge=lfs -text
.github/ISSUE_TEMPLATE/bug_report.md ADDED
@@ -0,0 +1,24 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ name: Bug report
3
+ about: Create a report to help us fix and improve docs
4
+ title: "[DOCS-ISSUE] - "
5
+ labels: bug
6
+ assignees: ''
7
+
8
+ ---
9
+
10
+ **NOTE!**
11
+
12
+ This is for issues with _documentation_ of **n8n**. If the problem you are having is actually a bug in the software, please [file a bug here instead](https://github.com/n8n-io/n8n/issues).
13
+
14
+ **Where is the bug/mistake?**
15
+ Please help us by pasting in the URL of the page or telling us the title.
16
+
17
+ **What problem did you find?**
18
+ A clear and concise description of what is wrong.
19
+
20
+ **Can you suggest a fix?**
21
+ For some issues, like a broken link, it will help us resolve them faster if you can indicate what you think the correct information would be.
22
+
23
+ **Additional context**
24
+ Add any other context about the problem here.
.github/ISSUE_TEMPLATE/new-docs-request.md ADDED
@@ -0,0 +1,19 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ name: New docs request
3
+ about: Suggest additional pages or information to improve docs
4
+ title: "[DOCS-REQUEST] - "
5
+ labels: enhancement
6
+ assignees: ''
7
+
8
+ ---
9
+
10
+ Thanks for helping us improve docs! Please give us as much information as you can about the changes you'd like to see.
11
+
12
+ **What information is missing?**
13
+
14
+
15
+ **Describe the page/pages you'd like**
16
+
17
+
18
+ **Additional context**
19
+ Add any other context or screenshots about the feature request here.
.github/workflows/build-test.yml ADDED
@@ -0,0 +1,39 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ name: Internal PR linkcheck
2
+ on:
3
+ pull_request:
4
+ branches:
5
+ - main
6
+ permissions:
7
+ contents: read
8
+ pull-requests: write
9
+ jobs:
10
+ link-check:
11
+ runs-on: ubuntu-latest
12
+
13
+ steps:
14
+ - name: Checkout repository
15
+ uses: actions/checkout@v4
16
+ - name: Setup Python
17
+ uses: actions/setup-python@v2
18
+ with:
19
+ python-version: 3.12
20
+ - name: Install dependencies
21
+ run: |
22
+ python3 -m venv venv
23
+ source venv/bin/activate
24
+ pip install -r requirements.txt
25
+ pip install mkdocs-material
26
+ - name: Run mkdocs in strict mode
27
+ id: mkdocs
28
+ run: |
29
+ source venv/bin/activate
30
+ mkdocs build --config-file mkdocs-test.yml --strict 2>&1 | tee mkdocs.out
31
+ [[ $(tail -n 1 mkdocs.out) =~ ^Aborted ]] && exit 1 || exit 0
32
+
33
+ - name: PR comment with file
34
+ if: failure()
35
+ uses: thollander/actions-comment-pull-request@e4a76dd2b0a3c2027c3fd84147a67c22ee4c90fa # v3.0.1
36
+ with:
37
+ file-path: mkdocs.out
38
+ comment-tag: execution
39
+ mode: recreate
.github/workflows/lexi.yml ADDED
@@ -0,0 +1,18 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ name: Report readability
2
+
3
+ # This action only works on pull request events
4
+ on: pull_request
5
+
6
+ jobs:
7
+ report-readability:
8
+ name: Report readability
9
+ runs-on: ubuntu-latest
10
+ steps:
11
+ - name: Checkout repo with history
12
+ uses: actions/checkout@v4
13
+ with:
14
+ fetch-depth: 0
15
+ - uses: Rebilly/lexi@v2
16
+ with:
17
+ github-token: ${{ secrets.GITHUB_TOKEN }}
18
+ glob: '**/*.md'
.github/workflows/lint.yml ADDED
@@ -0,0 +1,12 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ name: Run Vale
2
+ on: [pull_request]
3
+
4
+ jobs:
5
+ vale:
6
+ name: runner / vale
7
+ runs-on: ubuntu-latest
8
+ steps:
9
+ - uses: actions/checkout@v4
10
+ - uses: errata-ai/vale-action@reviewdog
11
+ with:
12
+ files: '["docs", "_snippets"]'
.github/workflows/lychee-pr-check.yml ADDED
@@ -0,0 +1,37 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ name: Lychee PR external linkcheck
2
+ on:
3
+ pull_request:
4
+ branches:
5
+ - main
6
+ permissions:
7
+ contents: read
8
+ pull-requests: write
9
+ jobs:
10
+ link-check:
11
+ runs-on: ubuntu-latest
12
+
13
+ steps:
14
+ - name: Checkout repository
15
+ uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
16
+ - name: Get all changed markdown files
17
+ id: changed-markdown-files
18
+ uses: step-security/changed-files@3dbe17c78367e7d60f00d78ae6781a35be47b4a1 # v45.0.1
19
+ with:
20
+ # Avoid using single or double quotes for multiline patterns
21
+ files: |
22
+ docs/**/*.md
23
+ - name: Run Lychee Link Checker
24
+ id: lychee
25
+ if: steps.changed-markdown-files.outputs.any_changed == 'true'
26
+ uses: lycheeverse/lychee-action@a99389aeff3c193ffb6f0741178e519569d3f404 # v2.3.0
27
+ with:
28
+ args: --config lychee.toml ${{ steps.changed-markdown-files.outputs.all_changed_files }}
29
+ - name: PR comment with file
30
+ uses: thollander/actions-comment-pull-request@e4a76dd2b0a3c2027c3fd84147a67c22ee4c90fa # v3.0.1
31
+ with:
32
+ file-path: lychee/out.md
33
+ comment-tag: execution
34
+ mode: recreate
35
+ - name: Report Status
36
+ if: failure()
37
+ run: echo "❌ Broken links detected. Please fix them!"
.github/workflows/lychee.yml ADDED
@@ -0,0 +1,20 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ name: Lychee external linkcheck
2
+ on:
3
+ schedule:
4
+ - cron: "18 7 * * 1"
5
+ workflow_dispatch:
6
+ jobs:
7
+ link-check:
8
+ runs-on: ubuntu-latest
9
+
10
+ steps:
11
+ - name: Checkout repository
12
+ uses: actions/checkout@v4
13
+ - name: Run Lychee Link Checker
14
+ uses: lycheeverse/lychee-action@f796c8b7d468feb9b8c0a46da3fac0af6874d374
15
+ with:
16
+ args: --config lychee.toml ./docs
17
+
18
+ - name: Report Status
19
+ if: failure()
20
+ run: echo "❌ Broken links detected. Please fix them!"
.github/workflows/support.yml ADDED
@@ -0,0 +1,30 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ name: 'Support Requests'
2
+
3
+ on:
4
+ issues:
5
+ types: [labeled, unlabeled, reopened]
6
+
7
+ permissions:
8
+ issues: write
9
+
10
+ jobs:
11
+ action:
12
+ runs-on: ubuntu-latest
13
+ steps:
14
+ - uses: dessant/support-requests@47d5ea12f6c9e4a081637de9626b7319b415a3bf
15
+ with:
16
+ github-token: ${{ github.token }}
17
+ support-label: 'support'
18
+ issue-comment: >
19
+ :wave: @{issue-author}. Sorry you are having a problem!
20
+ This repository is for the n8n documentation though. Having
21
+ looked at your issue we think you'd get quicker help with your
22
+ problem by [posting on the community forum](https://community.n8n.io/c/questions/12),
23
+ where experts from n8n and our community can provide answers
24
+ to your questions.
25
+ If you think this issue is specifically to do with the documentation,
26
+ please re-open and explain what you would like to see in docs to resolve it.
27
+ close-issue: true
28
+ issue-close-reason: 'not planned'
29
+ lock-issue: false
30
+ issue-lock-reason: 'off-topic'
.gitignore ADDED
@@ -0,0 +1,23 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ node_modules
2
+ .DS_Store
3
+ .tmp
4
+ tmp
5
+ dist
6
+ npm-debug.log*
7
+ yarn.lock
8
+ .env
9
+ .vscode
10
+ .idea
11
+
12
+ venv
13
+ env
14
+ site
15
+ __pycache__/
16
+
17
+ ## Ignore pyenv configuration
18
+ .python-version
19
+
20
+ ## Ignore ephemeral doc-tool output
21
+
22
+ output.csv
23
+ _doctools/*.csv
.gitmodules ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ [submodule "_submodules/insiders"]
2
+ path = _submodules/insiders
3
+ url = git@github.com:n8n-io/mkdocs-material-insiders.git
.vale.ini ADDED
@@ -0,0 +1,9 @@
 
 
 
 
 
 
 
 
 
 
1
+ StylesPath = "styles"
2
+ MinAlertLevel = warning
3
+ Vocab = default
4
+ [*.md]
5
+ BasedOnStyles = from-write-good, n8n-styles, from-microsoft, Vale
6
+ Vale.Terms = NO
7
+ from-alex.Profanity = NO
8
+ from-microsoft.Quotes = NO
9
+ TokenIgnores = (\-\-8\<\-\- \".*\"), (-only), (\*\*.*\*\*), (\*\*Release date:\*\*.*), (\[\[\%.*\%\]\]), (\[.*\]\(.*\)\{:target=_blank .external-link\}), (\[\[.*\]\]), (Rocket\.Chat), (\(https.*\)), (how\smany), (too\smany)
CNAME ADDED
@@ -0,0 +1 @@
 
 
1
+ docs.n8n.io
CODE_OF_CONDUCT.md ADDED
@@ -0,0 +1,76 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Contributor Covenant Code of Conduct
2
+
3
+ ## Our Pledge
4
+
5
+ In the interest of fostering an open and welcoming environment, we as
6
+ contributors and maintainers pledge to making participation in our project and
7
+ our community a harassment-free experience for everyone, regardless of age, body
8
+ size, disability, ethnicity, sex characteristics, gender identity and expression,
9
+ level of experience, education, socio-economic status, nationality, personal
10
+ appearance, race, religion, or sexual identity and orientation.
11
+
12
+ ## Our Standards
13
+
14
+ Examples of behavior that contributes to creating a positive environment
15
+ include:
16
+
17
+ * Using welcoming and inclusive language
18
+ * Being respectful of differing viewpoints and experiences
19
+ * Gracefully accepting constructive criticism
20
+ * Focusing on what is best for the community
21
+ * Showing empathy towards other community members
22
+
23
+ Examples of unacceptable behavior by participants include:
24
+
25
+ * The use of sexualized language or imagery and unwelcome sexual attention or
26
+ advances
27
+ * Trolling, insulting/derogatory comments, and personal or political attacks
28
+ * Public or private harassment
29
+ * Publishing others' private information, such as a physical or electronic
30
+ address, without explicit permission
31
+ * Other conduct which could reasonably be considered inappropriate in a
32
+ professional setting
33
+
34
+ ## Our Responsibilities
35
+
36
+ Project maintainers are responsible for clarifying the standards of acceptable
37
+ behavior and are expected to take appropriate and fair corrective action in
38
+ response to any instances of unacceptable behavior.
39
+
40
+ Project maintainers have the right and responsibility to remove, edit, or
41
+ reject comments, commits, code, wiki edits, issues, and other contributions
42
+ that are not aligned to this Code of Conduct, or to ban temporarily or
43
+ permanently any contributor for other behaviors that they deem inappropriate,
44
+ threatening, offensive, or harmful.
45
+
46
+ ## Scope
47
+
48
+ This Code of Conduct applies both within project spaces and in public spaces
49
+ when an individual is representing the project or its community. Examples of
50
+ representing a project or community include using an official project e-mail
51
+ address, posting via an official social media account, or acting as an appointed
52
+ representative at an online or offline event. Representation of a project may be
53
+ further defined and clarified by project maintainers.
54
+
55
+ ## Enforcement
56
+
57
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
58
+ reported by contacting the project team at jan@n8n.io. All
59
+ complaints will be reviewed and investigated and will result in a response that
60
+ is deemed necessary and appropriate to the circumstances. The project team is
61
+ obligated to maintain confidentiality with regard to the reporter of an incident.
62
+ Further details of specific enforcement policies may be posted separately.
63
+
64
+ Project maintainers who do not follow or enforce the Code of Conduct in good
65
+ faith may face temporary or permanent repercussions as determined by other
66
+ members of the project's leadership.
67
+
68
+ ## Attribution
69
+
70
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71
+ available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
72
+
73
+ [homepage]: https://www.contributor-covenant.org
74
+
75
+ For answers to common questions about this code of conduct, see
76
+ https://www.contributor-covenant.org/faq
CONTRIBUTING.md ADDED
@@ -0,0 +1,99 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Contributing
2
+
3
+ If you want to contribute to this repository - thank you! Before you start, have a look at the existing documentation to get an idea of the structure and writing conventions n8n uses. In writing your documentation, please follow the guidelines described below, to ensure quality and consistency with n8n styles.
4
+
5
+ ## Before you start
6
+
7
+ ### Style
8
+
9
+ n8n uses the [Microsoft Writing Style Guide](https://docs.microsoft.com/en-us/style-guide/welcome/).
10
+
11
+ Refer to [Styles](https://github.com/n8n-io/n8n-docs/wiki/Styles/) for a quickstart, and guidance on style linting.
12
+
13
+ ### n8n's license
14
+
15
+ Be aware that n8n is fair code licensed. For more information, refer to the [License](https://docs.n8n.io/reference/license/) documentation.
16
+
17
+ ## Writing docs
18
+
19
+ You can either:
20
+
21
+ * Check out the docs repository and work on your local machine.
22
+ * Make your changes directly in GitHub.
23
+
24
+ These instructions are for external users. Members of the n8n organization don't need to fork the repository.
25
+
26
+ ### Working locally
27
+
28
+ This method allows you to work in your own text editor, and preview your work while editing.
29
+
30
+ You need Git installed, and a GitHub account.
31
+
32
+ [Fork the documentation repository](https://docs.github.com/en/get-started/quickstart/fork-a-repo).
33
+
34
+ Then clone your fork:
35
+
36
+ ```
37
+ git clone https://github.com/<your-username>/n8n-docs.git
38
+ cd n8n-docs
39
+ git checkout -b <branch-name>
40
+ ```
41
+
42
+ Make your changes. Push your branch:
43
+
44
+ ```
45
+ git add *
46
+ git commit -m "<short summary of changes>"
47
+ git push --set-upstream origin <branch-name>
48
+ ```
49
+
50
+ In GitHub, [create a pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork) to merge the work from your fork to `main` in the docs repository.
51
+
52
+ ### Writing in GitHub
53
+
54
+ This method is fine for small changes, but not recommended for larger pieces of work.
55
+
56
+ You need a GitHub account.
57
+
58
+ Follow GitHub's documentation on [editing files](https://docs.github.com/en/repositories/working-with-files/managing-files/editing-files).
59
+
60
+ ### Previewing your work
61
+
62
+ You can build the docs locally to preview them, or submit a pull request. All pull requests automatically trigger a preview build.
63
+
64
+ For instructions on previewing the docs locally, refer to the [README](https://github.com/n8n-io/n8n-docs/blob/main/README.md).
65
+
66
+ ### General checklist
67
+
68
+ Before submitting a PR, make sure your contribution ticks all these boxes:
69
+
70
+ - [ ] All necessary files and images are included.
71
+ - [ ] All links are working and direct to the right location.
72
+ - [ ] All documentation files end with an empty newline.
73
+ - [ ] The commit message describes the changes you made.
74
+ - [ ] The PR explains the changes you made and why they're necessary.
75
+ - [ ] You have read and accepted the [code of conduct](https://github.com/n8n-io/n8n-docs/blob/master/CODE_OF_CONDUCT.md) and [contributor license agreement](https://github.com/n8n-io/n8n-docs/blob/master/CONTRIBUTOR_LICENSE_AGREEMENT.md).
76
+
77
+
78
+ ## Documenting nodes
79
+
80
+ n8n provides [templates](https://github.com/n8n-io/n8n-docs/tree/main/document-templates) for node docs.
81
+
82
+ * **Nodes and trigger nodes:** Create a directory with the name of the node at `docs/integrations/builtin/app-nodes/` or `docs/integrations/builtin/trigger-nodes/` containing:
83
+
84
+ - A text file named `n8n-nodes-base.<node-name>.md` describing the functionality of the relevant node.
85
+
86
+ * **Credentials:** Create a document with the name of the node at `docs/integrations/builtin/credentials/` containing:
87
+ - A text file with the node name describing how to get credentials for the relevant node.
88
+
89
+ A standard node doc includes the following parts:
90
+
91
+ * Node description
92
+ - Describe the purpose and function of the node.
93
+ * Operations
94
+ - Enter the resources and operations as they're named in the nodes.
95
+
96
+ In the credentials doc:
97
+
98
+ * If there is more than one authentication method, list OAuth first.
99
+ * If possible, avoid documenting external products. Instead, provide links to the relevant product documentation. For example, for guidance on getting credentials (such as how to get an API token for a service), provide a link to the product's API authentication docs.
CONTRIBUTOR_LICENSE_AGREEMENT.md ADDED
@@ -0,0 +1,5 @@
 
 
 
 
 
 
1
+ # n8n Contributor License Agreement
2
+
3
+ I give n8n permission to license my contributions on any terms they like. I am giving them this license in order to make it possible for them to accept my contributions into their project.
4
+
5
+ ***As far as the law allows, my contributions come as is, without any warranty or condition, and I will not be liable to anyone for any damages related to this software or this license, under any kind of legal claim.***
LICENSE.md ADDED
@@ -0,0 +1,230 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ “Commons Clause” License Condition v1.0
2
+
3
+ The Software is provided to you by the Licensor under the
4
+ License, as defined below, subject to the following condition.
5
+
6
+ Without limiting other conditions in the License, the grant
7
+ of rights under the License will not include, and the License
8
+ does not grant to you, the right to Sell the Software.
9
+
10
+ For purposes of the foregoing, “Sell” means practicing any or
11
+ all of the rights granted to you under the License to provide
12
+ to third parties, for a fee or other consideration (including
13
+ without limitation fees for hosting or consulting/ support
14
+ services related to the Software), a product or service whose
15
+ value derives, entirely or substantially, from the functionality
16
+ of the Software. Any license notice or attribution required by
17
+ the License must also include this Commons Clause License
18
+ Condition notice.
19
+
20
+ Software: n8n
21
+
22
+ License: Apache 2.0
23
+
24
+ Licensor: n8n GmbH
25
+
26
+
27
+ ---------------------------------------------------------------------
28
+
29
+
30
+ Apache License
31
+ Version 2.0, January 2004
32
+ http://www.apache.org/licenses/
33
+
34
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
35
+
36
+ 1. Definitions.
37
+
38
+ "License" shall mean the terms and conditions for use, reproduction,
39
+ and distribution as defined by Sections 1 through 9 of this document.
40
+
41
+ "Licensor" shall mean the copyright owner or entity authorized by
42
+ the copyright owner that is granting the License.
43
+
44
+ "Legal Entity" shall mean the union of the acting entity and all
45
+ other entities that control, are controlled by, or are under common
46
+ control with that entity. For the purposes of this definition,
47
+ "control" means (i) the power, direct or indirect, to cause the
48
+ direction or management of such entity, whether by contract or
49
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
50
+ outstanding shares, or (iii) beneficial ownership of such entity.
51
+
52
+ "You" (or "Your") shall mean an individual or Legal Entity
53
+ exercising permissions granted by this License.
54
+
55
+ "Source" form shall mean the preferred form for making modifications,
56
+ including but not limited to software source code, documentation
57
+ source, and configuration files.
58
+
59
+ "Object" form shall mean any form resulting from mechanical
60
+ transformation or translation of a Source form, including but
61
+ not limited to compiled object code, generated documentation,
62
+ and conversions to other media types.
63
+
64
+ "Work" shall mean the work of authorship, whether in Source or
65
+ Object form, made available under the License, as indicated by a
66
+ copyright notice that is included in or attached to the work
67
+ (an example is provided in the Appendix below).
68
+
69
+ "Derivative Works" shall mean any work, whether in Source or Object
70
+ form, that is based on (or derived from) the Work and for which the
71
+ editorial revisions, annotations, elaborations, or other modifications
72
+ represent, as a whole, an original work of authorship. For the purposes
73
+ of this License, Derivative Works shall not include works that remain
74
+ separable from, or merely link (or bind by name) to the interfaces of,
75
+ the Work and Derivative Works thereof.
76
+
77
+ "Contribution" shall mean any work of authorship, including
78
+ the original version of the Work and any modifications or additions
79
+ to that Work or Derivative Works thereof, that is intentionally
80
+ submitted to Licensor for inclusion in the Work by the copyright owner
81
+ or by an individual or Legal Entity authorized to submit on behalf of
82
+ the copyright owner. For the purposes of this definition, "submitted"
83
+ means any form of electronic, verbal, or written communication sent
84
+ to the Licensor or its representatives, including but not limited to
85
+ communication on electronic mailing lists, source code control systems,
86
+ and issue tracking systems that are managed by, or on behalf of, the
87
+ Licensor for the purpose of discussing and improving the Work, but
88
+ excluding communication that is conspicuously marked or otherwise
89
+ designated in writing by the copyright owner as "Not a Contribution."
90
+
91
+ "Contributor" shall mean Licensor and any individual or Legal Entity
92
+ on behalf of whom a Contribution has been received by Licensor and
93
+ subsequently incorporated within the Work.
94
+
95
+ 2. Grant of Copyright License. Subject to the terms and conditions of
96
+ this License, each Contributor hereby grants to You a perpetual,
97
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
98
+ copyright license to reproduce, prepare Derivative Works of,
99
+ publicly display, publicly perform, sublicense, and distribute the
100
+ Work and such Derivative Works in Source or Object form.
101
+
102
+ 3. Grant of Patent License. Subject to the terms and conditions of
103
+ this License, each Contributor hereby grants to You a perpetual,
104
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
105
+ (except as stated in this section) patent license to make, have made,
106
+ use, offer to sell, sell, import, and otherwise transfer the Work,
107
+ where such license applies only to those patent claims licensable
108
+ by such Contributor that are necessarily infringed by their
109
+ Contribution(s) alone or by combination of their Contribution(s)
110
+ with the Work to which such Contribution(s) was submitted. If You
111
+ institute patent litigation against any entity (including a
112
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
113
+ or a Contribution incorporated within the Work constitutes direct
114
+ or contributory patent infringement, then any patent licenses
115
+ granted to You under this License for that Work shall terminate
116
+ as of the date such litigation is filed.
117
+
118
+ 4. Redistribution. You may reproduce and distribute copies of the
119
+ Work or Derivative Works thereof in any medium, with or without
120
+ modifications, and in Source or Object form, provided that You
121
+ meet the following conditions:
122
+
123
+ (a) You must give any other recipients of the Work or
124
+ Derivative Works a copy of this License; and
125
+
126
+ (b) You must cause any modified files to carry prominent notices
127
+ stating that You changed the files; and
128
+
129
+ (c) You must retain, in the Source form of any Derivative Works
130
+ that You distribute, all copyright, patent, trademark, and
131
+ attribution notices from the Source form of the Work,
132
+ excluding those notices that do not pertain to any part of
133
+ the Derivative Works; and
134
+
135
+ (d) If the Work includes a "NOTICE" text file as part of its
136
+ distribution, then any Derivative Works that You distribute must
137
+ include a readable copy of the attribution notices contained
138
+ within such NOTICE file, excluding those notices that do not
139
+ pertain to any part of the Derivative Works, in at least one
140
+ of the following places: within a NOTICE text file distributed
141
+ as part of the Derivative Works; within the Source form or
142
+ documentation, if provided along with the Derivative Works; or,
143
+ within a display generated by the Derivative Works, if and
144
+ wherever such third-party notices normally appear. The contents
145
+ of the NOTICE file are for informational purposes only and
146
+ do not modify the License. You may add Your own attribution
147
+ notices within Derivative Works that You distribute, alongside
148
+ or as an addendum to the NOTICE text from the Work, provided
149
+ that such additional attribution notices cannot be construed
150
+ as modifying the License.
151
+
152
+ You may add Your own copyright statement to Your modifications and
153
+ may provide additional or different license terms and conditions
154
+ for use, reproduction, or distribution of Your modifications, or
155
+ for any such Derivative Works as a whole, provided Your use,
156
+ reproduction, and distribution of the Work otherwise complies with
157
+ the conditions stated in this License.
158
+
159
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
160
+ any Contribution intentionally submitted for inclusion in the Work
161
+ by You to the Licensor shall be under the terms and conditions of
162
+ this License, without any additional terms or conditions.
163
+ Notwithstanding the above, nothing herein shall supersede or modify
164
+ the terms of any separate license agreement you may have executed
165
+ with Licensor regarding such Contributions.
166
+
167
+ 6. Trademarks. This License does not grant permission to use the trade
168
+ names, trademarks, service marks, or product names of the Licensor,
169
+ except as required for reasonable and customary use in describing the
170
+ origin of the Work and reproducing the content of the NOTICE file.
171
+
172
+ 7. Disclaimer of Warranty. Unless required by applicable law or
173
+ agreed to in writing, Licensor provides the Work (and each
174
+ Contributor provides its Contributions) on an "AS IS" BASIS,
175
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
176
+ implied, including, without limitation, any warranties or conditions
177
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
178
+ PARTICULAR PURPOSE. You are solely responsible for determining the
179
+ appropriateness of using or redistributing the Work and assume any
180
+ risks associated with Your exercise of permissions under this License.
181
+
182
+ 8. Limitation of Liability. In no event and under no legal theory,
183
+ whether in tort (including negligence), contract, or otherwise,
184
+ unless required by applicable law (such as deliberate and grossly
185
+ negligent acts) or agreed to in writing, shall any Contributor be
186
+ liable to You for damages, including any direct, indirect, special,
187
+ incidental, or consequential damages of any character arising as a
188
+ result of this License or out of the use or inability to use the
189
+ Work (including but not limited to damages for loss of goodwill,
190
+ work stoppage, computer failure or malfunction, or any and all
191
+ other commercial damages or losses), even if such Contributor
192
+ has been advised of the possibility of such damages.
193
+
194
+ 9. Accepting Warranty or Additional Liability. While redistributing
195
+ the Work or Derivative Works thereof, You may choose to offer,
196
+ and charge a fee for, acceptance of support, warranty, indemnity,
197
+ or other liability obligations and/or rights consistent with this
198
+ License. However, in accepting such obligations, You may act only
199
+ on Your own behalf and on Your sole responsibility, not on behalf
200
+ of any other Contributor, and only if You agree to indemnify,
201
+ defend, and hold each Contributor harmless for any liability
202
+ incurred by, or claims asserted against, such Contributor by reason
203
+ of your accepting any such warranty or additional liability.
204
+
205
+ END OF TERMS AND CONDITIONS
206
+
207
+ APPENDIX: How to apply the Apache License to your work.
208
+
209
+ To apply the Apache License to your work, attach the following
210
+ boilerplate notice, with the fields enclosed by brackets "[]"
211
+ replaced with your own identifying information. (Don't include
212
+ the brackets!) The text should be enclosed in the appropriate
213
+ comment syntax for the file format. We also recommend that a
214
+ file or class name and description of purpose be included on the
215
+ same "printed page" as the copyright notice for easier
216
+ identification within third-party archives.
217
+
218
+ Copyright [2020] [n8n GmbH]
219
+
220
+ Licensed under the Apache License, Version 2.0 (the "License");
221
+ you may not use this file except in compliance with the License.
222
+ You may obtain a copy of the License at
223
+
224
+ http://www.apache.org/licenses/LICENSE-2.0
225
+
226
+ Unless required by applicable law or agreed to in writing, software
227
+ distributed under the License is distributed on an "AS IS" BASIS,
228
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
229
+ See the License for the specific language governing permissions and
230
+ limitations under the License.
README.md ADDED
@@ -0,0 +1,72 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ![Banner image](https://user-images.githubusercontent.com/10284570/173569848-c624317f-42b1-45a6-ab09-f0ea3c247648.png)
2
+
3
+ # n8n Docs
4
+
5
+ This repository hosts the documentation for [n8n](https://n8n.io/), an extendable workflow automation tool which enables you to connect anything to everything. The documentation is live at [docs.n8n.io](https://docs.n8n.io/).
6
+
7
+
8
+ ## Previewing and building the documentation locally
9
+
10
+ ### Prerequisites
11
+
12
+ * Python 3.8 or above
13
+ * Pip
14
+ * n8n recommends using a virtual environment when working with Python, such as [venv](https://docs.python.org/3/tutorial/venv.html).
15
+ * Follow the [recommended configuration and auto-complete](https://squidfunk.github.io/mkdocs-material/creating-your-site/#minimal-configuration) guidance for the theme. This will help when working with the `mkdocs.yml` file.
16
+ * The repo includes a `.editorconfig` file. Make sure your local editor settings **do not override** these settings. In particular:
17
+ - Don't allow your editor to replace tabs with spaces. This can affect our code samples (which must retain tabs for people building nodes).
18
+ - One tab must be equivalent to four spaces.
19
+
20
+ ### Steps
21
+
22
+ #### For members of the n8n GitHub organization:
23
+
24
+ 1. Set up an SSH token and add it to your GitHub account. Refer to [GitHub | About SSH](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/about-ssh) for guidance.
25
+ 2. Then run these commands:
26
+
27
+ ```bash
28
+ git clone --recurse-submodules git@github.com:n8n-io/n8n-docs.git
29
+ cd n8n-docs
30
+ # Set up virtual environment if using one (steps depend on your system)
31
+ # Install dependencies
32
+ pip install -r requirements.txt
33
+ pip install _submodules/insiders
34
+ ```
35
+
36
+ #### For external contributors:
37
+
38
+ Rely on the preview builds on pull requests, or use the free version of Material for MkDocs (most things are the same, some formatting may be missing)
39
+
40
+ Fork the repository, then:
41
+
42
+ ```
43
+ git clone https://github.com/<your-username>/n8n-docs.git
44
+ cd n8n-docs
45
+ pip install -r requirements.txt
46
+ pip install mkdocs-material
47
+ ```
48
+
49
+ #### To serve a local preview:
50
+
51
+ ```
52
+ mkdocs serve
53
+ ```
54
+
55
+ ## Contributing
56
+
57
+ Please read the [CONTRIBUTING](CONTRIBUTING.md) guide.
58
+
59
+ You can find [style guidance](https://github.com/n8n-io/n8n-docs/wiki/Styles) in the wiki.
60
+
61
+
62
+ ## Support
63
+
64
+ If you have problems or questions, head to n8n's forum: https://community.n8n.io
65
+
66
+
67
+ ## License
68
+
69
+ n8n-docs is [fair-code](https://faircode.io/) licensed under the [**Sustainable Use License**](https://github.com/n8n-io/n8n/blob/master/LICENSE.md).
70
+
71
+ More information about the license is available in the [License documentation](https://docs.n8n.io/reference/license/).
72
+
_doctools/change_link_style.py ADDED
@@ -0,0 +1,54 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ #!/usr/bin/env python3
2
+ from pathlib import Path
3
+ import argparse
4
+ import re
5
+
6
+ def find_markdown_files(directory):
7
+ """Return a list of path objects for all markdown files in the given directory."""
8
+ return list(Path(directory).rglob("*.[mM][dD]"))
9
+
10
+ def map_urls_to_files(path_list, root_dir):
11
+ """Return a dictionary mapping URL link targets to file targets."""
12
+ path_maps = dict()
13
+ for path in path_list:
14
+ # Here, we convert file paths to absolute paths from the root_dir
15
+ md_link_target = "/" / path.relative_to(root_dir)
16
+ url_link_target = get_url_path_from_file_path(md_link_target)
17
+ path_maps[url_link_target] = str(md_link_target)
18
+
19
+ return path_maps
20
+
21
+ def get_url_path_from_file_path(file_path):
22
+ """Return the URL path for a given file path."""
23
+ if file_path.name == "index.md":
24
+ return str(file_path.parent)
25
+ else:
26
+ return str(file_path.parent / file_path.stem)
27
+
28
+ def main(directory):
29
+ """
30
+ Finds Markdown files, calculates URL paths associated with them, then finds and
31
+ replaces URL paths with file paths in links throughout the repo.
32
+ """
33
+ markdown_files = find_markdown_files(directory)
34
+ snippet_files = find_markdown_files("../_snippets")
35
+ link_maps = map_urls_to_files(markdown_files, directory)
36
+
37
+ for file in markdown_files + snippet_files:
38
+ text = file.read_text()
39
+
40
+ for url_target, file_target in link_maps.items():
41
+ find_pattern = fr"]\({url_target}/?(#[0-9A-Za-z-]+)?\)"
42
+ replace_pattern = fr"]({file_target}\1)"
43
+ text = re.sub(find_pattern, replace_pattern, text)
44
+
45
+ file.write_text(text)
46
+
47
+
48
+ if __name__ == "__main__":
49
+ parser = argparse.ArgumentParser(description="Replace URL style link targets with markdown file targets")
50
+ parser.add_argument("--dir", type=str, default="../docs", help="Directory to scan (default: '../docs')")
51
+
52
+ args = parser.parse_args()
53
+ main(args.dir)
54
+
_doctools/pageinfo.py ADDED
@@ -0,0 +1,94 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ #!/usr/bin/env python3
2
+ import os
3
+ import yaml
4
+ import argparse
5
+ import re
6
+ import glob
7
+ import csv
8
+
9
+ OUTPUT_CSV = "pageinfo.csv"
10
+
11
+ def extract_frontmatter_and_content(filepath):
12
+ """Extracts frontmatter and main content from a Markdown file."""
13
+ with open(filepath, "r", encoding="utf-8") as f:
14
+ content = f.read()
15
+
16
+ # Match YAML frontmatter with regex (--- as delimiter)
17
+ match = re.match(r"^---\n(.*?)\n---\n(.*)", content, re.DOTALL)
18
+
19
+ if match:
20
+ try:
21
+ frontmatter = yaml.safe_load(match.group(1)) # Parse YAML
22
+ except yaml.YAMLError:
23
+ frontmatter = None # Invalid YAML
24
+ main_content = match.group(2).strip()
25
+ else:
26
+ frontmatter = None
27
+ main_content = content.strip()
28
+
29
+ return frontmatter, main_content
30
+
31
+ def count_words(text):
32
+ """Counts the number of words in the given text."""
33
+ # yes, this is fairly simplistic, but a general idea is fine for most uses
34
+ return len(text.split())
35
+
36
+ def find_markdown_files(directory):
37
+ """Recursively finds all markdown files in the given directory."""
38
+ return glob.glob(os.path.join(directory, "**", "*.md"), recursive=True)
39
+
40
+ def save_to_csv(data, filename=OUTPUT_CSV):
41
+ """Saves extracted data to a CSV file with dynamic contentType columns."""
42
+ max_types = max((len(row[1]) if isinstance(row[1], list) else 1) for row in data)
43
+ headers = ["Filename", "WordCount"] + [f"ContentType_{i+1}" for i in range(max_types)]
44
+
45
+ with open(filename, "w", newline="", encoding="utf-8") as csvfile:
46
+ writer = csv.writer(csvfile)
47
+ writer.writerow(headers) # Write CSV header
48
+
49
+ for filename, content_type, word_count in data:
50
+ if isinstance(content_type, list):
51
+ row = [filename, word_count] + content_type + [""] * (max_types - len(content_type))
52
+ else:
53
+ row = [filename, word_count, content_type] + [""] * (max_types - 1)
54
+ writer.writerow(row)
55
+
56
+ def main(directory,print_output):
57
+ """Finds Markdown files, extracts 'contentType' and word count, then prints and saves results."""
58
+ md_files = find_markdown_files(directory)
59
+ extracted_data = []
60
+
61
+ for file in md_files:
62
+ frontmatter, main_content = extract_frontmatter_and_content(file)
63
+ word_count = count_words(main_content)
64
+
65
+ if frontmatter and "contentType" in frontmatter:
66
+ content_type = frontmatter["contentType"]
67
+ else:
68
+ content_type = ""
69
+
70
+ # Convert list to comma-separated string for printing
71
+ if isinstance(content_type, list):
72
+ content_str = ", ".join(content_type)
73
+ else:
74
+ content_str = str(content_type)
75
+
76
+ if print_output:
77
+ print(f"File: {file}")
78
+ print(f"Word Count: {word_count}")
79
+ print(f"contentType: {content_str}\n")
80
+
81
+ extracted_data.append([file, content_type, word_count])
82
+
83
+ if extracted_data:
84
+ save_to_csv(extracted_data)
85
+ print(f"Results saved to {OUTPUT_CSV}")
86
+
87
+ if __name__ == "__main__":
88
+ parser = argparse.ArgumentParser(description="Extract contentType and word count from Markdown files.")
89
+ parser.add_argument("--dir", type=str, default="../docs", help="Directory to scan (default: '../docs')")
90
+ parser.add_argument("--print", action="store_true", help="Print output to console (default: False, only CSV)")
91
+
92
+ args = parser.parse_args()
93
+ main(args.dir, args.print)
94
+
_glossary/ai-glossary.md ADDED
@@ -0,0 +1,7 @@
 
 
 
 
 
 
 
 
1
+ ## AI glossary
2
+
3
+ * __completion__: Completions are the responses generated by a model like GPT.
4
+ * __hallucinations__: Hallucination in AI is when an LLM (large language model) mistakenly perceives patterns or objects that don't exist.
5
+ * __vector database__: A vector database stores mathematical representations of information. Use with embeddings and retrievers to create a database that your AI can access when answering questions.
6
+ * __vector store__: A vector store, or vector database, stores mathematical representations of information. Use with embeddings and retrievers to create a database that your AI can access when answering questions.
7
+
_glossary/main.md ADDED
File without changes
_overrides/404.html ADDED
@@ -0,0 +1,31 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {% extends "main.html" %}
2
+ {% block htmltitle %}
3
+ <title>404</title>
4
+ {% endblock %}
5
+ {% block extrahead %}
6
+ <script>
7
+ // Create an object containing all your redirects
8
+ const redirects = {
9
+
10
+
11
+ // Use _redirects file to set redirects
12
+
13
+ };
14
+
15
+ (function redirect(){
16
+
17
+ const currentPath = window.location.pathname + (window.location.hash ? window.location.hash : '');
18
+ const redirectUrl = redirects[currentPath];
19
+ if (redirectUrl) {
20
+ window.location.href = `${window.location.origin}${redirectUrl}`;
21
+ return;
22
+ }
23
+
24
+ })();
25
+
26
+ </script>
27
+ {% endblock %}
28
+ {% block content %}
29
+ <h1>404 - Page not found</h1>
30
+ <h2>Go <a href="/">home</a></h2>
31
+ {% endblock %}
_overrides/api.html ADDED
@@ -0,0 +1,102 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {% extends "main.html" %}
2
+
3
+ {% block extrahead %}
4
+ <link href="https://fonts.googleapis.com/css?family=Montserrat:300,400,700|Roboto:300,400,700" rel="stylesheet">
5
+
6
+ <!--
7
+ Redoc doesn't change outer page styles
8
+ -->
9
+ <style>
10
+
11
+ body {
12
+ margin: 0;
13
+ padding: 0;
14
+ }
15
+
16
+ .md-main__inner {
17
+ width: 100%;
18
+ margin-top: 0;
19
+ }
20
+
21
+ .md-grid {
22
+ max-width: 100%;
23
+ }
24
+
25
+ .md-content__inner {
26
+ padding: 0;
27
+ margin: 0;
28
+ }
29
+
30
+ .md-content__inner > p {
31
+ margin: 0;
32
+ }
33
+
34
+ .md-content__inner:before {
35
+ height: 0;
36
+ }
37
+
38
+ .md-typeset ol li:last-child, .md-typeset ul li:last-child {
39
+ margin-bottom: invalid;
40
+ }
41
+
42
+ [dir=ltr] .md-typeset ol li, [dir=ltr] .md-typeset ul li {
43
+ margin-left: 0;
44
+ }
45
+
46
+ [dir=ltr] .md-typeset ol, [dir=ltr] .md-typeset ul {
47
+ margin-left: 0;
48
+ }
49
+
50
+ </style>
51
+
52
+ {% endblock %}
53
+ {% block content %}
54
+ <!--
55
+ Copyright (c) 2016-2022 Martin Donath <martin.donath@squidfunk.com>
56
+
57
+ Permission is hereby granted, free of charge, to any person obtaining a copy
58
+ of this software and associated documentation files (the "Software"), to
59
+ deal in the Software without restriction, including without limitation the
60
+ rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
61
+ sell copies of the Software, and to permit persons to whom the Software is
62
+ furnished to do so, subject to the following conditions:
63
+
64
+ The above copyright notice and this permission notice shall be included in
65
+ all copies or substantial portions of the Software.
66
+
67
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
68
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
69
+ FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
70
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
71
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
72
+ FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
73
+ IN THE SOFTWARE.
74
+ -->
75
+
76
+ <!-- Edit button -->
77
+ {% if page.edit_url %}
78
+ <a
79
+ href="{{ page.edit_url }}"
80
+ title="{{ lang.t('edit.link.title') }}"
81
+ class="md-content__button md-icon"
82
+ >
83
+ {% include ".icons/material/pencil.svg" %}
84
+ </a>
85
+ {% endif %}
86
+
87
+ <!-- Tags -->
88
+ {% if "tags" in config.plugins %}
89
+ {% include "partials/tags.html" %}
90
+ {% endif %}
91
+
92
+ <!-- Markdown content -->
93
+ {{ page.content }}
94
+
95
+ <!-- Source file information -->
96
+ {% if page and page.meta and (
97
+ page.meta.git_revision_date_localized or
98
+ page.meta.revision_date
99
+ ) %}
100
+ {% include "partials/source-file.html" %}
101
+ {% endif %}
102
+ {% endblock %}
_overrides/main.html ADDED
@@ -0,0 +1,156 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {% extends "base.html" %}
2
+
3
+ {% block extrahead %}
4
+ <meta name="ahrefs-site-verification" content="b13556bca44be7ae858f67ddbdd71eaa177d9389a88eb295244299a87292d60a">
5
+ {% endblock %}
6
+
7
+ {% block htmltitle %}
8
+
9
+ {% if page.meta and page.meta.title %}
10
+ <title>{{ page.meta.title }} | {{ config.site_name }} </title>
11
+ {% elif page.title and not page.is_homepage %}
12
+ <title>{{ page.title | striptags }} | {{ config.site_name }} </title>
13
+ {% else %}
14
+ <title>{{ config.site_name }}</title>
15
+ {% endif %}
16
+
17
+ {% endblock %}
18
+
19
+ {% block libs %}
20
+
21
+ <!-- Google Tag Manager -->
22
+ <script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':
23
+ new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],
24
+ j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
25
+ 'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
26
+ })(window,document,'script','dataLayer','GTM-K86VCV3');</script>
27
+ <!-- End Google Tag Manager -->
28
+
29
+
30
+ <!-- Plausible analytics -->
31
+ <!--
32
+ https://plausible.io/docs/script-extensions?ref=ryansechrest.com#all-our-script-extensions
33
+ -->
34
+ <script defer {% if page.meta and page.meta.contentType %}event-content_type="{{ page.meta.contentType }}"{% endif %} data-domain="docs.n8n.io" src="https://plausible.io/js/script.file-downloads.outbound-links.pageview-props.js"></script>
35
+
36
+ <!-- n8n Workflow Preview Service -->
37
+ <script src="https://cdn.jsdelivr.net/npm/@webcomponents/webcomponentsjs@2.0.0/webcomponents-loader.js"></script>
38
+ <script src="https://www.unpkg.com/lit@2.0.0-rc.2/polyfill-support.js"></script>
39
+ <script type="module" src="https://cdn.jsdelivr.net/npm/@n8n_io/n8n-demo-component/n8n-demo.bundled.js"></script>
40
+
41
+
42
+ {% endblock %}
43
+
44
+
45
+
46
+ {% block container %}
47
+
48
+ <!-- Google Tag Manager (noscript) -->
49
+ <noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-K86VCV3"
50
+ height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
51
+ <!-- End Google Tag Manager (noscript) -->
52
+
53
+
54
+ {{ super() }}
55
+
56
+ {% endblock %}
57
+
58
+
59
+ {% block scripts %}
60
+ <!-- Add scripts that need to run before here -->
61
+ {{ super() }}
62
+ <!-- Add scripts that need to run afterwards here -->
63
+ <script>
64
+ // Track video plays with Plausible
65
+ if (document.readyState === 'loading') {
66
+ document.addEventListener('DOMContentLoaded', trackVideoWithPlausible);
67
+ } else {
68
+ trackVideoWithPlausible();
69
+ }
70
+
71
+ // used for tracking time played even when multiple videos on page
72
+ var videoTrackingObj = {};
73
+
74
+
75
+ function trackVideoWithPlausible() {
76
+ // If Plausible does not exist, stop
77
+ if (typeof plausible !== "function") {
78
+ return;
79
+ }
80
+ // If there are no videos on page, stop
81
+ const videos = document.querySelectorAll("video");
82
+ if (videos.length === 0) {
83
+ return;
84
+ }
85
+ // Add event listeners
86
+ videos.forEach((video) => {
87
+ // for <video src="">
88
+ if (video.src) {
89
+ videoTrackingObj[new URL(video.src).pathname] = {
90
+ "played": false,
91
+ "played25": false,
92
+ "played50": false,
93
+ "played75": false
94
+ }
95
+ } else if (video.getElementsByTagName('source').length > 0) {
96
+ videoTrackingObj[new URL(video.getElementsByTagName('source')[0].src).pathname] = {
97
+ "played": false,
98
+ "played25": false,
99
+ "played50": false,
100
+ "played75": false
101
+ }
102
+ } else {
103
+ let currentPage = window.location.href;
104
+ fetch('https://internal.users.n8n.cloud/webhook/docs-video-not-tracking?docsPage='+currentPage);
105
+ }
106
+
107
+ video.addEventListener("play", trackVideoPlayWithPlausible);
108
+ video.addEventListener("timeupdate", trackTimeIntervalsWithPlausible);
109
+ video.addEventListener("ended", trackVideoEndedWithPlausible);
110
+ });
111
+ }
112
+
113
+ function trackVideoPlayWithPlausible(event) {
114
+ let pagePath = new URL(event.target.baseURI).pathname;
115
+ let videoPath = new URL(event.target.currentSrc).pathname;
116
+ // Only register the first play event
117
+ if (videoTrackingObj[videoPath].played === true) {
118
+ return;
119
+ }
120
+ // Track play
121
+ plausible("Video: Play", { props: { page: pagePath, video: videoPath } });
122
+ videoTrackingObj[videoPath].played === true;
123
+ }
124
+
125
+ function trackTimeIntervalsWithPlausible(event) {
126
+ let pagePath = new URL(event.target.baseURI).pathname;
127
+ let videoPath = new URL(event.target.currentSrc).pathname;
128
+ // If less than 25% played, do nothing
129
+ if (event.target.currentTime < (event.target.duration / 4)) {
130
+ return;
131
+ }
132
+ if (event.target.currentTime > (event.target.duration / 4) && event.target.currentTime < (event.target.duration / 2) && videoTrackingObj[videoPath].played25 === false) {
133
+ plausible("Video: 25% Played", { props: { page: pagePath, video: videoPath } });
134
+ videoTrackingObj[videoPath].played25 = true;
135
+ }
136
+ if (event.target.currentTime > (event.target.duration / 2) && event.target.currentTime < ((event.target.duration / 4) * 3) && videoTrackingObj[videoPath].played50 === false) {
137
+ plausible("Video: 50% Played", { props: { page: pagePath, video: videoPath } });
138
+ videoTrackingObj[videoPath].played50 = true;
139
+ }
140
+ if (event.target.currentTime > ((event.target.duration / 4) * 3) && videoTrackingObj[videoPath].played75 === false) {
141
+ plausible("Video: 75% Played", { props: { page: pagePath, video: videoPath } });
142
+ videoTrackingObj[videoPath].played75 = true;
143
+ }
144
+
145
+ }
146
+
147
+ function trackVideoEndedWithPlausible(event) {
148
+ let pagePath = new URL(event.target.baseURI).pathname;
149
+ let videoPath = new URL(event.target.currentSrc).pathname;
150
+ // Track video reached end
151
+ plausible("Video: Ended", { props: { page: pagePath, video: videoPath } });
152
+ }
153
+ </script>
154
+
155
+ <!---->
156
+ {% endblock %}
_overrides/partials/actions.html ADDED
@@ -0,0 +1,57 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ <!--
2
+ Copyright (c) 2016-2024 Martin Donath <martin.donath@squidfunk.com>
3
+
4
+ Permission is hereby granted, free of charge, to any person obtaining a copy
5
+ of this software and associated documentation files (the "Software"), to
6
+ deal in the Software without restriction, including without limitation the
7
+ rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
8
+ sell copies of the Software, and to permit persons to whom the Software is
9
+ furnished to do so, subject to the following conditions:
10
+
11
+ The above copyright notice and this permission notice shall be included in
12
+ all copies or substantial portions of the Software.
13
+
14
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16
+ FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
17
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
19
+ FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
20
+ IN THE SOFTWARE.
21
+ -->
22
+
23
+ <!-- Actions -->
24
+ {% if page.edit_url %}
25
+
26
+ <!-- Edit button -->
27
+ <!-- n8n CUSTOM: open in new tab -->
28
+ {% if "content.action.edit" in features %}
29
+ <a
30
+ href="{{ page.edit_url }}"
31
+ title="{{ lang.t('action.edit') }}"
32
+ class="md-content__button md-icon"
33
+ target="_blank"
34
+ >
35
+ {% set icon = config.theme.icon.edit or "material/file-edit-outline" %}
36
+ {% include ".icons/" ~ icon ~ ".svg" %}
37
+ </a>
38
+ {% endif %}
39
+
40
+ <!-- View button -->
41
+ {% if "content.action.view" in features %}
42
+ {% if "/blob/" in page.edit_url %}
43
+ {% set part = "blob" %}
44
+ {% else %}
45
+ {% set part = "edit" %}
46
+ {% endif %}
47
+ <a
48
+ href="{{ page.edit_url | replace(part, 'raw') }}"
49
+ title="{{ lang.t('action.view') }}"
50
+ class="md-content__button md-icon"
51
+ target="_blank"
52
+ >
53
+ {% set icon = config.theme.icon.view or "material/file-eye-outline" %}
54
+ {% include ".icons/" ~ icon ~ ".svg" %}
55
+ </a>
56
+ {% endif %}
57
+ {% endif %}
_overrides/partials/footer.html ADDED
@@ -0,0 +1,62 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ <footer class="md-footer">
2
+ {% if "navigation.footer" in features %}
3
+ {% if page.previous_page or page.next_page %}
4
+ {% if page.meta and page.meta.hide %}
5
+ {% set hidden = "hidden" if "footer" in page.meta.hide %}
6
+ {% endif %}
7
+ <nav class="md-footer__inner md-grid" aria-label="{{ lang.t('footer') }}" {{ hidden }}>
8
+ {% if page.previous_page %}
9
+ {% set direction = lang.t("footer.previous") %}
10
+ <a href="{{ page.previous_page.url | url }}" class="md-footer__link md-footer__link--prev" aria-label="{{ direction }}: {{ page.previous_page.title | e }}">
11
+ <div class="md-footer__button md-icon">
12
+ {% set icon = config.theme.icon.previous or "material/arrow-left" %}
13
+ {% include ".icons/" ~ icon ~ ".svg" %}
14
+ </div>
15
+ <div class="md-footer__title">
16
+ <span class="md-footer__direction">
17
+ {{ direction }}
18
+ </span>
19
+ <div class="md-ellipsis">
20
+ {{ page.previous_page.title }}
21
+ </div>
22
+ </div>
23
+ </a>
24
+ {% endif %}
25
+ {% if page.next_page %}
26
+ {% set direction = lang.t("footer.next") %}
27
+ <a href="{{ page.next_page.url | url }}" class="md-footer__link md-footer__link--next" aria-label="{{ direction }}: {{ page.next_page.title | e }}">
28
+ <div class="md-footer__title">
29
+ <span class="md-footer__direction">
30
+ {{ direction }}
31
+ </span>
32
+ <div class="md-ellipsis">
33
+ {{ page.next_page.title }}
34
+ </div>
35
+ </div>
36
+ <div class="md-footer__button md-icon">
37
+ {% set icon = config.theme.icon.next or "material/arrow-right" %}
38
+ {% include ".icons/" ~ icon ~ ".svg" %}
39
+ </div>
40
+ </a>
41
+ {% endif %}
42
+ </nav>
43
+ {% endif %}
44
+ {% endif %}
45
+ {% include "partials/sub-footer.html" %}
46
+ <div class="md-footer-meta md-typeset">
47
+ <div class="md-footer-meta__inner md-grid">
48
+ <!-- n8n CUSTOM: More links to the main website -->
49
+ <div class="n8n-footer-links">
50
+ <a href="https://n8n.io/pricing/" target="_blank">Pricing ↗</a>
51
+ <a href="https://n8n.io/workflows/" target="_blank">Workflow templates ↗</a>
52
+ <a href="https://n8n.io/features/" target="_blank">Feature highlights ↗</a>
53
+ <a href="https://n8n.io/ai/" target="_blank">AI highlights ↗</a>
54
+ </div>
55
+ {% include "partials/copyright.html" %}
56
+ {% if config.extra.social %}
57
+ {% include "partials/social.html" %}
58
+ {% endif %}
59
+
60
+ </div>
61
+ </div>
62
+ </footer>
_overrides/partials/header.html ADDED
@@ -0,0 +1,136 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ <!-- Determine base classes -->
2
+ {% set class = "md-header" %}
3
+ {% if "navigation.tabs.sticky" in features %}
4
+ {% set class = class ~ " md-header--lifted" %}
5
+ {% endif %}
6
+
7
+ <!-- Header -->
8
+ <header class="{{ class }}" data-md-component="header">
9
+
10
+ <nav
11
+ class="md-header__inner md-grid"
12
+ aria-label="{{ lang.t('header.title') }}"
13
+ >
14
+
15
+ <!-- Link to home -->
16
+ <a
17
+ href="{{ config.extra.homepage | d(nav.homepage.url, true) | url }}"
18
+ title="{{ config.site_name | e }}"
19
+ class="md-header__button md-logo"
20
+ aria-label="{{ config.site_name }}"
21
+ data-md-component="logo"
22
+ >
23
+ {% include "partials/logo.html" %}
24
+ </a>
25
+
26
+ <!-- Button to open drawer -->
27
+ <label class="md-header__button md-icon" for="__drawer">
28
+ {% include ".icons/material/menu" ~ ".svg" %}
29
+ </label>
30
+
31
+ <!-- Header title -->
32
+ <!-- n8n CUSTOM: remove the page title section. This pairs with custom CSS to keep the site
33
+ title in place on scroll -->
34
+ <div class="md-header__title" data-md-component="header-title">
35
+ <div class="md-header__ellipsis">
36
+ <div class="md-header__topic">
37
+ <span class="md-ellipsis">
38
+ {{ config.site_name }}
39
+ </span>
40
+ </div>
41
+ </div>
42
+ </div>
43
+ </div>
44
+
45
+ <!-- Color palette -->
46
+ {% if not config.theme.palette is mapping %}
47
+ <form class="md-header__option" data-md-component="palette">
48
+ {% for option in config.theme.palette %}
49
+ {% set scheme = option.scheme | d("default", true) %}
50
+ {% set primary = option.primary %}
51
+ {% set accent = option.accent %}
52
+ <input
53
+ class="md-option"
54
+ data-md-color-media="{{ option.media }}"
55
+ data-md-color-scheme="{{ scheme | replace(' ', '-') }}"
56
+ data-md-color-primary="{{ primary | replace(' ', '-') }}"
57
+ data-md-color-accent="{{ accent | replace(' ', '-') }}"
58
+ {% if option.toggle %}
59
+ aria-label="{{ option.toggle.name }}"
60
+ {% else %}
61
+ aria-hidden="true"
62
+ {% endif %}
63
+ type="radio"
64
+ name="__palette"
65
+ id="__palette_{{ loop.index0 }}"
66
+ />
67
+ {% if option.toggle %}
68
+ <label
69
+ class="md-header__button md-icon"
70
+ title="{{ option.toggle.name }}"
71
+ for="__palette_{{ loop.index % loop.length }}"
72
+ hidden
73
+ >
74
+ {% include ".icons/" ~ option.toggle.icon ~ ".svg" %}
75
+ </label>
76
+ {% endif %}
77
+ {% endfor %}
78
+ </form>
79
+ {% endif %}
80
+
81
+ <!-- User preference: color palette -->
82
+ {% if not config.theme.palette is mapping %}
83
+ {% include "partials/javascripts/palette.html" %}
84
+ {% endif %}
85
+
86
+ <!-- Site language selector -->
87
+ {% if config.extra.alternate %}
88
+ <div class="md-header__option"></form>
89
+ <div class="md-select">
90
+ {% set icon = config.theme.icon.alternate or "material/translate" %}
91
+ <button
92
+ class="md-header__button md-icon"
93
+ aria-label="{{ lang.t('select.language.title') }}"
94
+ >
95
+ {% include ".icons/" ~ icon ~ ".svg" %}
96
+ </button>
97
+ <div class="md-select__inner">
98
+ <ul class="md-select__list">
99
+ {% for alt in config.extra.alternate %}
100
+ <li class="md-select__item">
101
+ <a
102
+ href="{{ alt.link | url }}"
103
+ hreflang="{{ alt.lang }}"
104
+ class="md-select__link"
105
+ >
106
+ {{ alt.name }}
107
+ </a>
108
+ </li>
109
+ {% endfor %}
110
+ </ul>
111
+ </div>
112
+ </div>
113
+ </div>
114
+ {% endif %}
115
+
116
+ <!-- Button to open search modal -->
117
+ {% if "material/search" in config.plugins %}
118
+ <label class="md-header__button md-icon" for="__search">
119
+ {% include ".icons/material/magnify.svg" %}
120
+ </label>
121
+
122
+ <!-- Search interface -->
123
+ {% include "partials/search.html" %}
124
+ {% endif %}
125
+
126
+ <!-- Repository information -->
127
+ <!-- n8n CUSTOM: don't show GitHub link -->
128
+ </nav>
129
+
130
+ <!-- Navigation tabs (sticky) -->
131
+ {% if "navigation.tabs.sticky" in features %}
132
+ {% if "navigation.tabs" in features %}
133
+ {% include "partials/tabs.html" %}
134
+ {% endif %}
135
+ {% endif %}
136
+ </header>
_overrides/partials/javascripts/consent.html ADDED
@@ -0,0 +1,87 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ <!-- START CUSTOM CODE -->
2
+ <!--
3
+ n8n's cookie consent handling
4
+ Ensures cookie consent applies across all .n8n.io properties
5
+ -->
6
+ <script>
7
+ // If the user has accepted cookies, set the n8n-consent cookie
8
+ // This means if they then go to the main website, they won't be prompted again
9
+ let docsConsent = __md_get("__consent")
10
+ let d = new Date();
11
+ d.setTime(d.getTime() + 5 * 24 * 60 * 60 * 1000);
12
+ let n8nCookie = {'consent': true};
13
+ // When user clicks Accept on the consent form, page reloads and this sets
14
+ // DEBUG TIP: If it breaks, first thing to do is check the page reload is still happening
15
+ if (docsConsent && docsConsent.analytics === true) {
16
+ document.cookie = `n8n-consent=${JSON.stringify(n8nCookie)};expires=${d.toUTCString()};path=/;domain=.n8n.io`;
17
+ }
18
+
19
+ // If the user already has the n8n-consent cookie, accept cookies in docs as well
20
+ let getn8nCookie = getCookie("n8n-consent");
21
+ if(getn8nCookie) {
22
+ var parsedn8nCookie = JSON.parse(getn8nCookie);
23
+ }
24
+ if(parsedn8nCookie && parsedn8nCookie.consent === true) {
25
+ // Note that Material uses local storage to remember cookie settings
26
+ __md_set("__consent", {"analytics": true});
27
+ }
28
+
29
+ // Function to help with extracting cookies by name
30
+ function getCookie(cname) {
31
+ let name = cname + "=";
32
+ let decodedCookie = decodeURIComponent(document.cookie);
33
+ let ca = decodedCookie.split(';');
34
+ for(let i = 0; i <ca.length; i++) {
35
+ let c = ca[i];
36
+ while (c.charAt(0) == ' ') {
37
+ c = c.substring(1);
38
+ }
39
+ if (c.indexOf(name) == 0) {
40
+ return c.substring(name.length, c.length);
41
+ }
42
+ }
43
+ return "";
44
+ }
45
+ </script>
46
+ <!-- END CUSTOM CODE -->
47
+
48
+ <!-- User-preference: consent -->
49
+ <script>
50
+ var consent = __md_get("__consent")
51
+ if (consent) {
52
+ for (var input of document.forms.consent.elements)
53
+ if (input.name)
54
+ input.checked = consent[input.name] || false
55
+
56
+ /* Show consent with a small delay, but not if browsing locally */
57
+ } else if (location.protocol !== "file:") {
58
+ setTimeout(function() {
59
+ var el = document.querySelector("[data-md-component=consent]")
60
+ el.hidden = false
61
+ }, 250)
62
+ }
63
+
64
+ /* Intercept submission of consent form */
65
+ var form = document.forms.consent
66
+ for (var action of ["submit", "reset"])
67
+ form.addEventListener(action, function(ev) {
68
+ ev.preventDefault()
69
+
70
+ /* Reject all cookies */
71
+ if (ev.type === "reset")
72
+ for (var input of document.forms.consent.elements)
73
+ if (input.name)
74
+ input.checked = false
75
+
76
+ /* Grab and serialize form data */
77
+ console.log(new FormData(form))
78
+ __md_set("__consent", Object.fromEntries(
79
+ Array.from(new FormData(form).keys())
80
+ .map(function(key) { return [key, true] })
81
+ ))
82
+
83
+ /* Remove anchor to omit consent from reappearing and reload */
84
+ location.hash = '';
85
+ location.reload()
86
+ })
87
+ </script>
_overrides/partials/languages/custom.html ADDED
@@ -0,0 +1,12 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ <!-- this exists as a workaround for If not showing up in search
2
+ We may be able to remove it when Martin releases the new search
3
+ https://github.com/squidfunk/mkdocs-material/issues/5363#issuecomment-1518557438 -->
4
+ {% import "partials/languages/en.html" as language %}
5
+ <!-- Mind the whitespace, won't be necessary in the future -->
6
+ {% macro override(key) %}{{ {
7
+ "search.config.pipeline": " ",
8
+ }[key] }}{% endmacro %}
9
+
10
+ {% macro t(key) %}{{
11
+ override(key) or language.t(key)
12
+ }}{% endmacro %}
_overrides/partials/sub-footer.html ADDED
@@ -0,0 +1,365 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ <div id="subFooter" class="sub-footer">
2
+ <div class="sub-footer-container">
3
+ <div class="footer-columns">
4
+ <div>
5
+ <div class="column-name">Popular integrations</div>
6
+ <ul class="col-links">
7
+ <li>
8
+ <a href="https://n8n.io/integrations/google-sheets/" class="footer-link" target="_blank"> Google
9
+ Sheets </a>
10
+ </li>
11
+ <li>
12
+ <a href="https://n8n.io/integrations/telegram/" class="footer-link" target="_blank"> Telegram
13
+ </a>
14
+ </li>
15
+ <li>
16
+ <a href="https://n8n.io/integrations/mysql/" class="footer-link" target="_blank"> MySQL </a>
17
+ </li>
18
+ <li>
19
+ <a href="https://n8n.io/integrations/slack/" class="footer-link" target="_blank"> Slack </a>
20
+ </li>
21
+ <li>
22
+ <a href="https://n8n.io/integrations/discord/" class="footer-link" target="_blank"> Discord </a>
23
+ </li>
24
+ <li>
25
+ <a href="https://n8n.io/integrations/postgres/" class="footer-link" target="_blank"> Postgres
26
+ </a>
27
+ </li>
28
+ <li class="hidden-link">
29
+ <a href="https://n8n.io/integrations/notion/" class="footer-link" target="_blank"> Notion </a>
30
+ </li>
31
+ <li class="hidden-link">
32
+ <a href="https://n8n.io/integrations/gmail/" class="footer-link" target="_blank"> Gmail </a>
33
+ </li>
34
+ <li class="hidden-link">
35
+ <a href="https://n8n.io/integrations/airtable/" class="footer-link" target="_blank"> Airtable
36
+ </a>
37
+ </li>
38
+ <li class="hidden-link">
39
+ <a href="https://n8n.io/integrations/google-drive/" class="footer-link" target="_blank"> Google
40
+ Drive </a>
41
+ </li>
42
+ </ul>
43
+ <div class="bottom-link hidden-link">
44
+ <a href="https://n8n.io/integrations/" class="footer-link" target="_blank">
45
+ Show more integrations
46
+ <svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 10 10" width="7px"
47
+ height="7px">
48
+ <g clip-path="url(#a)">
49
+ <path fill="#111010" fill-rule="evenodd"
50
+ d="M7.678 1.36H.481V0H10v9.52H8.64v-7.2L.962 10 0 9.038 7.678 1.36Z"
51
+ clip-rule="evenodd"></path>
52
+ </g>
53
+ <defs>
54
+ <clipPath id="a">
55
+ <path fill="#fff" d="M0 0h10v10H0z"></path>
56
+ </clipPath>
57
+ </defs>
58
+ </svg>
59
+ </a>
60
+ </div>
61
+ <button type="button" class="footer-link footer-link--more"
62
+ onclick="document.getElementById('subFooter').classList.toggle('sub-footer--full')"></button>
63
+ </div>
64
+ <div>
65
+ <div class="column-name">Trending combinations</div>
66
+ <ul class="col-links">
67
+ <li>
68
+ <a href="https://n8n.io/integrations/hubspot/and/salesforce/" class="footer-link"
69
+ target="_blank">
70
+ HubSpot and Salesforce
71
+ </a>
72
+ </li>
73
+ <li>
74
+ <a href="https://n8n.io/integrations/twilio/and/whatsapp-business-cloud/" class="footer-link"
75
+ target="_blank">
76
+ Twilio and WhatsApp
77
+ </a>
78
+ </li>
79
+ <li>
80
+ <a href="https://n8n.io/integrations/github/and/jira-software/" class="footer-link"
81
+ target="_blank">
82
+ GitHub and Jira
83
+ </a>
84
+ </li>
85
+ <li>
86
+ <a href="https://n8n.io/integrations/asana/and/slack/" class="footer-link" target="_blank">
87
+ Asana and Slack </a>
88
+ </li>
89
+ <li>
90
+ <a href="https://n8n.io/integrations/asana/and/salesforce/" class="footer-link" target="_blank">
91
+ Asana and Salesforce
92
+ </a>
93
+ </li>
94
+ <li>
95
+ <a href="https://n8n.io/integrations/jira-software/and/slack/" class="footer-link"
96
+ target="_blank">
97
+ Jira and Slack
98
+ </a>
99
+ </li>
100
+ <li class="hidden-link">
101
+ <a href="https://n8n.io/integrations/jira-software/and/salesforce/" class="footer-link"
102
+ target="_blank">
103
+ Jira and Salesforce
104
+ </a>
105
+ </li>
106
+ <li class="hidden-link">
107
+ <a href="https://n8n.io/integrations/github/and/slack/" class="footer-link" target="_blank">
108
+ GitHub and Slack </a>
109
+ </li>
110
+ <li class="hidden-link">
111
+ <a href="https://n8n.io/integrations/hubspot/and/quickbooks-online/" class="footer-link"
112
+ target="_blank">
113
+ HubSpot and QuickBooks
114
+ </a>
115
+ </li>
116
+ <li class="hidden-link">
117
+ <a href="https://n8n.io/integrations/hubspot/and/slack/" class="footer-link" target="_blank">
118
+ HubSpot and Slack </a>
119
+ </li>
120
+ </ul>
121
+ <div class="bottom-link hidden-link">
122
+ <a href="https://n8n.io/integrations/" class="footer-link" target="_blank">
123
+ Show more integrations
124
+ <svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 10 10" width="7px"
125
+ height="7px">
126
+ <g clip-path="url(#a)">
127
+ <path fill="#111010" fill-rule="evenodd"
128
+ d="M7.678 1.36H.481V0H10v9.52H8.64v-7.2L.962 10 0 9.038 7.678 1.36Z"
129
+ clip-rule="evenodd"></path>
130
+ </g>
131
+ <defs>
132
+ <clipPath id="a">
133
+ <path fill="#fff" d="M0 0h10v10H0z"></path>
134
+ </clipPath>
135
+ </defs>
136
+ </svg>
137
+ </a>
138
+ </div>
139
+ <button type="button" class="footer-link footer-link--more"
140
+ onclick="document.getElementById('subFooter').classList.toggle('sub-footer--full')"></button>
141
+ </div>
142
+ <div>
143
+ <div class="column-name">Top integration categories</div>
144
+ <ul class="col-links">
145
+ <li>
146
+ <a href="https://n8n.io/integrations/categories/development/" class="footer-link"
147
+ target="_blank"> Development </a>
148
+ </li>
149
+ <li>
150
+ <a href="https://n8n.io/integrations/categories/communication/" class="footer-link"
151
+ target="_blank">
152
+ Communication
153
+ </a>
154
+ </li>
155
+ <li>
156
+ <a href="https://n8n.io/integrations/categories/langchain/" class="footer-link" target="_blank">
157
+ Langchain </a>
158
+ </li>
159
+ <li>
160
+ <a href="https://n8n.io/integrations/categories/ai/" class="footer-link" target="_blank"> AI
161
+ </a>
162
+ </li>
163
+ <li>
164
+ <a href="https://n8n.io/integrations/categories/data-and-storage/" class="footer-link"
165
+ target="_blank">
166
+ Data &amp; Storage
167
+ </a>
168
+ </li>
169
+ <li>
170
+ <a href="https://n8n.io/integrations/categories/marketing/" class="footer-link" target="_blank">
171
+ Marketing </a>
172
+ </li>
173
+ <li class="hidden-link">
174
+ <a href="https://n8n.io/integrations/categories/productivity/" class="footer-link"
175
+ target="_blank">
176
+ Productivity
177
+ </a>
178
+ </li>
179
+ <li class="hidden-link">
180
+ <a href="https://n8n.io/integrations/categories/sales/" class="footer-link" target="_blank">
181
+ Sales </a>
182
+ </li>
183
+ <li class="hidden-link">
184
+ <a href="https://n8n.io/integrations/categories/utility/" class="footer-link" target="_blank">
185
+ Utility </a>
186
+ </li>
187
+ <li class="hidden-link">
188
+ <a href="https://n8n.io/integrations/categories/miscellaneous/" class="footer-link"
189
+ target="_blank">
190
+ Miscellaneous
191
+ </a>
192
+ </li>
193
+ </ul>
194
+ <div class="bottom-link hidden-link">
195
+ <a href="https://n8n.io/integrations/" class="footer-link" target="_blank">
196
+ Explore more categories
197
+ <svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 10 10" width="7px"
198
+ height="7px">
199
+ <g clip-path="url(#a)">
200
+ <path fill="#111010" fill-rule="evenodd"
201
+ d="M7.678 1.36H.481V0H10v9.52H8.64v-7.2L.962 10 0 9.038 7.678 1.36Z"
202
+ clip-rule="evenodd"></path>
203
+ </g>
204
+ <defs>
205
+ <clipPath id="a">
206
+ <path fill="#fff" d="M0 0h10v10H0z"></path>
207
+ </clipPath>
208
+ </defs>
209
+ </svg>
210
+ </a>
211
+ </div>
212
+ <button type="button" class="footer-link footer-link--more"
213
+ onclick="document.getElementById('subFooter').classList.toggle('sub-footer--full')"></button>
214
+ </div>
215
+ <div>
216
+ <div class="column-name">Trending templates</div>
217
+ <ul class="col-links">
218
+ <li>
219
+ <a href="https://n8n.io/workflows/1750-creating-an-api-endpoint/" class="footer-link"
220
+ target="_blank">
221
+ Creating an API endpoint
222
+ </a>
223
+ </li>
224
+ <li>
225
+ <a href="https://n8n.io/workflows/1954-ai-agent-chat/" class="footer-link" target="_blank">
226
+ AI agent chat
227
+ </a>
228
+ </li>
229
+ <li>
230
+ <a href="https://n8n.io/workflows/1951-scrape-and-summarize-webpages-with-ai/"
231
+ class="footer-link" target="_blank">
232
+ Scrape and summarize webpages with AI
233
+ </a>
234
+ </li>
235
+ <li>
236
+ <a href="https://n8n.io/workflows/1700-very-quick-quickstart/" class="footer-link"
237
+ target="_blank">
238
+ Very quick quickstart
239
+ </a>
240
+ </li>
241
+ <li>
242
+ <a href="https://n8n.io/workflows/1748-pulling-data-from-services-that-n8n-doesnt-have-a-pre-built-integration-for/"
243
+ class="footer-link" target="_blank">
244
+ Pulling data from services that n8n doesn’t have a pre-built integration for
245
+ </a>
246
+ </li>
247
+ <li>
248
+ <a href="https://n8n.io/workflows/1747-joining-different-datasets/" class="footer-link"
249
+ target="_blank">
250
+ Joining different datasets
251
+ </a>
252
+ </li>
253
+ <li class="hidden-link">
254
+ <a href="https://n8n.io/workflows/1534-back-up-your-n8n-workflows-to-github/"
255
+ class="footer-link" target="_blank">
256
+ Back Up Your n8n Workflows To Github
257
+ </a>
258
+ </li>
259
+ <li class="hidden-link">
260
+ <a href="https://n8n.io/workflows/1862-openai-gpt-3-company-enrichment-from-website-content/"
261
+ class="footer-link" target="_blank">
262
+ OpenAI GPT-3: Company Enrichment from website content
263
+ </a>
264
+ </li>
265
+ <li class="hidden-link">
266
+ <a href="https://n8n.io/workflows/2006-ai-agent-that-can-scrape-webpages/" class="footer-link"
267
+ target="_blank">
268
+ AI agent that can scrape webpages
269
+ </a>
270
+ </li>
271
+ <li class="hidden-link">
272
+ <a href="https://n8n.io/workflows/1435-convert-json-to-an-excel-file/" class="footer-link"
273
+ target="_blank">
274
+ Convert JSON to an Excel file
275
+ </a>
276
+ </li>
277
+ </ul>
278
+ <div class="bottom-link hidden-link">
279
+ <a href="https://n8n.io/workflows/" class="footer-link" target="_blank">
280
+ Explore 800+ workflow templates
281
+ <svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 10 10" width="7px"
282
+ height="7px">
283
+ <g clip-path="url(#a)">
284
+ <path fill="#111010" fill-rule="evenodd"
285
+ d="M7.678 1.36H.481V0H10v9.52H8.64v-7.2L.962 10 0 9.038 7.678 1.36Z"
286
+ clip-rule="evenodd"></path>
287
+ </g>
288
+ <defs>
289
+ <clipPath id="a">
290
+ <path fill="#fff" d="M0 0h10v10H0z"></path>
291
+ </clipPath>
292
+ </defs>
293
+ </svg>
294
+ </a>
295
+ </div>
296
+ <button type="button" class="footer-link footer-link--more"
297
+ onclick="document.getElementById('subFooter').classList.toggle('sub-footer--full')"></button>
298
+ </div>
299
+ <div>
300
+ <div class="column-name">Top guides</div>
301
+ <ul class="col-links">
302
+ <li>
303
+ <a href="https://blog.n8n.io/telegram-bots/" class="footer-link" target="_blank"> Telegram bots
304
+ </a>
305
+ </li>
306
+ <li>
307
+ <a href="https://blog.n8n.io/open-source-chatbot/" class="footer-link" target="_blank">
308
+ Open-source chatbot </a>
309
+ </li>
310
+ <li>
311
+ <a href="https://blog.n8n.io/open-source-llm/" class="footer-link" target="_blank"> Open-source
312
+ LLM </a>
313
+ </li>
314
+ <li>
315
+ <a href="https://blog.n8n.io/open-source-low-code-platforms/" class="footer-link"
316
+ target="_blank"> Open-source low-code platforms </a>
317
+ </li>
318
+ <li>
319
+ <a href="https://blog.n8n.io/free-zapier-alternatives/" class="footer-link" target="_blank">
320
+ Zapier alternatives </a>
321
+ </li>
322
+ <li>
323
+ <a href="https://blog.n8n.io/make-vs-zapier/" class="footer-link" target="_blank"> Make vs
324
+ Zapier </a>
325
+ </li>
326
+ <li class="hidden-link">
327
+ <a href="https://blog.n8n.io/ai-agents/" class="footer-link" target="_blank"> AI agents </a>
328
+ </li>
329
+ <li class="hidden-link">
330
+ <a href="https://blog.n8n.io/ai-coding-assistants/" class="footer-link" target="_blank"> AI
331
+ coding assistants </a>
332
+ </li>
333
+ <li class="hidden-link">
334
+ <a href="https://blog.n8n.io/create-chatgpt-discord-bot/" class="footer-link" target="_blank">
335
+ ChatGPT Discord bot </a>
336
+ </li>
337
+ <li class="hidden-link">
338
+ <a href="https://blog.n8n.io/best-ai-chatbot/" class="footer-link" target="_blank"> Best AI
339
+ chatbot </a>
340
+ </li>
341
+ </ul>
342
+ <div class="bottom-link hidden-link">
343
+ <a href="https://blog.n8n.io/" class="footer-link" target="_blank">
344
+ Show guides
345
+ <svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 10 10" width="7px"
346
+ height="7px">
347
+ <g clip-path="url(#a)">
348
+ <path fill="#111010" fill-rule="evenodd"
349
+ d="M7.678 1.36H.481V0H10v9.52H8.64v-7.2L.962 10 0 9.038 7.678 1.36Z"
350
+ clip-rule="evenodd"></path>
351
+ </g>
352
+ <defs>
353
+ <clipPath id="a">
354
+ <path fill="#fff" d="M0 0h10v10H0z"></path>
355
+ </clipPath>
356
+ </defs>
357
+ </svg>
358
+ </a>
359
+ </div>
360
+ <button type="button" class="footer-link footer-link--more"
361
+ onclick="document.getElementById('subFooter').classList.toggle('sub-footer--full')"></button>
362
+ </div>
363
+ </div>
364
+ </div>
365
+ </div>
_overrides/partials/tabs.html ADDED
@@ -0,0 +1,16 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {% import "partials/tabs-item.html" as item with context %}
2
+ <nav class="md-tabs" aria-label="{{ lang.t('tabs') }}" data-md-component="tabs">
3
+ <div class="md-grid n8n-other-sites">
4
+ <ul class="md-tabs__list">
5
+ {% for nav_item in nav %}
6
+ {{ item.render(nav_item) }}
7
+ {% endfor %}
8
+ </ul>
9
+ <!-- n8n CUSTOM: additional nav to link to other n8n sites -->
10
+ <ul class="md-tabs__list">
11
+ <li class="md-tabs__item"><a href="https://n8n.io/" class="md-tabs__link" target="_blank">n8n home ↗</a></li>
12
+ <li class="md-tabs__item"><a href="https://community.n8n.io/" class="md-tabs__link" target="_blank">Forum ↗</a></li>
13
+ <li class="md-tabs__item"><a href="https://blog.n8n.io/" class="md-tabs__link" target="_blank">Blog ↗</a></li>
14
+ </ul>
15
+ </div>
16
+ </nav>
_snippets/code/ai-how-to.md ADDED
@@ -0,0 +1,14 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ /// info | Feature availability
2
+ AI assistance in the Code node is available to Cloud users. It isn't available in self-hosted n8n.
3
+ ///
4
+
5
+ /// note | AI generated code overwrites your code
6
+ If you've already written some code on the **Code** tab, the AI generated code will replace it. n8n recommends using AI as a starting point to create your initial code, then editing it as needed.
7
+ ///
8
+
9
+ To use ChatGPT to generate code in the Code node:
10
+
11
+ 1. In the Code node, set **Language** to **JavaScript**.
12
+ 1. Select the **Ask AI** tab.
13
+ 1. Write your query.
14
+ 1. Select **Generate Code**. n8n sends your query to ChatGPT, then displays the result in the **Code** tab.
_snippets/data-function-code/smartjoin.md ADDED
@@ -0,0 +1,6 @@
 
 
 
 
 
 
 
1
+ ```js
2
+ // Input
3
+ {{ [{"type":"fruit", "name":"apple"},{"type":"vegetable", "name":"carrot"} ].smartJoin("type","name") }}
4
+ // Output
5
+ [Object: {"fruit":"apple","vegetable":"carrot"}]
6
+ ```
_snippets/data/data-mapping/item-linking-code-node.md ADDED
@@ -0,0 +1,97 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ Use n8n's item linking to access data from items that precede the current item. It also has implications when using the Code node. Most nodes link every output item to an input item. This creates a chain of items that you can work back along to access previous items. For a deeper conceptual overview of this topic, refer to [Item linking concepts](/data/data-mapping/data-item-linking/item-linking-concepts.md). This document focuses on practical usage examples.
2
+
3
+ When using the Code node, there are some scenarios where you need to manually supply item linking information if you want to be able to use `$("<node-name>").item` later in the workflow. All these scenarios only apply if you have more than one incoming item. n8n automatically handles item linking for single items.
4
+
5
+ These scenarios are when you:
6
+
7
+ * Add new items: the new items aren't linked to any input.
8
+ * Return new items.
9
+ * Want to manually control the item linking.
10
+
11
+ [n8n's automatic item linking](/data/data-mapping/data-item-linking/item-linking-concepts.md) handles the other scenarios.
12
+
13
+ To control item linking, set `pairedItem` when returning data. For example, to link to the item at index 0:
14
+
15
+ ```js
16
+ [
17
+ {
18
+ "json": {
19
+ . . .
20
+ },
21
+ // The index of the input item that generated this output item
22
+ "pairedItem": 0
23
+ }
24
+ ]
25
+ ```
26
+
27
+
28
+ ### `pairedItem` usage example
29
+
30
+ Take this input data:
31
+
32
+ ```json
33
+ [
34
+ {
35
+ "id": "23423532",
36
+ "name": "Jay Gatsby"
37
+ },
38
+ {
39
+ "id": "23423533",
40
+ "name": "José Arcadio Buendía"
41
+ },
42
+ {
43
+ "id": "23423534",
44
+ "name": "Max Sendak"
45
+ },
46
+ {
47
+ "id": "23423535",
48
+ "name": "Zaphod Beeblebrox"
49
+ },
50
+ {
51
+ "id": "23423536",
52
+ "name": "Edmund Pevensie"
53
+ }
54
+ ]
55
+ ```
56
+
57
+ And use it to generate new items, containing just the name, along with a new piece of data:
58
+
59
+ ```js
60
+ newItems = [];
61
+ for(let i=0; i<items.length; i++){
62
+ newItems.push(
63
+ {
64
+ "json":
65
+ {
66
+ "name": items[i].json.name,
67
+ "aBrandNewField": "New data for item " + i
68
+ }
69
+ }
70
+ )
71
+ }
72
+
73
+ return newItems;
74
+ ```
75
+
76
+ `newItems` is an array of items with no `pairedItem`. This means there's no way to trace back from these items to the items used to generate them.
77
+
78
+ Add the `pairedItem` object:
79
+
80
+ ```js
81
+ newItems = [];
82
+ for(let i=0; i<items.length; i++){
83
+ newItems.push(
84
+ {
85
+ "json":
86
+ {
87
+ "name": items[i].json.name,
88
+ "aBrandNewField": "New data for item " + i
89
+ },
90
+ "pairedItem": i
91
+ }
92
+ )
93
+ }
94
+ return newItems;
95
+ ```
96
+
97
+ Each new item now links to the item used to create it.
_snippets/data/data-mapping/item-linking-node-creators.md ADDED
@@ -0,0 +1,34 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ /// note | Programmatic-style nodes only
2
+ This guidance applies to programmatic-style nodes. If you're using declarative style, n8n handles paired items for you automatically.
3
+ ///
4
+
5
+ Use n8n's item linking to access data from items that precede the current item. n8n needs to know which input item a given output item comes from. If this information is missing, expressions in other nodes may break. As a node developer, you must ensure any items returned by your node support this.
6
+
7
+ This applies to programmatic nodes (including trigger nodes). You don't need to consider item linking when building a declarative-style node. Refer to [Choose your node building approach](/integrations/creating-nodes/plan/choose-node-method.md) for more information on node styles.
8
+
9
+ Start by reading [Item linking concepts](/data/data-mapping/data-item-linking/item-linking-concepts.md), which provides a conceptual overview of item linking, and details of the scenarios where n8n can handle the linking automatically.
10
+
11
+ If you need to handle item linking manually, do this by setting `pairedItem` on each item your node returns:
12
+
13
+ ```typescript
14
+ // Use the pairedItem information of the incoming item
15
+ newItem = {
16
+ "json": { . . . },
17
+ "pairedItem": {
18
+ "item": item.pairedItem,
19
+ // Optional: choose the input to use
20
+ // Set this if your node combines multiple inputs
21
+ "input": 0
22
+ };
23
+
24
+ // Or set the index manually
25
+ newItem = {
26
+ "json": { . . . }
27
+ "pairedItem": {
28
+ "item": i,
29
+ // Optional: choose the input to use
30
+ // Set this if your node combines multiple inputs
31
+ "input": 0
32
+ },
33
+ };
34
+ ```
_snippets/data/how-to-pin-data.md ADDED
@@ -0,0 +1,8 @@
 
 
 
 
 
 
 
 
 
1
+ To pin data in a node:
2
+
3
+ 1. Run the node to load data.
4
+ 2. In the **OUTPUT** view, select **Pin data** <span class="inline-image">![Pin data icon](/_images/data/data-pinning/data-pinning-button.png){.off-glb}</span>. When data pinning is active, the button is disabled and a "This data is pinned" banner is displayed in the **OUTPUT** view.
5
+
6
+ /// note | Nodes that output binary data
7
+ You can't pin data if the output data includes binary data.
8
+ ///
_snippets/embed-license.md ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ /// info | Feature availability
2
+ Embed requires an embed license. For more information about when to use Embed, as well as costs and licensing processes, refer to [Embed](https://n8n.io/embed/){:target=_blank .external-link} on the n8n website.
3
+ ///
_snippets/examples-color-key.md ADDED
@@ -0,0 +1,12 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ To load the template into your n8n instance:
2
+
3
+ 1. Download the workflow JSON file.
4
+ 1. Open a new workflow in your n8n instance.
5
+ 1. Copy in the JSON, or select **Workflow menu** <span class="inline-image">![Workflow menu icon](/_images/common-icons/three-dots-horizontal.png){.off-glb}</span> > **Import from file...**.
6
+
7
+ The example workflows use Sticky Notes to guide you:
8
+
9
+ * Yellow: notes and information.
10
+ * Green: instructions to run the workflow.
11
+ * Orange: you need to change something to make the workflow work.
12
+ * Blue: draws attention to a key feature of the example.
_snippets/flow-logic/create-set-error-workflow.md ADDED
@@ -0,0 +1,8 @@
 
 
 
 
 
 
 
 
 
1
+ 1. Create a new workflow, with the Error Trigger as the first node.
2
+ 2. Give the workflow a name, for example `Error Handler`.
3
+ 3. Select **Save**.
4
+ 4. In the workflow where you want to use this error workflow:
5
+ 1. Select **Options** <span class="inline-image">![Options menu icon](/_images/common-icons/three-dot-options-menu.png){.off-glb}</span> > **Settings**.
6
+ 2. In **Error workflow**, select the workflow you just created. For example, if you used the name Error Handler, select **Error handler**.
7
+ 3. Select **Save**.
8
+ Now, when this workflow errors, the related error workflow runs.
_snippets/flow-logic/data-flow-nodes.md ADDED
@@ -0,0 +1,16 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ Nodes can process multiple items.
2
+
3
+ For example, if you set the Trello node to `Create-Card`, and create an expression that sets `Name` using a property called `name-input-value` from the incoming data, the node creates a card for each item, always choosing the `name-input-value` of the current item.
4
+
5
+ For example, this input will create two cards. One named `test1` the other one named `test2`:
6
+
7
+ ```json
8
+ [
9
+ {
10
+ name-input-value: "test1"
11
+ },
12
+ {
13
+ name-input-value: "test2"
14
+ }
15
+ ]
16
+ ```
_snippets/flow-logic/subworkflow-data-flow.md ADDED
@@ -0,0 +1,4 @@
 
 
 
 
 
1
+ As an example, imagine you have an Execute Sub-workflow node in **Workflow A**. The Execute Sub-workflow node calls another workflow called **Workflow B**:
2
+
3
+ 1. The Execute Sub-workflow node passes the data to the Execute Sub-workflow Trigger node (titled "When executed by another node" in the canvas) of **Workflow B**.
4
+ 2. The last node of **Workflow B** sends the data back to the Execute Sub-workflow node in **Workflow A**.
_snippets/flow-logic/subworkflow-usage.md ADDED
@@ -0,0 +1,57 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ### Create the sub-workflow
2
+
3
+
4
+ 1. Create a new workflow.
5
+
6
+ /// note | Create sub-workflows from existing workflows
7
+ You can optionally create a sub-workflow directly from an existing parent workflow using the [Execute Sub-workflow](/integrations/builtin/core-nodes/n8n-nodes-base.executeworkflow.md) node. In the node, select the **Database** and **From list** options and select **Create a sub-workflow** in the list.
8
+
9
+ You can also extract selected nodes directly using [Sub-workflow conversion](/workflows/subworkflow-conversion.md) in the context menu.
10
+ ///
11
+
12
+ 1. **Optional**: configure which workflows can call the sub-workflow:
13
+ 1. Select the **Options** <span class="inline-image">![Options menu](/_images/common-icons/three-dot-options-menu.png){.off-glb}</span> menu > **Settings**. n8n opens the **Workflow settings** modal.
14
+ 1. Change the **This workflow can be called by** setting. Refer to [Workflow settings](/workflows/settings.md) for more information on configuring your workflows.
15
+ 1. Add the **Execute Sub-workflow** trigger node (if you are searching under trigger nodes, this is also titled **When Executed by Another Workflow**).
16
+ 1. Set the **Input data mode** to choose how you will define the sub-workflow's input data:
17
+ * **Define using fields below**: Choose this mode to define individual input names and data types that the calling workflow needs to provide. The [Execute Sub-workflow node](/integrations/builtin/core-nodes/n8n-nodes-base.executeworkflow.md) or [Call n8n Workflow Tool node](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.toolworkflow.md) in the calling workflow will automatically pull in the fields defined here.
18
+ * **Define using JSON example**: Choose this mode to provide an example JSON object that demonstrates the expected input items and their types.
19
+ * **Accept all data**: Choose this mode to accept all data unconditionally. The sub-workflow won't define any required input items. This sub-workflow must handle any input inconsistencies or missing values.
20
+ 1. Add other nodes as needed to build your sub-workflow functionality.
21
+ 1. Save the sub-workflow.
22
+
23
+ /// note | Sub-workflow mustn't contain errors
24
+ If there are errors in the sub-workflow, the parent workflow can't trigger it.
25
+ ///
26
+ /// note | Load data into sub-workflow before building
27
+ This requires the ability to [load data from previous executions](/workflows/executions/debug.md), which is available on n8n Cloud and registered Community plans.
28
+
29
+ If you want to load data into your sub-workflow to use while building it:
30
+
31
+ 1. Create the sub-workflow and add the **Execute Sub-workflow Trigger**.
32
+ 1. Set the node's **Input data mode** to **Accept all data** or define the input items using fields or JSON if they're already known.
33
+ 1. In the sub-workflow [settings](/workflows/settings.md), set **Save successful production executions** to **Save**.
34
+ 1. Skip ahead to setting up the parent workflow, and run it.
35
+ 1. Follow the steps to [load data from previous executions](/workflows/executions/debug.md).
36
+ 1. Adjust the **Input data mode** to match the input sent by the parent workflow if necessary.
37
+
38
+ You can now pin example data in the trigger node, enabling you to work with real data while configuring the rest of the workflow.
39
+ ///
40
+
41
+
42
+ ### Call the sub-workflow
43
+
44
+ 1. Open the workflow where you want to call the sub-workflow.
45
+ 1. Add the **Execute Sub-workflow** node.
46
+ 1. In the **Execute Sub-workflow** node, set the sub-workflow you want to call. You can choose to call the workflow by ID, load a workflow from a local file, add workflow JSON as a parameter in the node, or target a workflow by URL.
47
+
48
+ /// note | Find your workflow ID
49
+ Your sub-workflow's ID is the alphanumeric string at the end of its URL.
50
+ ///
51
+
52
+ 1. Fill in the required input items defined by the sub-workflow.
53
+ 1. Save your workflow.
54
+
55
+ When your workflow executes, it will send data to the sub-workflow, and run it.
56
+
57
+ You can follow the execution flow from the parent workflow to the sub-workflow by opening the Execute Sub-workflow node and selecting the **View sub-execution** link. Likewise, the sub-workflow's execution contains a link back to the parent workflow's execution to navigate in the other direction.
_snippets/integrations/builtin/app-nodes/ai-tools.md ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ /// note | This node can be used as an AI tool
2
+ This node can be used to enhance the capabilities of an AI agent. When used in this way, many parameters can be set automatically, or with information directed by AI - find out more in the [AI tool parameters documentation](/advanced-ai/examples/using-the-fromai-function.md).
3
+ ///
_snippets/integrations/builtin/app-nodes/googlesheets/node-options.md ADDED
@@ -0,0 +1,14 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ - **Cell Format**: Use this option to choose how to format the data in cells. Refer to [Google Sheets API | CellFormat](https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/cells#CellFormat){:target=_blank .external-link} for more information.
2
+ - **Let Google Sheets format** (default): n8n formats text and numbers in the cells according to Google Sheets' default settings.
3
+ - **Let n8n format**: New cells in your sheet will have the same data types as the input data provided by n8n.
4
+ - **Data Location on Sheet**: Use this option when you need to specify the data range on your sheet.
5
+ - **Header Row**: Specify the row index that contains the column headers.
6
+ - **First Data Row**: Specify the row index where the actual data starts.
7
+ - **Handling extra fields in input**: When using **Mapping Column Mode > Map Automatically**, use this option to decide how to handle fields in the input data that don't match any existing columns in the sheet.
8
+ - **Insert in New Column(s)** (default): Adds new columns for any extra data.
9
+ - **Ignore Them**: Ignores extra data that don't match the existing columns.
10
+ - **Error**: Throws an error and stops execution.
11
+ - **Use Append**: Turn on this option to use the [Google API append endpoint](https://developers.google.com/sheets/api/guides/values#append_values){:target=_blank .external-link} for adding new data rows.
12
+ - By default, n8n appends empty rows or columns and then adds the new data. This approach can ensure data alignment but may be less efficient. Using the append endpoint can lead to better performance by minimizing the number of API calls and simplifying the process. But if the existing sheet data has inconsistencies such as gaps or breaks between rows and columns, n8n may add the new data in the wrong place, leading to misalignment issues.
13
+ - Use this option when performance is a priority and the data structure in the sheet is consistent without gaps.
14
+
_snippets/integrations/builtin/app-nodes/operation-not-supported.md ADDED
@@ -0,0 +1,11 @@
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ## What to do if your operation isn't supported
2
+
3
+ If this node doesn't support the operation you want to do, you can use the [HTTP Request node](/integrations/builtin/core-nodes/n8n-nodes-base.httprequest/index.md) to call the service's API.
4
+
5
+ You can use the credential you created for this service in the HTTP Request node:
6
+
7
+ 1. In the HTTP Request node, select **Authentication** > **Predefined Credential Type**.
8
+ 1. Select the service you want to connect to.
9
+ 1. Select your credential.
10
+
11
+ Refer to [Custom API operations](/integrations/custom-operations.md) for more information.
_snippets/integrations/builtin/cluster-nodes/cluster-nodes-summary.md ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ [Cluster nodes](/glossary.md#cluster-node-n8n) are node groups that work together to provide functionality in an n8n workflow. Instead of using a single node, you use a [root node](/glossary.md#root-node-n8n) and one or more [sub-nodes](/glossary.md#sub-node-n8n) that extend the functionality of the node.
2
+
3
+ ![Screenshot of a workflow with a root node and two sub-nodes](/_images/integrations/builtin/cluster-nodes/root-sub-nodes.png)
_snippets/integrations/builtin/cluster-nodes/langchain-doc-loaders-link.md ADDED
@@ -0,0 +1 @@
 
 
1
+ Refer to [LangChain's documentation on document loaders](https://js.langchain.com/docs/modules/data_connection/document_loaders/integrations/file_loaders/){:target=_blank .external-link} for more information about the service.
_snippets/integrations/builtin/cluster-nodes/langchain-overview-link.md ADDED
@@ -0,0 +1 @@
 
 
1
+ View n8n's [Advanced AI](/advanced-ai/index.md) documentation.