svelte-docs

A rapid way to write documentation for your Svelte components

  • Owner: AlexxNB/svelte-docs
  • Platform:
  • License:: MIT License
  • Category::
  • Topic:
  • Like:
    0
      Compare:

Github stars Tracking Chart

Svelte-Docs

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




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:

npm init svelte-docs

Then write the documentation and build it into static site.

Documentation

For more info see the Documentation.

Main metrics

Overview
Name With OwnerAlexxNB/svelte-docs
Primary LanguageJavaScript
Program languageJavaScript (Language Count: 3)
Platform
License:MIT License
所有者活动
Created At2019-10-19 09:19:04
Pushed At2023-01-07 11:20:00
Last Commit At2021-01-26 09:17:13
Release Count0
用户参与
Stargazers Count169
Watchers Count4
Fork Count13
Commits Count231
Has Issues Enabled
Issues Count18
Issue Open Count8
Pull Requests Count15
Pull Requests Open Count32
Pull Requests Close Count5
项目设置
Has Wiki Enabled
Is Archived
Is Fork
Is Locked
Is Mirror
Is Private