What is SvelDocs?

Your Code, Your Rules

SvelDocs provides you with all of the code for creating modern markdown documentation websites. In fact, this very site is the boilerplate code.

The files are structured for both expansion and customization. There are configuration files for a quick setup, but if something does not match your taste, you can always customize the code to your liking.

Features

• Supports both Static Site Generation (SSG) and Server Side Rendering (SSR)
• Simple structure for adding Tabs, Groups, and Pages
• Table of Contents
• Searching
• Remark / Rehype plugins
• Automatically generated .md and llms.txt routes for Artificial Intelligence
• Syntax highlighted code blocks
• Search Engine Optimization (SEO) and sitemap.xml
• Accessibility and Tab Navigation
• Light and Dark mode
• Clean and Modern look

Ready to Dive In?

Head over to the Quick Start section to clone the repository and launch your own documentation.

OR

Explore the rest of the documentation to see SvelDocs's options and capabilities.

Inspiration

I found it difficult to find a nice looking and customizable template with all of the features that I wanted for creating documentation, so I decided to make it myself.

Commonly used documentation websites that I used for research include:

• TailwindCSS
• Shadcn UI
• Mintlify
• Bits UI
• Turborepo