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 quick iterations and detailed understanding, while still offering easy expansion. SvelDocs provides a settings file with preset options that should fit most needs, but in the chance that something does not match your taste, you can always customize the code to your liking.
Features
- Simple structure for adding groups and links
- Quick settings to change the documentation look and structure
- Table of Contents
- Searching
- Remark / Rehype plugins
- API to expose markdown text
- Syntax highlighted code blocks
- Code copy button
- SEO
- 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: