svelte-doc-generator

Svelte documentation generator tool

Do you have a library of svelte components? You can generate a documentation for whole your library.

Installation

1. Install the package

npm install --save-dev svelte-doc-generator

2. Run setup tool

This will create webpack.config.js, package.json and site folder inside your project. You can just copy and paste this files into your project from template folder. You you already have package.json or webpack.config.js, just yours with from template ones.

node ./node_modules/.bin/svelte-doc-generator setup --project .

3. Create sample documentation component

For every component you want to create document for you have to create *Documentation.svelte file inside the component folder. Imagine that you have folder ./src/components/Input with component Input.svelte. Inside ./src/components/Input folder you have to create InputDocumentation.svelte like this:

<script>
  import { Component } from 'svelte-doc-generator';
  import Input from './Input.svelte';
</script> 
 
<Component title="Input">
  <div slot="description">
    Component to draw inputs easily.
  </div>
 
  <div slot="usages">
    <Component.Usage title="Default state">
      <Input />
    </Component.Usage>
  </div>
</Component>

4. Generate documentation library

This will generate a library from your components. This tool will include only components with *Documentation.svelte files inside.

node ./node_modules/.bin/svelte-doc-gnerator generate --library ./src/components --target ./site/library

Or run documentation changes watcher to regenerate documentation on every change inside your library documentations components.

node ./node_modules/.bin/svelte-doc-gnerator watch --library ./src/components --target ./site/library

5. Run your documentation site

This command will start webpack dev server to serve your site.

node ./node_modules/webpack-dev-server/.bin/webpack-dev-server.js --mode development

6. Open localhost

Open localhost:8080 in your browser and take a look at the result!

Full example

Take a look at the CheckboxGroupDocumentation.svelte example below. Do not take in mind CheckboxGroup component.

<script>
  import { Component } from 'svelte-doc-generator';
  import CheckboxGroup from './index';
 
  const checkboxes = [
    {
      label: 'Можно с животными',
      id: 'animals-are-allowed',
      value: 'animalsAreAllowed'
    },
    {
      label: 'Можно с детьми',
      id: 'kids-are-allowed',
      value: 'kidsAreAllowed'
    }
  ];
 
  const source = `const checkboxes = ${JSON.stringify(checkboxes, null, 2)};`;
</script> 
 
<Component title="Checkbox group">
  <div slot="description">
    Component to draw grouped checkboxes.
    <br/>
    <br/><Component.Code {source} lang="javascript" />
  </div>
 
  <div slot="usages">
    <Component.Usage title="Default checkboxes group">
      <CheckboxGroup {checkboxes} />
    </Component.Usage>
  </div>
</Component>

This code will generate the following output.

TODO

• Create documentation for every exported svelte component.