Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fastrepl/canary
🐤 Canary provides UI primitives for building modern search-bar for docs with self-hostable infrastructure.
https://github.com/fastrepl/canary
documentation docusaurus search starlight vitepress
Last synced: 3 months ago
JSON representation
🐤 Canary provides UI primitives for building modern search-bar for docs with self-hostable infrastructure.
- Host: GitHub
- URL: https://github.com/fastrepl/canary
- Owner: fastrepl
- License: mit
- Created: 2024-06-21T12:19:43.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-09-19T01:49:46.000Z (4 months ago)
- Last Synced: 2024-09-19T03:13:47.578Z (4 months ago)
- Topics: documentation, docusaurus, search, starlight, vitepress
- Language: Elixir
- Homepage: https://getcanary.dev
- Size: 4.1 MB
- Stars: 41
- Watchers: 0
- Forks: 1
- Open Issues: 49
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome - fastrepl/canary - Algolia alternative for technical docs (Elixir)
README
🐤 Canary
Search & Ask AI across your docs(webpage), GitHub issues, and discussions.
(OpenAPI, changelog, etc. are coming soon.)
> Currently, 🐤 provides two things:
1. Self-hostable core server.
Auth, fetching / indexing documents, handling queries, etc
| 
| 
|
| --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
|
Fetcher Status | Crawler Status |
2. Tiny web components for building a search bar.
Glob / tag filters, light / dark mode, multiple panels for Search / Ask AI, and more!
| 
| 
|
| --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
|
Search | Ask AI |
> code example:
```html
```
# Get started
We have documentation available at [getcanary.dev](https://getcanary.dev).