Help

Guides

Guide discussions are for tutorials, how-tos, and reference material. They automatically generate a table of contents from the headings in your content.

When to use it

  • Step-by-step tutorials
  • How-to guides
  • Reference documentation
  • FAQs and knowledge base articles

How it works

Write your guide using markdown headings (##, ###) to structure the content. Snakk automatically generates a table of contents sidebar from those headings, with clickable links that scroll to each section.

Tips for writing good guides

  • Use clear, descriptive headings — they become the TOC entries
  • Start with an overview or introduction
  • Use numbered steps for sequential procedures
  • Include code blocks, images, and links where they help
  • Keep sections focused on one concept each