Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/AlexxNB/svelte-docs

A rapid way to write documentation for your Svelte components
https://github.com/AlexxNB/svelte-docs

Last synced: 2 months ago
JSON representation

A rapid way to write documentation for your Svelte components

Awesome Lists containing this project

README

        

# Svelte-Docs

**Sorry, but current version of Svelte-Docs will not be developing anymore. I will rework whole project with `svelte-kit` as it will be released.**

Svelte-Docs is a rapid way to write documentation for your Svelte components.

![](https://github.com/AlexxNB/svelte-docs/workflows/Publish%20create-svelte-docs/badge.svg)
![](https://github.com/AlexxNB/svelte-docs/workflows/Publish%20@svelte-docs/core/badge.svg)
![](https://github.com/AlexxNB/svelte-docs/workflows/Publish%20@svelte-docs/publisher/badge.svg)
![](https://github.com/AlexxNB/svelte-docs/workflows/Publish%20@svelte-docs/server/badge.svg)

> **It is an early alpha version of the Svelte-Docs so probably buggy and unstable. It also means that future versions may include breakable changes.**

## Features

* Based on MDSv format, which allows write documentation in Markdown mixed with Svelte's features.
* Import and use any Svelte components right inside a markup
* Documentation building as static files, so you can publish it everywhere
* Customizable themes
* Built-in deploy on Github Pages

## Getting Started

Just run:

```bash
npm init svelte-docs
```

Then [write](https://alexxnb.github.io/svelte-docs/writing/mdsv) the documentation and [build](https://alexxnb.github.io/svelte-docs/start) it into static site.

## Documentation

For more info see the [Documentation](https://alexxnb.github.io/svelte-docs).