Have ideas to improve npm?Join in the discussion! »

    @svelte-docs/core

    0.10.13 • Public • Published

    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.

    Keywords

    none

    Install

    npm i @svelte-docs/core

    DownloadsWeekly Downloads

    58

    Version

    0.10.13

    License

    MIT

    Unpacked Size

    34.6 kB

    Total Files

    30

    Last publish

    Collaborators

    • avatar