Skip to content

Commit

Permalink
new syntax for admonitions
Browse files Browse the repository at this point in the history
  • Loading branch information
StarfallProjects committed Nov 6, 2023
1 parent f7bdf16 commit 551147c
Show file tree
Hide file tree
Showing 608 changed files with 3,406 additions and 3,346 deletions.
6 changes: 3 additions & 3 deletions _snippets/code/ai-how-to.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
!!! note "AI generated code overwrites your code"
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.

/// note | AI generated code overwrites your code
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.
///
To use ChatGPT to generate code in the Code node:

1. In the Code node, set **Language** to **JavaScript**.
Expand Down
6 changes: 3 additions & 3 deletions _snippets/code/tournament-notes.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
!!! note "In version 1.9.0 n8n changed the templating language for expressions"
If you have issues with expressions in 1.9.0:

/// note | In version 1.9.0 n8n changed the templating language for expressions
If you have issues with expressions in 1.9.0:
///
* Please report the issue on the [forums](https://community.n8n.io/){:target=_blank .external-link}.
* Self-hosted users can switch back to RiotTmpl: set `N8N_EXPRESSION_EVALUATOR` to `tmpl`. Refer to [Environment variables](/hosting/environment-variables/) for more information on configuring self-hosted n8n.
6 changes: 3 additions & 3 deletions _snippets/data/data-mapping/item-linking-node-creators.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
!!! note "Programmatic-style nodes only"
This guidance applies to programmatic-style nodes. If you're using declarative style, n8n handles paired items for you automatically.

/// note | Programmatic-style nodes only
This guidance applies to programmatic-style nodes. If you're using declarative style, n8n handles paired items for you automatically.
///
n8n's item linking allows users 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.

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/) for more information on node styles.
Expand Down
5 changes: 3 additions & 2 deletions _snippets/embed-license.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
!!! info "Feature availability"
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.
/// info | Feature availability
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.
///
17 changes: 9 additions & 8 deletions _snippets/flow-logic/subworkflow-usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,12 @@
1. Add other nodes as needed to build your sub-workflow functionality.
1. Save the sub-workflow.

!!! note "Sub-workflow mustn't contain errors"
If there are errors in the sub-workflow, the parent workflow can't trigger it.

!!! note "Load data into sub-workflow before building"
This requires the ability to [load data from previous executions](/workflows/executions/debug/), which is available to Pro and Enterprise users.

/// note | Sub-workflow mustn't contain errors
If there are errors in the sub-workflow, the parent workflow can't trigger it.
///
/// note | Load data into sub-workflow before building
This requires the ability to [load data from previous executions](/workflows/executions/debug/), which is available to Pro and Enterprise users.
///
If you want to load data into your subworkflow to use while building it:

1. Create the subworkflow and add the **Execute Workflow Trigger**.
Expand All @@ -28,8 +28,9 @@
1. Add the **Execute Workflow** node.
1. In the **Execute 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.

!!! note "Find your workflow ID"
Your sub-workflow's ID is the alphanumeric string at the end of its URL.
/// note | Find your workflow ID
Your sub-workflow's ID is the alphanumeric string at the end of its URL.
///

1. Save your workflow.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
!!! note "Parameter resolution in sub-nodes"
Sub-nodes behave differently to other nodes when processing multiple items using an expression.

/// note | Parameter resolution in sub-nodes
Sub-nodes behave differently to other nodes when processing multiple items using an expression.
///
Most nodes, including root nodes, take any number of items as input, process these items, and output the results. You can use expressions to refer to input items, and the node resolves the expression for each item in turn. For example, given an input of five `name` values, the expression `{{ $json.name }}` resolves to each name in turn.

In sub-nodes, the expression always resolves to the first item. For example, given an input of five `name` values, the expression `{{ $json.name }}` always resolves to the first name.
18 changes: 9 additions & 9 deletions _snippets/integrations/builtin/core-nodes/code-node.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
The Code node allows you to write custom JavaScript or Python and run it as a step in your workflow.

!!! note "Coding in n8n"
This page gives usage information about the Code node. For more guidance on coding in n8n, refer to the [Code](/code/) section. It includes:

/// note | Coding in n8n
This page gives usage information about the Code node. For more guidance on coding in n8n, refer to the [Code](/code/) section. It includes:
///
* Reference documentation on [Built-in methods and variables](/code/builtin/)
* Guidance on [Handling dates](/code/luxon/) and [Querying JSON](/code/jmespath/)
* A growing collection of examples in the [Cookbook](/code/cookbook/)

!!! note "Function and Function Item nodes"
The Code node replaces the Function and Function Item nodes from version 0.198.0 onwards. If you're using an older version of n8n, you can still view the [Function node documentation](https://github.com/n8n-io/n8n-docs/blob/67935ad2528e2e30d7984ea917e4af2910a096ec/docs/integrations/builtin/core-nodes/n8n-nodes-base.function.md){:target=_blank .external-link} and [Function Item node documentation](https://github.com/n8n-io/n8n-docs/blob/67935ad2528e2e30d7984ea917e4af2910a096ec/docs/integrations/builtin/core-nodes/n8n-nodes-base.functionItem.md){:target=_blank .external-link}.

/// note | Function and Function Item nodes
The Code node replaces the Function and Function Item nodes from version 0.198.0 onwards. If you're using an older version of n8n, you can still view the [Function node documentation](https://github.com/n8n-io/n8n-docs/blob/67935ad2528e2e30d7984ea917e4af2910a096ec/docs/integrations/builtin/core-nodes/n8n-nodes-base.function.md){:target=_blank .external-link} and [Function Item node documentation](https://github.com/n8n-io/n8n-docs/blob/67935ad2528e2e30d7984ea917e4af2910a096ec/docs/integrations/builtin/core-nodes/n8n-nodes-base.functionItem.md){:target=_blank .external-link}.
///
## Usage

How to use the Code node.
Expand Down Expand Up @@ -47,9 +47,9 @@ The syntax to use the built-in methods and variables is `$variableName` or `$met

n8n added Python support in version 1.0. It doesn't include a Python executable. Instead, n8n provides Python support using [Pyodide](https://pyodide.org/en/stable/){:target=_blank .external-link}, which is a port of CPython to WebAssembly. This limits the available Python packages to the [Packages included with Pyodide](https://pyodide.org/en/stable/usage/packages-in-pyodide.html#packages-in-pyodide){:target=_blank .external-link}. n8n downloads the package automatically the first time you use it.

!!! note "Slower than JavaScript"
The Code node takes longer to process Python than JavaScript. This is due to the additional compilation steps.

/// note | Slower than JavaScript
The Code node takes longer to process Python than JavaScript. This is due to the additional compilation steps.
///
### Built-in methods and variables

n8n provides built-in methods and variables for working with data and accessing n8n data. Refer to [Built-in methods and variables](/code/builtin/) for more information.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
!!! note "API differences"
Different APIs implement pagination in different ways. Check the API documentation for the API you're using for details. You need to find out things like:

/// note | API differences
Different APIs implement pagination in different ways. Check the API documentation for the API you're using for details. You need to find out things like:
///
* Does the API provide the URL for the next page?
* Are there API-specific limits on page size or page number?
* The structure of the data that the API returns.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
!!! info "0.236.0 and below"
n8n removed this execution behavior in version 1.0. This section applies to workflows using the **v0 (legacy)** workflow execution order. By default, this is all workflows built before version 1.0. You can change the execution order in your [workflow settings](/workflows/settings/).

/// info | 0.236.0 and below
n8n removed this execution behavior in version 1.0. This section applies to workflows using the **v0 (legacy)** workflow execution order. By default, this is all workflows built before version 1.0. You can change the execution order in your [workflow settings](/workflows/settings/).
///
If you add a Merge node to a workflow containing an If node, it can result in both output branches of the If node executing.

The Merge node is triggered by one branch, then goes and executes the other branch.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
!!! note "Timezone settings"
The node relies on the timezone setting. n8n uses either:

/// note | Timezone settings
The node relies on the timezone setting. n8n uses either:
///
1. The workflow timezone, if set. Refer to [Workflow settings](/workflows/settings/) for more information.
2. The n8n instance timezone, if the workflow timezone isn't set. The default is `America/New York` for self-hosted instances. n8n Cloud tries to detect the instance owner's timezone when they sign up, falling back to GMT as the default. Self-hosted users can change the instance setting using [Environment variables](/hosting/environment-variables/environment-variables/#timezone-and-localization). Cloud admins can change the instance timezone in the [Admin dashboard](/cloud-admin-dashboard/).
13 changes: 7 additions & 6 deletions _snippets/integrations/builtin/credentials/google/enable-apis.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
1. Access your [Google Cloud Console - Library](https://console.cloud.google.com/apis/library){:target=_blank .external-link}. Make sure you're in the correct project.
1. Search for and select the API(s) you want to enable. For example, for the Gmail node, search for and enable the Gmail API.

!!! note "Some integrations need additional APIs"
The following integrations require the Google Drive API, as well as their own API:
* Google Docs
* Google Sheets
* Google Slides
/// note | Some integrations need additional APIs
The following integrations require the Google Drive API, as well as their own API:

* Google Docs
* Google Sheets
* Google Slides
///

1. Select **ENABLE**.
5 changes: 3 additions & 2 deletions _snippets/integrations/creating-nodes/node-icons.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
n8n recommends using an SVG for your node icon, but you can also use PNG. If using PNG, the icon resolution should be 60x60px. Node icons should have a square or near-square aspect ratio.

!!! note "Don't reference Font Awesome"
If you want to use a Font Awesome icon in your node, download and embed the image.
/// note | Don't reference Font Awesome
If you want to use a Font Awesome icon in your node, download and embed the image.
///
18 changes: 10 additions & 8 deletions _snippets/integrations/creating-nodes/testing.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,20 +17,22 @@ You can test your node as you build it by running it in a local n8n instance.
npm link <node-package-name>
```

!!! note "Check your directory"
Make sure you run `npm link <node-name>` in the nodes directory within your n8n installation. This can be:

* `~/.n8n/custom/`
* `~/.n8n/<your-custom-name>`: if your n8n installation set a different name using `N8N_CUSTOM_EXTENSIONS`.

/// note | Check your directory
Make sure you run `npm link <node-name>` in the nodes directory within your n8n installation. This can be:

* `~/.n8n/custom/`
* `~/.n8n/<your-custom-name>`: if your n8n installation set a different name using `N8N_CUSTOM_EXTENSIONS`.
///

4. Start n8n:
```
n8n start
```
5. Open n8n in your browser. You should see your nodes when you search for them in the nodes panel.

!!! note "Node names"
Make sure you search using the node name, not the package name. For example, if your npm package name is `n8n-nodes-weather-nodes`, and the package contains nodes named `rain`, `sun`, `snow`, you should search for `rain`, not `weather-nodes`.
/// note | Node names
Make sure you search using the node name, not the package name. For example, if your npm package name is `n8n-nodes-weather-nodes`, and the package contains nodes named `rain`, `sun`, `snow`, you should search for `rain`, not `weather-nodes`.
///

### Troubleshooting

Expand Down
6 changes: 3 additions & 3 deletions _snippets/integrations/submit-community-node.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
!!! note "Subject to change"
The standards described in this document are for the first release of the community nodes repository. These may change in future releases.

/// note | Subject to change
The standards described in this document are for the first release of the community nodes repository. These may change in future releases.
///
Community nodes are npm packages, hosted in the npm registry.

When building a node to submit to the community node repository, use the following resources to make sure your node setup is correct:
Expand Down
6 changes: 3 additions & 3 deletions _snippets/self-hosting/installation/latest-next-version.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
!!! note "Latest and Next versions"
n8n releases a new minor version most weeks. The `latest` version is for production use. `next` is the most recent release. You should treat `next` as a beta: it may be unstable. To report issues, use the [forum](https://community.n8n.io/c/questions/12){:target=_blank .external-link}.

/// note | Latest and Next versions
n8n releases a new minor version most weeks. The `latest` version is for production use. `next` is the most recent release. You should treat `next` as a beta: it may be unstable. To report issues, use the [forum](https://community.n8n.io/c/questions/12){:target=_blank .external-link}.
///
Current `latest`: 1.14.2
Current `next`: 1.15.1
5 changes: 3 additions & 2 deletions _snippets/self-hosting/installation/tunnel.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
## n8n with tunnel

!!! danger
This is only meant for local development and testing. Do not use it in production.
/// danger
This is only meant for local development and testing. Do not use it in production.
///

To be able to use webhooks for trigger nodes of external services like GitHub, n8n has to be reachable from the web. To make that easy, n8n has a special [tunnel service](https://github.com/localtunnel/localtunnel) which redirects requests from our servers to your local n8n instance.
6 changes: 3 additions & 3 deletions _snippets/self-hosting/warning.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
!!! note "Self-hosting knowledge prerequisites"
Self-hosting n8n requires technical knowledge, including:

/// note | Self-hosting knowledge prerequisites
Self-hosting n8n requires technical knowledge, including:
///
* Setting up and configuring servers and containers
* Managing application resources and scaling
* Securing servers and applications
Expand Down
6 changes: 3 additions & 3 deletions _snippets/source-control-environments/feature-availability.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
!!! info "Feature availability"
* Available on Enterprise.
* You need access to the n8n instance owner account to set up source control, and to send work to and from Git.
/// info | Feature availability
* Available on Enterprise.
/// * You need access to the n8n instance owner account to set up source control, and to send work to and from Git.
5 changes: 3 additions & 2 deletions _snippets/source-control-environments/one-direction.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
!!! note "Recommendation: don't push and pull to the same n8n instance"
You can push work from an instance to a branch, and pull to the same instance. n8n doesn't recommend this. To reduce the risk of merge conflicts and overwriting work, try to create a process where work goes in one direction: either to Git, or from Git, but not both.
/// note | Recommendation: don't push and pull to the same n8n instance
You can push work from an instance to a branch, and pull to the same instance. n8n doesn't recommend this. To reduce the risk of merge conflicts and overwriting work, try to create a process where work goes in one direction: either to Git, or from Git, but not both.
///
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
!!! info "Feature availability"
Custom executions data is available on:
/// info | Feature availability
Custom executions data is available on:

* Cloud: Pro, Enterprise
* Self-Hosted: Enterprise
* Cloud: Pro, Enterprise
* Self-Hosted: Enterprise

Available in version 0.222.0 and above.
Available in version 0.222.0 and above.
///
6 changes: 3 additions & 3 deletions archive/n8n-nodes-base.cron.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

The Cron node is useful to schedule the workflows to run periodically at fixed dates, times, or intervals. This works in a similar way to the [cron](https://en.wikipedia.org/wiki/Cron) software utility in Unix-like systems. This core node is a Trigger node.

!!! note "Keep in mind"
1. If a workflow is using the Cron node as a trigger, make sure that you save and activate the workflow.
2. Make sure that the timezone is set correctly for the n8n instance (or the workflow).
/// note | Keep in mind
1. If a workflow is using the Cron node as a trigger, make sure that you save and activate the workflow.
/// 2. Make sure that the timezone is set correctly for the n8n instance (or the workflow).



Expand Down
12 changes: 6 additions & 6 deletions archive/n8n-nodes-base.function.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
# Function

!!! warning "Deprecated in 0.198.0"
n8n deprecated this node in version 0.198.0. Older workflows continue to work, and the node is still available in older versions n8n. From 0.198.0, n8n replaces the Function node with the [Code](/integrations/builtin/core-nodes/n8n-nodes-base.code/) node.

/// warning | Deprecated in 0.198.0
n8n deprecated this node in version 0.198.0. Older workflows continue to work, and the node is still available in older versions n8n. From 0.198.0, n8n replaces the Function node with the [Code](/integrations/builtin/core-nodes/n8n-nodes-base.code/) node.
///
Using the function node, you can:

* Transform data from other nodes
* Implement custom functionality

!!! note "Function node and function item node"
Note that the Function node is different from the [Function Item](/integrations/builtin/core-nodes/n8n-nodes-base.functionitem/) node. Refer to [Data | Code](/data/code/) to learn about the difference between the two.

/// note | Function node and function item node
Note that the Function node is different from the [Function Item](/integrations/builtin/core-nodes/n8n-nodes-base.functionitem/) node. Refer to [Data | Code](/data/code/) to learn about the difference between the two.
///

The Function node supports:

Expand Down
12 changes: 6 additions & 6 deletions archive/n8n-nodes-base.functionItem.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# Function Item

!!! warning "Deprecated in 0.198.0"
n8n deprecated this node in version 0.198.0. Older workflows continue to work, and the node is still available in older versions n8n. From 0.198.0, n8n replaces the Function node with the [Code](/integrations/builtin/core-nodes/n8n-nodes-base.code/) node.

/// warning | Deprecated in 0.198.0
n8n deprecated this node in version 0.198.0. Older workflows continue to work, and the node is still available in older versions n8n. From 0.198.0, n8n replaces the Function node with the [Code](/integrations/builtin/core-nodes/n8n-nodes-base.code/) node.
///
The Function Item node is used to add custom snippets to JavaScript code that should be executed once for every item that it receives as the input.

!!! note "Keep in mind"
Please note that the Function Item node is different from the [Function](/integrations/builtin/core-nodes/n8n-nodes-base.function/) node. Check out [this](/data/code/) page to learn about the difference between the two.

/// note | Keep in mind
Please note that the Function Item node is different from the [Function](/integrations/builtin/core-nodes/n8n-nodes-base.function/) node. Check out [this](/data/code/) page to learn about the difference between the two.
///

The Function Item node supports promises. So instead of returning the items directly, it is also possible to return a promise which resolves accordingly.

Expand Down
Loading

0 comments on commit 551147c

Please sign in to comment.