nextapps-de / flexsearch

Next-Generation full text search library for Browser and Node.js
Apache License 2.0
12.53k stars 491 forks source link

New Documentation Proposal #346

Open emersonbottero opened 2 years ago

emersonbottero commented 2 years ago

I would like to create documentation using vitepress. Because I'm using this library to create the offline search plugin for it.. (coming soon..)

I redid the one from mermaid (is in the roadmap to be published) Just need confirmation that it would be of the maintainers interest this new documentation..

🤓

The docs folder could be left as it is or be organized in subcategories.. Is ok if there is no interest.. but let me know.

ts-thomas commented 2 years ago

Oh nice, thanks. The mermaid docs are pretty awesome. I really would like to have such docs. Feel free to start some docs, there is only one requirement, all website files needs to be packed in a branch of this repo (but can have external resources, like images or fonts). Because it can't be hosted outside Github or own server generally.

Thanks a lot

emersonbottero commented 2 years ago

first draft.. still have to fix references, links and better organize menus/folders https://emersonbottero.github.io/flexsearch/