diff --git a/packages/noco-docs/docs/065.table-details/_category_.json b/packages/noco-docs/docs/065.table-details/_category_.json index 3caf0fb1d6..6aaa8c1c07 100644 --- a/packages/noco-docs/docs/065.table-details/_category_.json +++ b/packages/noco-docs/docs/065.table-details/_category_.json @@ -1,5 +1,5 @@ { - "label": "Table Details", + "label": "Table details", "collapsible": true, "collapsed": true } \ No newline at end of file diff --git a/packages/noco-docs/docs/070.fields/040.field-types/010.text-based/025.rich-text.md b/packages/noco-docs/docs/070.fields/040.field-types/010.text-based/025.rich-text.md new file mode 100644 index 0000000000..1c6c381fc5 --- /dev/null +++ b/packages/noco-docs/docs/070.fields/040.field-types/010.text-based/025.rich-text.md @@ -0,0 +1,137 @@ +--- +title: 'Rich text' +description: 'This article explains how to create & work with a Rich text field.' +tags: ['Fields', 'Field types', 'Text based types', 'Rich text'] +keywords: ['Fields', 'Field types', 'Text based types', 'Rich text', 'Create rich text field'] +--- + + +`Rich Text` field is text based field & is extension of `Long text` that allows you to add formatting to the text. You can add text formatting like bold, italic, underline, strikethrough, horizontal rule, ordered list, unordered list, code, quote, etc. + +## Create a `Rich Text` field +1. Click on `+` icon to the right of `Fields header` +2. On the dropdown modal, enter the field name (Optional). +3. Select the field type as `Long text` from the dropdown. +4. Enable `Rich Text` toggle field. +5. Set default value for the field (Optional). +6. Click on `Save Field` button. + +![image](/img/v2/fields/types/richtext.png) + +:::note +- Specify default value without quotes. +- Use `Enter` key to add new line. +::: + +### Cell display +`Rich Text` field is displayed as a single line text field in the table view. Click on the expand icon in the cell to view the full text. + +![image](/img/v2/fields/long-text-expand.png) +![image](/img/v2/fields/long-text-expand-2.png) + + +## Formatting options +NocoDB supports markdown syntax for formatting the text. Following are the supported formatting options. + +### Heading +To create a heading, prefix `#` symbol preceding your heading text. The number of # symbols employed will dictate the heading's hierarchy level and typeface size. Three levels of headings are supported. + +``` +# Heading 1 +## Heading 2 +### Heading 3 +``` + +![image](/img/v2/fields/types/richtext-heading.png) + +### Text formatting +You can emphasise text with bold, italic, strikethrough or underline formatting options. Table below shows syntax, keyboard shortcut, example & output for each formatting option. + +| Style | Syntax | Keyboard shortcut | Example | Output | +| --- | --- | --- | --- | --- | +| Bold | `**bold text**` | `Ctrl/Cmd + B` | `**This is bold text**` | **This is bold text** | +| Italic | `*italicized text*` | `Ctrl/Cmd + I` | `*This is italicized text*` | *This is italicized text* | +| Strikethrough | `~~strikethrough text~~` | `Ctrl/Cmd + Shift + X` | `~~This is strikethrough text~~` | ~~This is strikethrough text~~ | +| Underline | | `Ctrl/Cmd + U` | `This is underlined text` | This is underlined text | + +### Quote block +You can quote text with a `>` + +``` +normal text +> quoted text +``` + +normal text +> quoted text + +### Code block +Code block can be created by using (3 backticks) before & after the code. +```` +``` +This is a code block +``` +```` + +``` +This is a code block +``` + +### Link +You can create an inline link by using `Link` menu option in the rich text toolbar + +![image](/img/v2/fields/types/richtext-links.png) + +### Bullet List +You can create unordered list by using `Bulleted list` menu option in the rich text toolbar or by preceding the text with `-` `+` or `*` symbol. +``` +- Item 1 +- Item 2 + ++ Item 1 ++ Item 2 + +* Item 1 +* Item 2 +``` + +- Item 1 +- Item 2 + ++ Item 1 ++ Item 2 + +* Item 1 +* Item 2 + +:::note +You can create nested lists by using `tab` key & `shift + tab` key to indent & outdent the list items. +::: + +### Numbered List +You can create ordered list by using `Numbered list` menu option in the rich text toolbar or by preceding the text with `1.` symbol. +``` +1. Item 1 +2. Item 2 +``` +1. Item 1 +2. Item 2 + +### Task list +You can create task lists by using `Task list` menu option in the rich text toolbar or by preceding the text with `[ ]` symbol. You can mark the task as completed by using `[x]` symbol. +``` +[ ] Item 1 +[x] Item 2 +``` +- [ ] Item 1 +- [x] Item 2 + + +## Similar text based fields +Following are the other text based fields available in NocoDB, custom-built for specific use cases. +- [Single line text](010.single-line-text.md) +- [URL](050.url.md) +- [Email](030.email.md) +- [Phone](040.phonenumber.md) + + diff --git a/packages/noco-docs/static/img/v2-unannotated/fields/types/richtext.png b/packages/noco-docs/static/img/v2-unannotated/fields/types/richtext.png new file mode 100644 index 0000000000..073c838127 Binary files /dev/null and b/packages/noco-docs/static/img/v2-unannotated/fields/types/richtext.png differ diff --git a/packages/noco-docs/static/img/v2/fields/types/richtext-heading.png b/packages/noco-docs/static/img/v2/fields/types/richtext-heading.png new file mode 100644 index 0000000000..d00067a8c9 Binary files /dev/null and b/packages/noco-docs/static/img/v2/fields/types/richtext-heading.png differ diff --git a/packages/noco-docs/static/img/v2/fields/types/richtext-links.png b/packages/noco-docs/static/img/v2/fields/types/richtext-links.png new file mode 100644 index 0000000000..f3e378fc11 Binary files /dev/null and b/packages/noco-docs/static/img/v2/fields/types/richtext-links.png differ diff --git a/packages/noco-docs/static/img/v2/fields/types/richtext.png b/packages/noco-docs/static/img/v2/fields/types/richtext.png new file mode 100644 index 0000000000..7c02c308fa Binary files /dev/null and b/packages/noco-docs/static/img/v2/fields/types/richtext.png differ