beautidocu

BeautiDocs

A beautiful way of making documentations powered using Svelte and Svelte Material UI

Get started

First you will have to make the files necessary. This process is automated via npx beautidocs init, go ahead and run that in the directory for the documentation.

Next you can edit these files to your needs, and make the content, if you want to know how to use the settings.json file that was created, look at the section below.

After that you can now turn the page into svelte code, which can then be compiled to show on the browser. Using npx beautidocs svelte will do exactly that.

settings.json

The settings.json file is used to set basic settings. It will set the entry's on the page.

For example heres one:

        {
        "list": [ // list of groups
            {
                "name": "group",
                "content": [ // content in the group
                    { // entry
                        "name": "Home",
                        "icon": "home",
                        "markdown": "home.md", // markdown file in current directory
                        "home": true // if the entry is on the / page
                    }
                ]
            }
        ]
        }