nikon/docsearch
1
0
Fork 0
Code Activity Actions

docs(readme): add image previews

Browse source
This commit is contained in:
François Chalifour 2020-09-02 09:57:55 +02:00
parent d01a848761
commit 1cbb22cf85
5 changed files with 9 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

0
.github/docsearch-logo.svg → .github/logo.svg vendored
View file

Side by side Swipe Overlay

Before

Width:  |  Height:  |  Size: 7.7 KiB

After

Width:  |  Height:  |  Size: 7.7 KiB

BIN
.github/preview-dark.png vendored Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 90 KiB

BIN
.github/preview-light.png vendored Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 96 KiB

BIN
.github/screencast.gif vendored Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 4.7 MiB

10
README.md
View file

@ -1,6 +1,6 @@
<div align="center">
[![DocSearch](.github/docsearch-logo.svg)](https://docsearch.algolia.com)
[![DocSearch](.github/logo.svg)](https://docsearch.algolia.com)
The easiest way to add search to your documentation – for free.
@ -14,6 +14,14 @@ DocSearch crawls your documentation, pushes the content to an Algolia index and
Check out our [website](https://docsearch.algolia.com) for a complete explanation and documentation.
## Preview
![Screencast](.github/screencast.gif)
| Light | Dark |
| --- | --- |
| ![Light preview](.github/preview-light.png) | ![Dark preview](.github/preview-dark.png) |
## Usage
> Don't have your Algolia credentials yet? [Apply to DocSearch](https://docsearch.algolia.com/apply)!