FormidableLabs / FormidableLabs/spectacle

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

Open
#1,311 1 comment 0 reactions 0 assignees View on GitHub
Feature Request
Dominant language
TypeScript
Stars
10.2k
Forks
700
PR merge metrics
No merged PRs in 30d

Description

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

- Algolia:
- https://www.algolia.com/pricing/ -> It's free while the userbase is small
- https://www.algolia.com/for-open-source/ -> It should be free as long as Spectacle is Open-Source

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.