https://github.com/flo-bit/svleek

simple but beautiful documentation generator from markdown
https://github.com/flo-bit/svleek

documentation documentation-generator markdown svelte sveltekit tailwind

Last synced: 20 days ago
JSON representation

simple but beautiful documentation generator from markdown

• Host: GitHub
• URL: https://github.com/flo-bit/svleek
• Owner: flo-bit
• Created: 2023-12-12T16:21:55.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2023-12-12T17:00:33.000Z (about 1 year ago)
• Last Synced: 2024-12-16T11:36:28.792Z (22 days ago)
• Topics: documentation, documentation-generator, markdown, svelte, sveltekit, tailwind
• Language: Svelte
• Homepage: https://flo-bit.github.io/svleek/
• Size: 408 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# svleek - simple, beautiful and fast static documentation generator

work in progress...

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)