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

[Docs][Feature] Add the ability to search through the documentation #1311

Open
mathieucaroff opened this issue Dec 22, 2023 · 1 comment
Open
Labels
Feature Request Request for or introduction of new functionality

Comments

@mathieucaroff
Copy link

The documentation is still a bit messy and it's hard to find where concepts are documented. For instance, I was trying to find information about slide fragments, but nothing showed up in the API Reference.

Description

Add the ability to search through the documentation.

Proposal

This could be done via a search bar at the top of the page. This could rely on Algolia, since Spectacle is an opensource project.

Links / References

@mathieucaroff mathieucaroff added the Feature Request Request for or introduction of new functionality label Dec 22, 2023
@mathieucaroff
Copy link
Author

After-the-fact-note: There is not a single hit for "Fragment" when searching methodically through all the pages of the documentation. Looking into the code, I saw that there's no code in Spectacle for fragments: Fragments actually are a recipe. Still, this recipe should be documented, as the concept is presented in the demo, see here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Feature Request Request for or introduction of new functionality
Projects
None yet
Development

No branches or pull requests

1 participant