# svleek - simple, beautiful and fast static documentation generator

> [!IMPORTANT]
> This repository is archived, find the [new version with astro here](https://github.com/flo-bit/dogumentation)

See the current documentation/demo [here](https://flo-bit.github.io/svleek/).

## Todo

### should have

- github action

- npm package

- search bar

- edit mode (rebuild on file change)

- checklists

- ignore folders that dont have at least one .md file

- link to next page

- set title of pages

### nice to have

- videos (test from /static, + support youtube)

- format output files with prettier

- error, info and success alerts

- "text copied" popup (+fix bug with write code to clipboard on any click in a code field)