> ## Knowledge Base Index
> Fetch the complete knowledge base index at: https://help.chrisp.chat/sitemap.xml
> Use this file to discover available pages before exploring further.
> Pure-Markdown content can be obtained by appending a '.md' suffix to the content URLs listed in the sitemap (without the trailing slash).

# How to format Knowledge Base articles

__Use Crisp Markdown to format Knowledge Base articles with clear text, titles, lists, media, links, and helpful information boxes.__

Knowledge Base articles are written with Markdown, a lightweight syntax that keeps formatting simple and readable. This guide covers the formatting options supported in Crisp articles and shows the syntax you can paste directly into the editor.

---

# Format text

__Use these inline formats to make article content easier to scan:__

* ****Bold**** → `` `**This is bold**` `` displays as ****This is bold****
* ****Italic**** → `` `*This is italic*` `` displays as __This is italic__
* ****Underline**** → `` `__This is underlined__` `` displays as __This is underlined__
* ****Strikethrough**** → `` `~~This is removed~~` `` displays as This is removed
* ****Highlight**** → `` `++This is highlighted++` `` displays as This is highlighted
* ****Inline code**** → ``` `` `custom_property` ``` ``` `` displays as `custom_property` ```

---

# Insert titles and separators

Knowledge Base articles support titles from ****H1**** to ****H6****. Use titles to create a clear hierarchy and make long articles easier to navigate.

__Title syntax:__

* ****H1**** → `` `# Huge title` ``
* ****H2**** → `` `## Large title` ``
* ****H3**** → `` `### Medium title` ``
* ****H4**** → `` `#### Regular title` ``
* ****H5**** → `` `##### Small title` ``
* ****H6**** → `` `###### Tiny title` ``

Use `` `---` `` to insert a horizontal separator between larger content blocks.

---

# Insert lists and code

__Use lists when related items are easier to read one by one:__

* ****Bullet list**** → `` `* Item` ``
* ****Numbered list**** → `` `1. Item` ``

For code, use inline code for short values and fenced code blocks for longer examples.

__Code syntax:__

* ****Inline code**** → ``` `` `inline code` ``` ``
* ****Block code**** → wrap the code with three backticks, optionally followed by the language name

Supported code language labels include `` `html` ``, `` `xml` ``, `` `css` ``, `` `c` ``, `` `javascript` ``, `` `bash` ``, `` `go` ``, `` `java` ``, `` `json` ``, `` `php` ``, `` `python` ``, `` `ruby` ``, `` `swift` ``, and `` `objectivec` ``.

---

# Insert tables and quotes

Use tables for compact structured data. Tables support up to ****50 rows****.

```
| Header 1 | Header 2 | Header 3 || -------- | -------- | -------- || Value    | Value    | Value    || Value    | Value    | Value    |
```

Use `` `>` `` to quote someone or call attention to a short extract.

```
> Quoting someone there...
```

---

# Insert links

You can link to a section in the same article, another Crisp article, or an external page.

__Link syntax:__

* ****Section link**** → `This is [a link](#3-how-does-it-work)`
* ****Knowledge Base article link**** → `This is [a link](/en/article/install-crisp-8bn075/)`
* ****External link**** → `This is [a link](https://acme.com/)`

|| Section links start with `` `#` ``, followed by the heading level number, then the heading text in lowercase with spaces converted to dashes. Punctuation is not included. For example, `` `### How does it work?` `` becomes `` `#3-how-does-it-work` ``.

---

# Insert resources

Knowledge Base articles can include images, clickable images, videos, and frames.

__Resource syntax:__

* ****Image**** → `` `
![Image description](https://image.acme.com/name.jpg%20=1000xauto)
` ``
* ****Clickable image**** → `
[![Image description](https://image.acme.com/name.jpg =1000xauto)](https://acme.com)
`
* ****YouTube video**** → `${youtube}[A YouTube video label](qgPN61LTzZM)`
* ****Vimeo video**** → `${vimeo}[A Vimeo video label](261941485)`
* ****Dailymotion video**** → `${dailymotion}[A Dailymotion video label](x6g6xd1)`
* ****HTML frame**** → `
${frame}[An HTML frame label](https://example.com/frame.html)
`

|| For video embeds, only the video identifier is required for YouTube, Vimeo, and Dailymotion. For frames, use the full frame URL.

|| Frames cannot be previewed directly inside the editor. Publish or preview the article from the Knowledge Base page to check the final result.

---

# Insert tips, information boxes, and warnings

Use information boxes sparingly to make useful notes stand out without interrupting the article flow.

__Box syntax:__

* ****Tip box**** → `` `| This is a tip.` ``
* ****Information box**** → `` `|| This is information.` ``
* ****Warning box**** → `` `||| This is a warning.` ``

| This is a tip.

|| This is information.

||| This is a warning.

---

# Frequently Asked Questions

__Still have questions which were not covered in this article? Here is a collection of the most frequently asked questions on this topic.__

###### Can I use HTML inside Knowledge Base articles?

****Markdown is the recommended format for article content.**** If you need custom HTML, CSS, or JavaScript for layout changes, add it from ****Settings → Knowledge Base Settings → Customize your Knowledge Base → Include custom HTML code**** instead of mixing advanced code into every article.

###### How do I link to a heading inside the same article?

****Use the heading level number and the normalized heading text.**** For example, a heading written as `` `#### Setup steps` `` can be linked with `` `#4-setup-steps` ``.

###### Why does my embedded frame not show in the editor?

****Frames are checked from the published or previewed article, not directly in the editor.**** Save or publish the article, then open it from the Knowledge Base to confirm the frame loads correctly.