The Wayback Machine - https://web.archive.org/web/20200917030743/https://github.com/bcosca/fatfree/issues/1061
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

Make API Reference searchable #1061

Open
marcus-at-localhost opened this issue Aug 23, 2017 · 7 comments
Open

Make API Reference searchable #1061

marcus-at-localhost opened this issue Aug 23, 2017 · 7 comments

Comments

@marcus-at-localhost
Copy link

@marcus-at-localhost marcus-at-localhost commented Aug 23, 2017

Hey, many software projects are using the free Docsearch by algolia (e.g. http://vuejs.org and http://getbootstrap.com/ )
Could that be an option for f3?

https://github.com/algolia/docsearch

@ikkez
Copy link
Collaborator

@ikkez ikkez commented Aug 23, 2017

Good point.
The main repo of the website is here https://github.com/F3Community/F3com, and there actually is a hidden search feature like (https://fatfreeframework.com/3.6/search?q=array_intersect_key) but the search is still pretty rudimentary and should be improved.

@marcus-at-localhost
Copy link
Author

@marcus-at-localhost marcus-at-localhost commented Aug 29, 2017

Nice! I'm using googles in page search via site:fatfreeframework.com array_intersect_key, but algolia also takes anchors into account which would be perfect for searching f3 docs.

Anyway - keep up the good work!

@eydun
Copy link

@eydun eydun commented Nov 9, 2017

Algolia search is pretty awesome

@olaulau
Copy link

@olaulau olaulau commented Jul 26, 2019

I totally agree, the documentation is good, but lacks of a search engine.
also, it's not convenient that it's splitted into "user guide" ant "api reference".

@n0nag0n
Copy link

@n0nag0n n0nag0n commented Sep 10, 2020

@ikkez If this is still an option, I'm game for implementing it. I just can't since I'm not the website owner.

@ikkez
Copy link
Collaborator

@ikkez ikkez commented Sep 10, 2020

I'm for refactoring the whole system and make it better from the ground up, not just hack that search into it ^^

@n0nag0n
Copy link

@n0nag0n n0nag0n commented Sep 10, 2020

You have way more time than I do @ikkez Bless you.....

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
5 participants
You can’t perform that action at this time.