open-index/open-npm huggingface dataset:
npm package: @svelte-docgen/extractor
Description: Extractor for svelte-docgen
Author: Mateusz Kadlubowski
Latest version: 0.1.0

# `@svelte-docgen/extractor`

![NPM Version](https://img.shields.io/npm/v/@svelte-docgen/extractor?style=for-the-badge&logo=npm)

Package for extracting documentation data/nodes from Svelte component files.

> [!NOTE]
> Use this package if you want to create your own parser, analyser or generator.

## Dependencies

The following list powers this package:

1. [`parse()`](https://svelte.dev/docs/svelte/svelte-compiler#parse) from `"svelte/compiler"`,
1. compiler from [`svelte2tsx`](https://github.com/sveltejs/language-tools/tree/master/packages/svelte2tsx),
1. [TypeScript Compiler API](https://www.typescriptlang.org/docs/handbook/compiler-api.html).
npm package: @svelte-docs/core
Description: Core of Svelte-docs builder
Author: Alexey Schebelev
Latest version: 0.10.13

# Svelte-Docs

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