atomic-server
atomic-server copied to clipboard
Explore alternatives to mdbook for documentation
The current mdbook tool works decently, but has a couple of shortcomings:
- Basic, dated design
- No support for better codeblocks (e.g. for react / svelte), no support for filenames
- No support for component previews
We should consider some alternatives.
Astro Starlight
- Supports components and custom pages
- Looks good out of the box
- Uses Astro, which means we could use AtomicServer as data source (could be huge)
Challenges / questions
- Both Existing URLs and structure should be kept.
mdbookuses aSUMMARY.mdto set the structure. This may require some redirect strategy. - Is the added benefit worth the effort?