Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New Documentation Proposal #346

Open
emersonbottero opened this issue Oct 26, 2022 · 3 comments
Open

New Documentation Proposal #346

emersonbottero opened this issue Oct 26, 2022 · 3 comments
Labels
documentation Documentation request

Comments

@emersonbottero
Copy link

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
Copy link
Contributor

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

@ts-thomas ts-thomas added the documentation Documentation request label Nov 4, 2022
@emersonbottero
Copy link
Author

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

@ts-thomas
Copy link
Contributor

I would like to put this on a branch on the flexsearch repository where you will have full access.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation request
Projects
None yet
Development

No branches or pull requests

2 participants