Document site generator for svelte projects

2023-10-04

Exploring document site generators

I need to find something that is quick and functional for my svelte projects but won’t take my time away from doing the part that I want to do, build things.

Ideally it would be nice if it could render mdsvex or do something similar so that I can render example svelte components.

Options

Sveltekit - Just use sveltekit and mdsvex. Build out my own platform for it. I have built something similar for work so perhaps I just build a new version of this?

Docusaurus - this is a very big and popular one. Built with react though so not sure how it will work with my svelte projects.

Mkdocs - Python library. Don’t want to run a whole different repo and coding environment just for this.

Docsify- This is pretty simple. Pages are in markdown. Doesn’t look like it has the table of contents but I could probably live without that. Seems like you just install the package and run its local server.

Starlight - A younger project built on Astro which seems like a very cool way to do this. With Astro’s framework mostly agnostic setup, it should be able to render svelte components too.

Try Starlight

This was so easy to set up. It is basically an Astro with some built in templates. It is fast, and Astro actually makes it quite easy to insert svelte components into the documents, as long as you first put the svelte component into an astro component.

This met everything I need.

Perfect.