diff --git a/docs.json b/docs.json
index f5c6e150..19dbf350 100644
--- a/docs.json
+++ b/docs.json
@@ -252,7 +252,8 @@
{
"group": "Basic",
"pages": [
- "en/workshop/basic/build-ai-image-generation-app"
+ "en/workshop/basic/build-ai-image-generation-app",
+ "en/workshop/basic/the-right-way-of-markdown"
]
},
{
@@ -909,7 +910,8 @@
"group": "初级",
"pages": [
"zh-hans/workshop/basic/build-ai-image-generation-app",
- "zh-hans/workshop/basic/travel-assistant"
+ "zh-hans/workshop/basic/travel-assistant",
+ "zh-hans/workshop/basic/the-right-way-of-markdown"
]
},
{
@@ -1549,7 +1551,8 @@
"pages": [
"ja-jp/workshop/basic/README",
"ja-jp/workshop/basic/build-ai-image-generation-app",
- "ja-jp/workshop/basic/travel-assistant"
+ "ja-jp/workshop/basic/travel-assistant",
+ "ja-jp/workshop/basic/the-right-way-of-markdown"
]
},
{
diff --git a/en/getting-started/install-self-hosted/environments.mdx b/en/getting-started/install-self-hosted/environments.mdx
index a2c9f1ab..7b879c6f 100644
--- a/en/getting-started/install-self-hosted/environments.mdx
+++ b/en/getting-started/install-self-hosted/environments.mdx
@@ -717,3 +717,4 @@ It will be automatically generated by the script.
---
[Edit this page](https://github.com/langgenius/dify-docs/edit/main/en/getting-started/install-self-hosted/environments.mdx) | [Report an issue](https://github.com/langgenius/dify-docs/issues/new?title=Documentation%20Issue%3A%20onme&body=%23%23%20Issue%20Description%0A%3C%21--%20Please%20briefly%20describe%20the%20issue%20you%20found%20--%3E%0A%0A%23%23%20Page%20Link%0Ahttps%3A%2F%2Fgithub.com%2Flanggenius%2Fdify-docs%2Fblob%2Fmain%2Fen/getting-started/install-self-hosted%2Fenvironments.mdx%0A%0A%23%23%20Suggested%20Changes%0A%3C%21--%20If%20you%20have%20specific%20suggestions%20for%20changes%2C%20please%20describe%20them%20here%20--%3E%0A%0A%3C%21--%20Thank%20you%20for%20helping%20improve%20our%20documentation%21%20--%3E)
+
diff --git a/en/getting-started/install-self-hosted/faqs.mdx b/en/getting-started/install-self-hosted/faqs.mdx
index 22fdb50b..54a15aaa 100644
--- a/en/getting-started/install-self-hosted/faqs.mdx
+++ b/en/getting-started/install-self-hosted/faqs.mdx
@@ -135,3 +135,13 @@ Make sure to back up your existing data before upgrading. Refer to [Question 8](
[Edit this page](https://github.com/langgenius/dify-docs/edit/main/en/getting-started/install-self-hosted/faqs.mdx) | [Report an issue](https://github.com/langgenius/dify-docs/issues/new?title=Documentation%20Issue%3A%20&body=%23%23%20Issue%20Description%0A%3C%21--%20Please%20briefly%20describe%20the%20issue%20you%20found%20--%3E%0A%0A%23%23%20Page%20Link%0Ahttps%3A%2F%2Fgithub.com%2Flanggenius%2Fdify-docs%2Fblob%2Fmain%2Fen/getting-started/install-self-hosted%2Ffaqs.mdx%0A%0A%23%23%20Suggested%20Changes%0A%3C%21--%20If%20you%20have%20specific%20suggestions%20for%20changes%2C%20please%20describe%20them%20here%20--%3E%0A%0A%3C%21--%20Thank%20you%20for%20helping%20improve%20our%20documentation%21%20--%3E)
+{/*
+Contributing Section
+DO NOT edit this section!
+It will be automatically generated by the script.
+*/}
+
+---
+
+[Edit this page](https://github.com/langgenius/dify-docs/edit/main/en/getting-started/install-self-hosted/faqs.mdx) | [Report an issue](https://github.com/langgenius/dify-docs/issues/new?title=Documentation%20Issue%3A%20&body=%23%23%20Issue%20Description%0A%3C%21--%20Please%20briefly%20describe%20the%20issue%20you%20found%20--%3E%0A%0A%23%23%20Page%20Link%0Ahttps%3A%2F%2Fgithub.com%2Flanggenius%2Fdify-docs%2Fblob%2Fmain%2Fen/getting-started/install-self-hosted%2Ffaqs.mdx%0A%0A%23%23%20Suggested%20Changes%0A%3C%21--%20If%20you%20have%20specific%20suggestions%20for%20changes%2C%20please%20describe%20them%20here%20--%3E%0A%0A%3C%21--%20Thank%20you%20for%20helping%20improve%20our%20documentation%21%20--%3E)
+
diff --git a/en/workshop/basic/the-right-way-of-markdown.mdx b/en/workshop/basic/the-right-way-of-markdown.mdx
new file mode 100644
index 00000000..b8c94af4
--- /dev/null
+++ b/en/workshop/basic/the-right-way-of-markdown.mdx
@@ -0,0 +1,249 @@
+---
+title: "The Right Way of Markdown"
+---
+
+[Markdown](https://www.markdownguide.org/basic-syntax/) transforms your Dify app outputs from plain text dumps into properly formatted, professional responses. Use it in Answer and End nodes to render headers, lists, code blocks, tables, and more to create clear visual hierarchies for the end user.
+
+## Basic Markdown Syntax in Dify
+
+Use Markdown in your Answer / End nodes to render things like:
+
+- Headings
+- Bold and Italic text, strike-through text
+- Lists
+- Tables
+- Fenced Code Blocks
+- Audio and Video
+
+
+
+### Headings
+
+Use `#` for headings, with the number of `#` symbols indicating the heading level:
+
+```markdown
+# Heading 1
+## Heading 2
+### Heading 3
+```
+
+### Bold, Italic, and Strikethrough
+
+You can format text as bold, italic, or strikethrough:
+
+```markdown
+**Bold Text**
+*Italic Text*
+~~Strikethrough Text~~
+```
+
+
+### Lists
+
+You can create ordered and unordered lists:
+
+```markdown
+- Unordered List Item 1
+- Unordered List Item 2
+ - Nested Unordered Item
+1. Ordered List Item 1
+2. Ordered List Item 2
+ 1. Nested Ordered Item
+```
+
+### Tables
+
+You can create tables using pipes and dashes:
+
+```markdown
+| Header 1 | Header 2 |
+|----------|----------|
+| Row 1 Col 1 | Row 1 Col 2 |
+| Row 2 Col 1 | Row 2 Col 2 |
+```
+
+### Fenced Code Blocks
+
+Use triple backticks to create fenced code blocks:
+
+```python
+def hello_world():
+ print("Hello, World!")
+```
+
+### Audio and Video
+
+You can embed audio and video files using the following syntax:
+
+```markdown
+
+
+```
+
+## Advanced Markdown Features in Dify
+
+### Button & Links
+
+You might not be happy with the default follow-up questions generated by the LLM. In this case, you can use buttons and links to guide the conversation in a specific direction.
+
+
+
+You can use the following syntax to create buttons and links:
+
+```
+
+
+```
+
+For buttons, we need to define two attributes `data-variant` and `data-message`.
+
+- `data-variant`: The style of the button, can be `primary`, `secondary`, `warning`, `secondary-accent`, `ghost`, `ghost-accent`, `tertiary`.
+- `data-message`: The message that will be sent when the button is clicked.
+
+For links, it's more straightforward:
+
+```
+Dify
+```
+
+Or you can use the `abbr` syntax to create an abbreviation link, this is useful for create interactive links that can be used in the conversation:
+
+```
+[Special Link](abbr:special-link)
+```
+
+### Form
+
+For forms, we need to define the `data-format` attribute, which can be `json` or `text`. If not specified, it defaults to `text`. The form will be submitted as a JSON object if `data-format="json"` is set.
+
+
+
+#### Supported Input Types
+
+Dify supports a variety of input types for forms, including:
+
+- text
+- textarea
+- password
+- time
+- date
+- datetime
+- select
+- checkbox
+- hidden
+
+If you want to render a form during the conversation, you can use the following syntax:
+
+```
+
+
+\`\`\`echarts and place your chart configuration inside.
+
+
+\`\`\`abc and place your ABC notation inside.
+
+
+### 見出し
+
+`#` を使って見出しを作成します。`#` の数が見出しの階層を表します:
+
+```markdown
+# 見出し 1
+## 見出し 2
+### 見出し 3
+```
+
+### 太字・斜体・取り消し線
+
+以下のような構文でテキストのスタイルを変更できます:
+
+```markdown
+**太字テキスト**
+*斜体テキスト*
+~~取り消し線テキスト~~
+```
+
+### リスト
+
+順序付きおよび順序なしリストを作成できます:
+
+```markdown
+- 順序なし項目 1
+- 順序なし項目 2
+ - ネストされた項目
+1. 順序付き項目 1
+2. 順序付き項目 2
+ 1. ネストされた項目
+```
+
+### 表
+
+パイプ(|)とハイフン(-)を使って表を作成します:
+
+```markdown
+| ヘッダー 1 | ヘッダー 2 |
+|------------|------------|
+| 行 1 列 1 | 行 1 列 2 |
+| 行 2 列 1 | 行 2 列 2 |
+```
+
+### 複数行のコードブロック
+
+3つのバッククォート(\`\`\`)を使ってコードブロックを作成します:
+
+```python
+def hello_world():
+ print("Hello, World!")
+```
+
+### オーディオとビデオ
+
+以下の構文を使用して、音声および動画を埋め込むことができます:
+
+```markdown
+
+
+```
+
+
+
+以下の構文でボタンとリンクを作成できます:
+
+```
+
+
+```
+
+ボタンには次の2つの属性が必要です:
+
+* `data-variant`: ボタンのスタイル。`primary`、`secondary`、`warning`、`secondary-accent`、`ghost`、`ghost-accent`、`tertiary` など
+* `data-message`: ボタンがクリックされたときに送信されるメッセージ
+
+リンクの構文はよりシンプルです:
+
+```
+Dify
+```
+
+会話内で特定のアクションをトリガーする省略リンク (`abbr`) も使えます:
+
+```
+[特別リンク](abbr:special-link)
+```
+
+---
+
+### フォーム(Form)
+
+フォームを使用する際には `data-format` 属性を設定する必要があります。`json` または `text` を指定でき、デフォルトは `text` です。`data-format="json"` に設定すると JSON 形式で送信されます。
+
+
+
+#### サポートされている入力タイプ
+
+Dify では以下の入力タイプをフォームで利用できます:
+
+* text(テキスト)
+* textarea(複数行テキスト)
+* password(パスワード)
+* time(時間)
+* date(日付)
+* datetime(日付と時間)
+* select(セレクトボックス)
+* checkbox(チェックボックス)
+* hidden(非表示フィールド)
+
+以下のような構文で会話中にフォームを描画できます:
+
+```
+
+```
+
+
+
+\`\`\`echarts でコードブロックを開始し、その中に設定を記述してください。
+
+
+\`\`\`abc でコードブロックを開始し、ABC 記譜内容を記述してください。
+
+
+### 标题
+
+使用 `#` 来表示标题,`#` 的数量表示标题级别:
+
+```markdown
+# 一级标题
+## 二级标题
+### 三级标题
+```
+
+### 加粗、斜体、删除线
+
+你可以使用以下方式设置文本样式:
+
+```markdown
+**加粗文本**
+*斜体文本*
+~~删除线文本~~
+```
+
+### 列表
+
+可以创建有序和无序列表:
+
+```markdown
+- 无序列表项 1
+- 无序列表项 2
+ - 嵌套无序项
+1. 有序列表项 1
+2. 有序列表项 2
+ 1. 嵌套有序项
+```
+
+### 表格
+
+使用竖线和短横线创建表格:
+
+```markdown
+| 表头 1 | 表头 2 |
+|--------|--------|
+| 第 1 行第 1 列 | 第 1 行第 2 列 |
+| 第 2 行第 1 列 | 第 2 行第 2 列 |
+```
+
+### 多行代码块
+
+使用三个反引号 \`\`\`python 创建多行代码块:
+
+```python
+def hello_world():
+ print("Hello, World!")
+```
+
+### 音频和视频
+
+可以通过以下语法插入音频和视频:
+
+```markdown
+
+
+```
+\`\`\`echarts 开头的代码块,并将配置写入其中。
+\`\`\`abc 开头的代码块,并将 ABC 记谱内容写入其中。
+