Skip to content

A simple framework for building beautiful documentation sites with Svelte quickly and efficiently

License

Notifications You must be signed in to change notification settings

geodask/svelte-docsmith

Repository files navigation

Svelte DocSmith

NPM version License: MIT

A simple framework for building beautiful documentation sites with Svelte quickly and efficiently. Built primarily for personal projects, DocSmith aims to provide a streamlined documentation experience without unnecessary complexity. Components are based on shadcn-svelte and themes are provided by tweakcn for a polished, modern look out of the box.

What is Svelte DocSmith?

Svelte DocSmith was created to solve a personal need for simple, efficient documentation sites across various projects. While it's currently optimized for my personal use, it offers:

  • Markdown and MDX support
  • Polished, modern design based on shadcn-svelte and tweakcn
  • Built-in search functionality
  • Mobile-friendly design
  • Automatic table of contents
  • Fast development experience

Project Status

This project is currently in early development and is primarily maintained for personal use. While you're welcome to try it out, please note that APIs and features may change frequently as the project evolves.

License

This project is licensed under the MIT License - see the LICENSE file for details.

About

A simple framework for building beautiful documentation sites with Svelte quickly and efficiently

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published