Snippet use cases

There are a number of great use cases for snippets:

  • Footers or other statements that need to be used a lot of places, such as confidentiality statements.
  • Brand names or terms that may change frequently: make a snippet for that term and only reference the snippet instead of the full term in all your documentation. When the term needs updating, update only the snippet and all your documentation is updated!
  • Repeated phrases or functions that you might want to standardize across articles, such as a "contact us" email link like this: contact us
  • Specialized sections for articles, such as Article Table of Contents.
  • Code to handle unusual formatting or to provide a set of styles for individual articles that differs from your general knowledge base styles.
  • Adding third-party scripts, embeds, or functionality.

Refer to Snippet best practices for more details on how to handle some of these use cases gracefully.