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

• Host: GitHub
• URL: https://github.com/AlexxNB/svelte-docs
• Owner: AlexxNB
• License: mit
• Created: 2019-10-19T09:19:04.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-01-07T11:20:00.000Z (about 2 years ago)
• Last Synced: 2024-07-11T15:55:16.239Z (6 months ago)
• Language: JavaScript
• Homepage: https://alexxnb.github.io/svelte-docs
• Size: 1.76 MB
• Stars: 167
• Watchers: 5
• Forks: 14
• Open Issues: 40
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-svelte - svelte-docs - A rapid way to write documentation for your Svelte components. (Dev Tools / Docs)

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).