# beautidocu

> A beautiful way of making documentations powered using [Svelte](svelte.org) and [Svelte Material UI](https://sveltematerialui.com/)

Latest version **1.0.2** (published 2022-06-08) · ISC license · 0 weekly downloads

## Install

```sh
npm install beautidocu
pnpm add beautidocu
yarn add beautidocu
bun add beautidocu
```

Provides the command `beautidocs`.

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2022-06-08 |
| First published | 2022-06-08 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 5 |
| Unpacked size | 14.3 KB |
| Known vulnerabilities | 0 (+5 in 1 direct dependencies) |
| Install scripts | no |
| Maintainers | las328 |

## Links

- npm: https://www.npmjs.com/package/beautidocu
- npm.io page: https://npm.io/package/beautidocu

## Dependencies (5)

- [ora](https://npm.io/package/ora.md) ^6.1.0
- [chalk](https://npm.io/package/chalk.md) ^5.0.1
- [download](https://npm.io/package/download.md) ^8.0.0
- [markdown-it](https://npm.io/package/markdown-it.md) ^13.0.1
- [decompress-zip](https://npm.io/package/decompress-zip.md) ^0.3.3

## Recent versions

- 1.0.2 (latest) — 2022-06-08
- 1.0.1 — 2022-06-08
- 1.0.0 — 2022-06-08

## README

# BeautiDocs

A beautiful way of making documentations powered using [Svelte](svelte.org) and [Svelte Material UI](https://sveltematerialui.com/)


## 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
                    }
                ]
            }
        ]
        }
```

---
_Source: https://npm.io/package/beautidocu · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
