Use and translate snippets

Once a snippet is created, you can insert it into any article or category page using three methods: the merge code syntax (Markdown editor), the toolbar (Markdown editor), or the slash command (Advanced WYSIWYG editor). Snippets can also be translated so that when your articles are read in another language, the snippet content matches.

Insert a snippet into an article

Choose the method that matches your editor.

Using merge code syntax (Markdown editor)

In the Markdown editor, type the snippet's merge code value between double curly brackets directly in the content.

Example: {{snippet.snippet name}}

The merge code must match exactly, including capitalisation and spelling. A single character difference will prevent the snippet from rendering.

Using the toolbar (Markdown editor)

1. In the article editor, click the Content reuse () icon in the toolbar.
2. Select the snippet or use the Search snippets bar to narrow down by name.
3. Select the snippet to insert it.

Using the slash command (Advanced WYSIWYG editor)

1. In the Advanced WYSIWYG editor, type /snippets to open the Snippets tool in the slash menu.
2. Use the Search snippet bar to find the snippet you want to insert.
3. Hover over a snippet name to preview its full content.

4. Click the snippet to insert it. The content is inserted inside a content block highlighted with a dotted outline, distinguishing it from the rest of the article.
5. Click inside the snippet block to open the bubble menu.

Translate snippets

You can create snippets in multiple languages so that when your articles are read in a specific language, the matching translated snippet content is displayed.

Translate a new snippet

1. Navigate to Content tools () > Content resources > Snippets.
2. Click Create.
3. In the Create new snippet dialog, enter the snippet name, select the language, and choose your editor. Click Create.
4. From the Language dropdown at the top of the editor, select the language for the snippet.
5. Enter the content in that language.
6. Click the Translate to other languages dropdown, select the languages you want to translate into, and click Translate.

7. Click Save to save with all translations.

Translate an existing snippet

1. On the Snippets page, click the name of the snippet you want to translate.
2. Navigate to Translate to other languages, select the language, and click Translate.
3. To translate into additional languages, select each one and click Translate.
4. To overwrite an existing translation, click Translate again.
5. To remove a translation for a specific language, click the More () icon and select Clear content from this language.
6. Click Update to save.

Best practices

• Preview before inserting. In the Advanced WYSIWYG editor, hover over a snippet name in the slash menu to preview the full content before inserting.
• Use Insert as text with care. Converting a snippet to static text breaks the link to the source snippet. Future updates to the snippet will no longer apply to that instance.
• Translate before publishing. If your knowledge base is multilingual, add translations for new snippets before publishing articles that use them. A missing translation can display inconsistent or fallback content to readers.
• Use the slash command for faster insertion. In the Advanced WYSIWYG editor, /snippets is often faster than navigating the toolbar, especially when you know part of the snippet name.

FAQ