flo-bit / svleek

simple but beautiful documentation generator from markdown

Home Page:https://flo-bit.github.io/svleek/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

svleek - simple, beautiful and fast static documentation generator

work in progress...

See the current documentation/demo here.

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)

About

simple but beautiful documentation generator from markdown

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


Languages

Language:Svelte 70.6%Language:JavaScript 27.4%Language:HTML 1.3%Language:TypeScript 0.6%Language:CSS 0.1%