Skip to content

Commit 84fb244

Browse files
author
Deborah
authored
update theme and fix admonitions (n8n-io#1644)
* update theme * fix tab issues * update readme * editor * revert tab change * change editor config back to 4 spaces for tabs * fix admons that broke when enforcing 4 spaces per tab * update README
1 parent 8cb7d02 commit 84fb244

File tree

27 files changed

+38
-34
lines changed

27 files changed

+38
-34
lines changed

.editorconfig

+1
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ root = true
44
charset = utf-8
55
indent_style = tab
66
end_of_line = lf
7+
indent_size = 4
78
insert_final_newline = true
89
trim_trailing_whitespace = false
910

README.md

+3
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,9 @@ This repository hosts the documentation for [n8n](https://n8n.io/), an extendabl
1313
* Pip
1414
* n8n recommends using a virtual environment when working with Python, such as [venv](https://docs.python.org/3/tutorial/venv.html).
1515
* 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.
1619

1720
### Steps
1821

_snippets/embed-license.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
!!! 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.
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.
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
!!! note "Recommendation: don't push and pull to the same n8n instance"
2-
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.
2+
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.

docs/choose-n8n/cloud.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ n8n Cloud is n8n's hosted solution. In addition to all the features of n8n, it p
1414
[Sign up for n8n Cloud](https://www.n8n.cloud/){:target=_blank .external-link}
1515

1616
!!! note "Russia and Belarus"
17-
n8n Cloud is not available in Russia and Belarus. Refer to our blog post [Update on n8n cloud accounts in Russia and Belarus](https://n8n.io/blog/update-on-n8n-cloud-accounts-in-russia-and-belarus/) for more information.
17+
n8n Cloud is not available in Russia and Belarus. Refer to our blog post [Update on n8n cloud accounts in Russia and Belarus](https://n8n.io/blog/update-on-n8n-cloud-accounts-in-russia-and-belarus/) for more information.
1818

1919
## Update your Cloud version
2020

docs/code/builtin/data-transformation-functions/arrays.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ contentType: reference
99
A reference document listing built-in convenience functions to support data transformation in expressions for arrays.
1010

1111
!!! note "JavaScript in expressions"
12-
You can use any JavaScript in expressions. Refer to [Expressions](/code/expressions/) for more information.
12+
You can use any JavaScript in expressions. Refer to [Expressions](/code/expressions/) for more information.
1313

1414
[[% import "_macros/data-functions.html" as dataFunctions %]]
1515

docs/code/builtin/data-transformation-functions/dates.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ contentType: reference
99
A reference document listing built-in convenience functions to support data transformation in expressions for dates.
1010

1111
!!! note "JavaScript in expressions"
12-
You can use any JavaScript in expressions. Refer to [Expressions](/code/expressions/) for more information.
12+
You can use any JavaScript in expressions. Refer to [Expressions](/code/expressions/) for more information.
1313

1414
[[% import "_macros/data-functions.html" as dataFunctions %]]
1515

docs/code/builtin/data-transformation-functions/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ contentType: overview
99
Data transformation functions are helper functions to make data transformation easier in expressions.
1010

1111
!!! note "JavaScript in expressions"
12-
You can use any JavaScript in expressions. Refer to [Expressions](/code/expressions/) for more information.
12+
You can use any JavaScript in expressions. Refer to [Expressions](/code/expressions/) for more information.
1313

1414
For a list of available functions, refer to the page for your data type:
1515

docs/code/builtin/data-transformation-functions/numbers.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ contentType: reference
99
A reference document listing built-in convenience functions to support data transformation in expressions for numbers.
1010

1111
!!! note "JavaScript in expressions"
12-
You can use any JavaScript in expressions. Refer to [Expressions](/code/expressions/) for more information.
12+
You can use any JavaScript in expressions. Refer to [Expressions](/code/expressions/) for more information.
1313

1414
[[% import "_macros/data-functions.html" as dataFunctions %]]
1515

docs/code/builtin/data-transformation-functions/objects.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ contentType: reference
99
A reference document listing built-in convenience functions to support data transformation in expressions for objects.
1010

1111
!!! note "JavaScript in expressions"
12-
You can use any JavaScript in expressions. Refer to [Expressions](/code/expressions/) for more information.
12+
You can use any JavaScript in expressions. Refer to [Expressions](/code/expressions/) for more information.
1313

1414
[[% import "_macros/data-functions.html" as dataFunctions %]]
1515

docs/code/builtin/data-transformation-functions/strings.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ contentType: reference
99
A reference document listing built-in convenience functions to support data transformation in expressions for strings.
1010

1111
!!! note "JavaScript in expressions"
12-
You can use any JavaScript in expressions. Refer to [Expressions](/code/expressions/) for more information.
12+
You can use any JavaScript in expressions. Refer to [Expressions](/code/expressions/) for more information.
1313

1414
[[% import "_macros/data-functions.html" as dataFunctions %]]
1515

docs/code/builtin/index.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ contentType: overview
88
n8n provides built-in methods and variables for working with data and accessing n8n data. This section provides a reference of available methods and variables, with a short description.
99

1010
!!! note "Availability in the expressions editor and the Code node"
11-
Some methods and variables aren't available in the Code node. These are noted in the documentation.
11+
Some methods and variables aren't available in the Code node. These are noted in the documentation.
1212

13-
All data transformation functions are only available in the expressions editor.
13+
All data transformation functions are only available in the expressions editor.
1414

1515
[[% import "_macros/section-toc.html" as sectionToc %]]
1616

docs/credentials/credential-sharing.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ contentType: howto
66
# Credential sharing
77

88
!!! info "Feature availability"
9-
Available on Pro and Enterprise Cloud plans, and Enterprise self-hosted plans.
9+
Available on Pro and Enterprise Cloud plans, and Enterprise self-hosted plans.
1010

1111
Credential sharing allows you to share a credential you created with other users in the same n8n workspace as you. The other users can then use the credential in their workflows. They can't access or edit the credential details.
1212

docs/hosting/installation/server-setups/aws.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -162,7 +162,7 @@ To find the address of the n8n service running on the instance:
162162
4. Select the **n8n** service and copy the **Load balancer URLs** value. Use this value suffixed with the n8n service port (5678) for DNS.
163163

164164
!!! note "Use HTTP"
165-
This guide uses HTTP connections for the services it defines, for example in `n8n-deployment.yaml`. However, if you click the **Load balancer URLs** value, EKS takes you to an "HTTPS" URL which results in an error. To solve this, when you open the n8n subdomain, make sure to use HTTP.
165+
This guide uses HTTP connections for the services it defines, for example in `n8n-deployment.yaml`. However, if you click the **Load balancer URLs** value, EKS takes you to an "HTTPS" URL which results in an error. To solve this, when you open the n8n subdomain, make sure to use HTTP.
166166

167167
## Delete resources
168168

docs/hosting/installation/server-setups/digital-ocean.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,10 @@ This hosting guide shows you how to self-host n8n on a DigitalOcean droplet. It
2121
4. [Create a new Droplet](https://docs.digitalocean.com/products/droplets/how-to/create/){:target=_blank .external-link} using the [Docker image](https://marketplace.digitalocean.com/apps/docker){:target="_blank" .external-link} available on the **Marketplace** tab.
2222

2323
!!! note "Droplet resources"
24-
When creating the Droplet, DigitalOcean asks you to choose a plan. For most usage levels, a basic shared CPU plan is enough.
24+
When creating the Droplet, DigitalOcean asks you to choose a plan. For most usage levels, a basic shared CPU plan is enough.
2525

2626
!!! note "SSH or Password"
27-
DigitalOcean lets you choose between SSH and password-based authentication. SSH is more secure. The rest of this guide assumes you are using SSH.
27+
DigitalOcean lets you choose between SSH and password-based authentication. SSH is more secure. The rest of this guide assumes you are using SSH.
2828

2929
## Log in to your Droplet and create new user
3030

docs/hosting/installation/server-setups/hetzner.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,10 @@ This hosting guide shows you how to self-host n8n on a Hetzner cloud server. It
2222
You can change most of the settings to suit your needs, but as this guide uses Docker to run the application, under the **Image** section, select "Docker CE" from the **APPS** tab.
2323

2424
!!! note "Type"
25-
When creating the server, Hetzner asks you to choose a plan. For most usage levels, the CPX11 type is enough.
25+
When creating the server, Hetzner asks you to choose a plan. For most usage levels, the CPX11 type is enough.
2626

2727
!!! note "SSH keys"
28-
Hetzner lets you choose between SSH and password-based authentication. SSH is more secure. The rest of this guide assumes you are using SSH.
28+
Hetzner lets you choose between SSH and password-based authentication. SSH is more secure. The rest of this guide assumes you are using SSH.
2929

3030
## Log in to your server
3131

docs/integrations/builtin/core-nodes/n8n-nodes-base.html.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ The HTML node provides operations to help you work with HTML in n8n.
1212
The HTML node replaces the HTML Extract node from version 0.213.0 onwards. If you're using an older version of n8n, you can still view the [HTML Extract node documentation](https://github.com/n8n-io/n8n-docs/blob/86fe33b681621e618e3adcab9a27e8605dbc23ad/docs/integrations/builtin/core-nodes/n8n-nodes-base.htmlextract.md){:target=_blank .external-link}.
1313

1414
!!! warning "Cross-site scripting"
15-
When using the HTML node to generate an HTML template you can introduce [XSS (cross-site scripting)](https://owasp.org/www-community/attacks/xss/){:target=_blank .external-link}. This is a security risk. Be careful with untrusted inputs.
15+
When using the HTML node to generate an HTML template you can introduce [XSS (cross-site scripting)](https://owasp.org/www-community/attacks/xss/){:target=_blank .external-link}. This is a security risk. Be careful with untrusted inputs.
1616

1717
## Operations
1818

docs/integrations/builtin/core-nodes/n8n-nodes-base.merge.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ contentType: integration
99
Use the Merge node to combine data from two streams, once data of both streams is available.
1010

1111
!!! note "Major changes in 0.194.0"
12-
This node was overhauled in n8n 0.194.0. This document reflects the latest version of the node. If you're using an older version of n8n, you can find the previous version of this document [here](https://github.com/n8n-io/n8n-docs/blob/4ff688642cc9ee7ca7d00987847bf4e4515da59d/docs/integrations/builtin/core-nodes/n8n-nodes-base.merge.md){:target=_blank .external-link}.
12+
This node was overhauled in n8n 0.194.0. This document reflects the latest version of the node. If you're using an older version of n8n, you can find the previous version of this document [here](https://github.com/n8n-io/n8n-docs/blob/4ff688642cc9ee7ca7d00987847bf4e4515da59d/docs/integrations/builtin/core-nodes/n8n-nodes-base.merge.md){:target=_blank .external-link}.
1313

1414
## Merge mode
1515

docs/integrations/builtin/core-nodes/n8n-nodes-base.webhook.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ You can require authentication for any service calling your webhook URL.
6060
* [**Header Auth**](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Authorization){:target=_blank .external-link}: a method of authentication where calls to the webhook URL must include the specified header parameter. For example, use this method when you want to authenticate using an API key or an access token.
6161

6262
!!! note Credential data can vary
63-
The **Credential Data** required for header auth credentials depends on the type used. For example, if you need to provide an `Authorization: Bearer <token>` header, the Credential Data `Name` will be `Authorization` and the `Value` will be `Bearer <token>`.
63+
The **Credential Data** required for header auth credentials depends on the type used. For example, if you need to provide an `Authorization: Bearer <token>` header, the Credential Data `Name` will be `Authorization` and the `Value` will be `Bearer <token>`.
6464
6565

6666
### HTTP Method

docs/integrations/creating-nodes/build/declarative-style-node.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ import { INodeType, INodeTypeDescription } from 'n8n-workflow';
8888
The node must export an interface that implements INodeType. This interface must include a `description` interface, which in turn contains the `properties` array.
8989

9090
!!! note "Class names and file names"
91-
Make sure the class name and the file name match. For example, given a class `NasaPics`, the filename must be `NasaPics.node.ts`.
91+
Make sure the class name and the file name match. For example, given a class `NasaPics`, the filename must be `NasaPics.node.ts`.
9292

9393
```typescript
9494
export class NasaPics implements INodeType {

docs/integrations/creating-nodes/build/programmatic-style-node.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ import {
102102
The node must export an interface that implements `INodeType`. This interface must include a `description` interface, which in turn contains the `properties` array.
103103

104104
!!! note "Class names and file names"
105-
Make sure the class name and the file name match. For example, given a class `FriendGrid`, the filename must be `FriendGrid.node.ts`.
105+
Make sure the class name and the file name match. For example, given a class `FriendGrid`, the filename must be `FriendGrid.node.ts`.
106106

107107
```typescript
108108
export class FriendGrid implements INodeType {

docs/privacy-security/privacy.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ The n8n Data Processing Agreement includes the [Standard Contractual Clauses (S
2626
You can find a list of n8n sub-processors [here](https://n8n.io/legal/#subprocessors){:target=_blank .external-link}.
2727

2828
!!! note "Self-hosted n8n"
29-
For self-hosted versions, n8n is neither a Controller nor a Processor, as we don't manage your data
29+
For self-hosted versions, n8n is neither a Controller nor a Processor, as we don't manage your data
3030

3131
### Submitting a GDPR deletion request
3232

docs/release-notes.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -594,7 +594,7 @@ View the [commits](https://github.com/n8n-io/n8n/compare/[email protected]@0.235
594594
This release contains new features, new nodes, node enhancements, and bug fixes.
595595

596596
!!! warning "Unstable version"
597-
This version is currently (4th July 2023) considered unstable. n8n recommends against upgrading.
597+
This version is currently (4th July 2023) considered unstable. n8n recommends against upgrading.
598598

599599
For full release details, refer to [Releases](https://github.com/n8n-io/n8n/releases){:target=_blank .external-link} on GitHub.
600600

@@ -611,7 +611,7 @@ View the [commits](https://github.com/n8n-io/n8n/compare/[email protected]@0.234
611611
This release contains new features, new nodes, node enhancements, and bug fixes.
612612

613613
!!! warning "Unstable version"
614-
This version is currently (4th July 2023) considered unstable. n8n recommends upgrading directly to 0.234.1.
614+
This version is currently (4th July 2023) considered unstable. n8n recommends upgrading directly to 0.234.1.
615615

616616
!!! warning "Irreversible database migration"
617617
This version contains a database migration that changes credential and workflow IDs to use nanoId strings, This migration may take a while to complete in some environments. This change doesn't break anything using the older numeric IDs.
@@ -2021,7 +2021,7 @@ View the [commits](https://github.com/n8n-io/n8n/compare/[email protected]@0.211
20212021
**Release date:** 2023-01-13
20222022

20232023
!!! warning "Don't use this version"
2024-
Upgrade directly to 0.211.1.
2024+
Upgrade directly to 0.211.1.
20252025

20262026
### New features
20272027

docs/user-management/cloud-setup.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ contentType: howto
66
# Set up user management on n8n Cloud
77

88
!!! info "Feature availability"
9-
* Available on paid self-hosted and selected Cloud plans. Refer to [Pricing](https://n8n.io/pricing/){:target=_blank .external-link} for more information.
9+
Available on paid self-hosted and selected Cloud plans. Refer to [Pricing](https://n8n.io/pricing/){:target=_blank .external-link} for more information.
1010

1111
To access user management, upgrade to version 0.195.0 or newer.
1212

docs/user-management/ldap.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ contentType: howto
66
# Lightweight Directory Access Protocol (LDAP)
77

88
!!! info "Feature availability"
9-
* Available on Self-hosted Enterprise and Cloud Enterprise plans.
10-
* You need access to the n8n instance owner account.
9+
* Available on Self-hosted Enterprise and Cloud Enterprise plans.
10+
* You need access to the n8n instance owner account.
1111

1212
This page tells you how to enable LDAP in n8n. It assumes you're familiar with LDAP, and have an existing LDAP server set up.
1313

docs/user-management/two-factor-auth.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@ description: How to enable 2FA for your n8n account
55
# Two-factor authentication (2FA)
66

77
!!! info "Feature availability"
8-
* You need access to the n8n instance owner account.
9-
* Available on self-hosted n8n.
10-
* Coming soon to n8n Cloud.
8+
* You need access to the n8n instance owner account.
9+
* Available on self-hosted n8n.
10+
* Coming soon to n8n Cloud.
1111

12-
Twofactor authentication (2FA) adds a second authentication method on top of username and password. This increases account security. n8n supports 2FA using an authenticator app.
12+
Two-factor authentication (2FA) adds a second authentication method on top of username and password. This increases account security. n8n supports 2FA using an authenticator app.
1313

1414
## Enable 2FA
1515

docs/workflows/sharing.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ There are two workflow roles: owner and editor. The owner is the user who create
3131
You can't change the workflow owner, except when deleting the user.
3232

3333
!!! note "Credentials"
34-
Workflow sharing allows editors to use all credentials used in the workflow. This includes credentials that aren't explicitly shared with them using [credential sharing](/credentials/credential-sharing/).
34+
Workflow sharing allows editors to use all credentials used in the workflow. This includes credentials that aren't explicitly shared with them using [credential sharing](/credentials/credential-sharing/).
3535

3636
### Permissions
3737

0 commit comments

Comments
 (0)