Skip to content

Brisklemonade/sveleton

Repository files navigation


Logo

Sveleton

A "skeleton" documentation site powered by MdSvex & Svelte!
Explore the docs »

View Demo · Report Bug · Request Feature

About The Project

Sveleton (pronounced like skeleton but with a v) is a pretty "bare bones" documentation starter project. It utilizes MdSvex for the power of markdown in your svelte components, as well as tailwind for quick styling. With both of those combined, documentation will be a breeze!

(back to top)

Installation

npm init sveleton app-name

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License

(back to top)

Contact

Twitter - Brisklemonaid

(back to top)