Merge pull request #809 from n8n-io/stickiesMarkdown

add markdown guide and add to nav ready for live
This commit is contained in:
Deborah 2022-04-25 13:46:15 +01:00 committed by GitHub
commit ff4bbae6b0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 95 additions and 28 deletions

View File

@ -1,5 +1,42 @@
# Release notes
## n8n@0.174.0
View the [commits](https://github.com/n8n-io/n8n/compare/n8n@0.173.1...n8n@0.174.0) for this version.<br />
**Release date:** 2022-04-25
### New features
This release adds Sticky Notes, a new feature that allows you to annotate and comment on your workflows. Refer to the [Sticky Notes](/workflows/sticky-notes/) for more information.
### Enhancements
* **core**: allow external OAuth connection. This enhancement adds support for connecting OAuth apps without access to n8n.
* All AWS nodes now support AWS temporary credentials.
* [Google Sheets node](/integrations/nodes/n8n-nodes-base.googleSheets/): Added upsert support.
* [Microsoft Teams node](/integrations/nodes/n8n-nodes-base.microsoftTeams/): adds several enhancements:
* An option to limit groups to "member of", rather than retrieving the whole directory.
* An option to get all tasks from a plan instead of just a group member.
* Autocompletion for plans, buckets, labels, and members in update fields for tasks.
* [MongoDB node](/integrations/nodes/n8n-nodes-base.mongoDb/): you can now parse dates using dot notation.
### Bug fixes
* [Calendly trigger node](/integrations/trigger-nodes/n8n-nodes-base.calendlyTrigger/): updated the logo.
* [Microsoft OneDrive node](/integrations/nodes/n8n-nodes-base.microsoftOneDrive/): fixed an issue that was preventing upload of files with special characters in the file name.
* [QuickBooks node](/integrations/nodes/n8n-nodes-base.quickbooks/): fixed a pagination issue.
### Contributors
[Basit Ali](https://github.com/BasitAli)
[Cody Stamps](https://github.com/crstamps2)
[Luiz Eduardo de Oliveira](https://github.com/luizeof)
[Oliver Trajceski](https://github.com/SchnapsterDog)
[pemontto](https://github.com/pemontto)
[Ryan Goggin](https://github.com/Goggin)
## n8n@0.173.1
View the [commits](https://github.com/n8n-io/n8n/compare/n8n@0.173.0...n8n@0.173.1) for this version.<br />

View File

@ -0,0 +1,57 @@
# Sticky Notes
Sticky Notes allow you to annotate and comment on your workflows.
n8n recommends using Sticky Notes heavily, especially on template workflows, to help other users understand your workflow.
## Create a Sticky Note
Sticky Notes are a core node. To add a new Sticky Note:
1. Open the nodes panel.
2. Search for `note`.
3. Click the **Sticky Note** node. n8n adds a new Sticky Note to the canvas.
## Edit a Sticky Note
1. Double click the Sticky Note you want to edit.
2. Write your note. [This guide](https://commonmark.org/help/) explains how to format your text with Markdown. n8n uses [markdown-it](https://github.com/markdown-it/markdown-it), which implements the CommonMark specification.
3. Click away from the note, or press `Esc`, to stop editing.
## Sticky Note positioning
You can:
* Drag a Sticky Note anywhere on the canvas.
* Drag Sticky Notes behind nodes. You can use this to visually group nodes.
* Resize Sticky Notes by hovering over the edge of the note and dragging to resize.
## Writing in Markdown
Sticky Notes support Markdown formatting. This section describes some common options.
```
The text in double asterisks will be **bold**
The text in single asterisks will be *italic*
Use # to indicate headings:
# This is a top-level heading
## This is a sub-heading
### This is a smaller sub-heading
You can add links:
[Example](https://example.com/)
Create lists with asterisks:
* Item one
* Item two
Or created ordered lists with numbers:
1. Item one
2. Item two
```
For a more detailed guide, refer to [CommonMark's help](https://commonmark.org/help/). n8n uses [markdown-it](https://github.com/markdown-it/markdown-it), which implements the CommonMark specification.

View File

@ -1,28 +0,0 @@
# Workflow notes
Workflow notes allow you to annotate and comment on your workflows.
We encourage using workflow notes heavily, especially on template workflows, to help other users understand your workflow.
## Create a note
Workflow notes are a type of core node. To add a new note:
1. Open the nodes panel.
2. Search for `note`.
3. Click the **Note** node. n8n adds a new note to the canvas.
## Edit a note
1. Double click the note you want to edit.
2. Write your note. [This guide](https://commonmark.org/help/) explains how to format your text with Markdown. n8n uses [markdown-it](https://github.com/markdown-it/markdown-it), which implements the CommonMark specification.
3. Click away from the note, or press `Esc`, to stop editing.
## Note positioning
You can:
* Drag a note anywhere on the canvas.
* Drag notes behind nodes. You can use this to visually group nodes.
* Resize notes by hovering over the edge of the note and dragging to resize.

View File

@ -69,6 +69,7 @@ nav:
- Connections: workflows/connections.md
- Nodes: workflows/nodes.md
- Items: workflows/items.md
- Sticky Notes: workflows/sticky-notes.md
- Flow logic:
- Overview: flow-logic/index.md
- Merging: flow-logic/merging.md