diff --git a/docs/_extra/css/extra.css b/docs/_extra/css/extra.css index 046aa99cc..86188ae9e 100644 --- a/docs/_extra/css/extra.css +++ b/docs/_extra/css/extra.css @@ -191,6 +191,12 @@ img:not(.inline-image > .md-typeset img) { border-left: 1px solid var(--color-primary); } */ +code { + tab-size: 2; +} + +/* n8n classes */ + .inline-image { display:inline-block; max-width: 25px; @@ -198,9 +204,7 @@ img:not(.inline-image > .md-typeset img) { vertical-align: middle; } -code { - tab-size: 2; -} + diff --git a/docs/code-examples/index.md b/docs/code-examples/index.md index ce4826bef..131bbc377 100644 --- a/docs/code-examples/index.md +++ b/docs/code-examples/index.md @@ -1,4 +1,4 @@ -# Overview +# Code in n8n There are two places in n8n where you need to use code: @@ -15,4 +15,4 @@ This section covers: * [Introduction to JavaScript in n8n](/code-examples/javascript-functions/). * Built in [methods](/code-examples/javascript-functions/methods/) and [variables](/code-examples/javascript-functions/variables/). * [Checking incoming data](/code-examples/javascript-functions/check-incoming-data/). - * [Get the number of items returned by the last node](/code-examples/javascript-functions/number-items-last-node/). \ No newline at end of file + * [Get the number of items returned by the last node](/code-examples/javascript-functions/number-items-last-node/). diff --git a/docs/courses/level-one/index.md b/docs/courses/level-one/index.md index 070245c50..5c48c5edb 100644 --- a/docs/courses/level-one/index.md +++ b/docs/courses/level-one/index.md @@ -1,4 +1,4 @@ -# Introduction +# Level one: Introduction Welcome to the **n8n Course Level 1**! diff --git a/docs/courses/level-two/index.md b/docs/courses/level-two/index.md index e681cad9f..1a5d86bc2 100644 --- a/docs/courses/level-two/index.md +++ b/docs/courses/level-two/index.md @@ -1,4 +1,4 @@ -# Introduction +# Level two: Introduction Welcome to the **n8n Course Level 2**! diff --git a/docs/credentials/index.md b/docs/credentials/index.md index 36e5a0a12..722fc2e83 100644 --- a/docs/credentials/index.md +++ b/docs/credentials/index.md @@ -1,4 +1,4 @@ -# Overview +# Credentials Credentials are private pieces of information issued by apps and services to authenticate you as a user and allow you to connect and share information between the app or service and the n8n node. diff --git a/docs/data/index.md b/docs/data/index.md index 291106742..1d447cb54 100644 --- a/docs/data/index.md +++ b/docs/data/index.md @@ -1,4 +1,4 @@ -# Overview +# Data Data represents units of information that are collected by and transmitted through nodes. For "basic usage" it is not necessarily needed to understand how the data that gets passed from one node to another is structured. However, it becomes important if you want to: @@ -10,4 +10,4 @@ This section covers: * [Data structure](/data/data-structure/) * [Transforming data](/data/transforming-data/) -* [Using code](/data/code/) \ No newline at end of file +* [Using code](/data/code/) diff --git a/docs/flow-logic/index.md b/docs/flow-logic/index.md index c0f5bae11..875c554ee 100644 --- a/docs/flow-logic/index.md +++ b/docs/flow-logic/index.md @@ -1,7 +1,7 @@ -# Overview +# Flow logic n8n allows you to represent complex logic in your workflows. * [Merging](/flow-logic/merging/) * [Looping](/flow-logic/looping/) -* [Error handling](/flow-logic/error-handling/) \ No newline at end of file +* [Error handling](/flow-logic/error-handling/) diff --git a/docs/hosting/databases/index.md b/docs/hosting/databases/index.md index e0b6d7061..b6f54cdcf 100644 --- a/docs/hosting/databases/index.md +++ b/docs/hosting/databases/index.md @@ -1,8 +1,8 @@ -# Overview +# Databases This section describes: * [n8n's database structure](/hosting/databases/structure/) * [Supported databases and settings](/hosting/databases/supported-databases-settings/) -For guidance on managing database size, refer to [Scaling | Execution data](/hosting/scaling/execution-data/). \ No newline at end of file +For guidance on managing database size, refer to [Scaling | Execution data](/hosting/scaling/execution-data/). diff --git a/docs/hosting/installation/index.md b/docs/hosting/installation/index.md index 4f61ba027..ff2a8e5d9 100644 --- a/docs/hosting/installation/index.md +++ b/docs/hosting/installation/index.md @@ -1,8 +1,8 @@ -# Overview +# Installation Installation guides for n8n: * [Desktop app](/hosting/installation/desktop-app/) * [npm](/hosting/installation/npm/) * [Docker](/hosting/installation/docker/) -* [Cloud](/hosting/installation/cloud/) \ No newline at end of file +* [Cloud](/hosting/installation/cloud/) diff --git a/docs/integrations/builtin/index.md b/docs/integrations/builtin/index.md index 03b5b3c90..2e0fc94c2 100644 --- a/docs/integrations/builtin/index.md +++ b/docs/integrations/builtin/index.md @@ -1,4 +1,4 @@ -# Overview +# Built-in integrations This section contains the node library: reference documentation for every built-in node in n8n, and their credentials. diff --git a/docs/integrations/community-nodes/index.md b/docs/integrations/community-nodes/index.md index 2ebe8d743..38f1c4c7b 100644 --- a/docs/integrations/community-nodes/index.md +++ b/docs/integrations/community-nodes/index.md @@ -1,4 +1,4 @@ -# Overview +# Community nodes n8n provides hundreds of built-in nodes. It also supports users [creating their own nodes](/integrations/creating-nodes/). These are community nodes. diff --git a/docs/integrations/creating-nodes/build/index.md b/docs/integrations/creating-nodes/build/index.md index 7ad500f95..ee1291216 100644 --- a/docs/integrations/creating-nodes/build/index.md +++ b/docs/integrations/creating-nodes/build/index.md @@ -1,4 +1,4 @@ -# Overview +# Build a node This section provides tutorials on building nodes. It covers: diff --git a/docs/integrations/creating-nodes/build/reference/index.md b/docs/integrations/creating-nodes/build/reference/index.md index 6f61cc3e3..98d2b8323 100644 --- a/docs/integrations/creating-nodes/build/reference/index.md +++ b/docs/integrations/creating-nodes/build/reference/index.md @@ -1,7 +1,7 @@ -# Overview +# Node building reference This section contains reference information, including details about: * [Node UI elements](/integrations/creating-nodes/build/reference/ui-elements/) * [Organizing your node files](/integrations/creating-nodes/build/reference/node-file-structure/) -* Key parameters in your node's [base file](/integrations/creating-nodes/build/reference/node-base-files/) and [credentials file](/integrations/creating-nodes/build/reference/credentials-files/). \ No newline at end of file +* Key parameters in your node's [base file](/integrations/creating-nodes/build/reference/node-base-files/) and [credentials file](/integrations/creating-nodes/build/reference/credentials-files/). diff --git a/docs/integrations/creating-nodes/deploy/index.md b/docs/integrations/creating-nodes/deploy/index.md index 171c621e2..5079c6304 100644 --- a/docs/integrations/creating-nodes/deploy/index.md +++ b/docs/integrations/creating-nodes/deploy/index.md @@ -1,4 +1,4 @@ -# Overview +# Deploy a node This section contains details on how to deploy and share your node. diff --git a/docs/integrations/creating-nodes/index.md b/docs/integrations/creating-nodes/index.md index 162e386c9..96d988a4e 100644 --- a/docs/integrations/creating-nodes/index.md +++ b/docs/integrations/creating-nodes/index.md @@ -1,4 +1,4 @@ -# Overview +# Creating nodes Learn how to build your own custom nodes. @@ -16,4 +16,4 @@ This section assumes the following: * Some familiarity with JavaScript and TypeScript. * Ability to manage your own development environment, including git. -* Knowledge of npm, including creating and submitting packages. \ No newline at end of file +* Knowledge of npm, including creating and submitting packages. diff --git a/docs/integrations/creating-nodes/plan/index.md b/docs/integrations/creating-nodes/plan/index.md index b9a3cc1ea..4f985f7a3 100644 --- a/docs/integrations/creating-nodes/plan/index.md +++ b/docs/integrations/creating-nodes/plan/index.md @@ -1,4 +1,4 @@ -# Overview +# Plan a node This section provides guidance on designing your node, including key technical decisions such as choosing your node building style. diff --git a/docs/integrations/creating-nodes/test/index.md b/docs/integrations/creating-nodes/test/index.md index bc3a9d787..6752526bd 100644 --- a/docs/integrations/creating-nodes/test/index.md +++ b/docs/integrations/creating-nodes/test/index.md @@ -1,4 +1,4 @@ -# Overview +# Test a node This section contains information about testing your node. diff --git a/docs/reference/index.md b/docs/reference/index.md index d9aac0a43..0587498c9 100644 --- a/docs/reference/index.md +++ b/docs/reference/index.md @@ -1,4 +1,4 @@ -# Overview +# Reference This section provides reference information about n8n, including: @@ -7,4 +7,4 @@ This section provides reference information about n8n, including: * [Keyboard shortcuts](/reference/keyboard-shortcuts/) * [Glossary](/reference/glossary/) * [License](/reference/license/) -* [Data collection](/reference/data-collection/) \ No newline at end of file +* [Data collection](/reference/data-collection/) diff --git a/docs/try-it-out/index.md b/docs/try-it-out/index.md index 10591826a..79ce81f81 100644 --- a/docs/try-it-out/index.md +++ b/docs/try-it-out/index.md @@ -1,4 +1,4 @@ -# Overview +# Try it out This section gets you up and running with building workflows in n8n. diff --git a/docs/try-it-out/longer-introduction.md b/docs/try-it-out/longer-introduction.md index 72101f1b7..bd75d98b4 100644 --- a/docs/try-it-out/longer-introduction.md +++ b/docs/try-it-out/longer-introduction.md @@ -13,6 +13,8 @@ This guide shows you how to automate a task using a workflow in n8n, explaining ## Step one: Install and run n8n +!!! note "Skip this section if you've already installed n8n or signed up for a Cloud account" + --8<-- "_snippets/try-it-out/install-run-n8n.md" ## Step two: Create a new workflow diff --git a/docs/try-it-out/quickstart.md b/docs/try-it-out/quickstart.md index 492b7d1d5..79ada1795 100644 --- a/docs/try-it-out/quickstart.md +++ b/docs/try-it-out/quickstart.md @@ -4,13 +4,14 @@ This quickstart gives you a very quick taste of n8n. Its aim is to allow you to You will: -* Install the desktop app * Load a workflow from the workflow templates library * Add a node and configure it using expressions. * Run your first workflow ## Step one: Install and run n8n +!!! note "Skip this section if you've already installed n8n or signed up for a Cloud account" + --8<-- "_snippets/try-it-out/install-run-n8n.md" ## Step two: Open a workflow template diff --git a/docs/workflows/index.md b/docs/workflows/index.md index 138b37e94..837c87480 100644 --- a/docs/workflows/index.md +++ b/docs/workflows/index.md @@ -1,4 +1,4 @@ -# Overview +# Workflows Learn about the key components of an automation in n8n: