1
0
Fork 0
Commit graph

57 commits

Author SHA1 Message Date
Pixelastic
871296fc29 docs(readme): Add links to other repositories 2018-08-20 17:14:23 +02:00
Pixelastic
1ade9cdbcf docs(readme): Update readme 2018-08-20 16:13:14 +02:00
Pixelastic
0c5b610159 docs(deploy): Update deploy documentation system 2018-08-20 13:51:59 +02:00
Sylvain Pace
498675f9a3
Revert "Revert "doc(site): Fixed typos (#277)" (#278)" (#279)
This reverts commit 883894f963.
2018-03-12 16:19:09 +01:00
Sylvain Pace
883894f963
Revert "doc(site): Fixed typos (#277)" (#278)
This reverts commit d3f0aaca85.
2018-03-11 21:17:19 +01:00
Pascal Borreli
d3f0aaca85 doc(site): Fixed typos (#277) 2018-03-11 21:01:45 +01:00
Sylvain Pace
d711a29521
Doc/update content (#274)
* integrate previous work

enhance tyle/content

reformat part 1

wait for review

* adance start_urls

* enhance attributes description

* fix typo

* proofread documentation/docsearch

* add apiKey mention

intefrate review and small fixes

finished proofreading

update sclient-rendering

use unseen review

* update README #269

* fix json

* explain new parameter from algolia/docsearch-scraper#368 , solve algolia/docsearch-configs#321
2018-02-28 16:04:28 +01:00
Sylvain Pace
5f977a8d5b fix typo 2018-02-08 15:39:58 +01:00
Sylvain Pace
5b4c415b0f remove link 2018-02-08 15:39:17 +01:00
Sylvain Pace
13e646ac27 fix images issue 2018-02-08 15:35:59 +01:00
Sylvain Pace
8afba360d9 fix images issue 2018-02-08 15:27:52 +01:00
Sylvain Pace
2c82ead943
docs(update CDN) cf algolia/docsearch#207 (#234) 2017-11-07 18:16:39 +01:00
Haroen Viaene
8b57114f41 docs(readme): link rawgit logo (#205)
svg still is pretty bad for support in GitHub (at least now it works a little bit), but remote images work better

also messaged GitHub support about this

fixes #204
2017-10-18 00:34:44 +02:00
Lucas Bonomi
9663e01543 docs(website): new design and logo 2017-10-17 22:16:04 +02:00
Vincent Voyer
28159c2801 chore(docs): precise how to run project (#200)
Remove redundant messages in README and CONTRIBUTING. Move GIF to
bootstrap.

Allow netlify deploys to work.
2017-10-17 17:02:45 +02:00
Lukas Drgon
3ca4c95aaa docs(readme): Add jsDelivr hits badge (#196) 2017-10-11 10:41:31 -07:00
Daniel Maher
1360d37a71 docs(global): Add section on "powered by Algolia" attribution (#194)
docs(global): Add section on "powered by Algolia" attribution

This is a tacit agreement, but imho it should really be stated somewhere explicitly.

* docs(global): Fix powered => search
2017-10-10 14:26:24 +02:00
Maxime
f8cada1429 Merge branch 'develop' 2017-08-08 11:42:44 -07:00
Maxime
32df487df0 v2.4.0
<a name="2.4.0"></a>
# [2.4.0](https://github.com/algolia/docsearch/compare/v2.3.3...v2.4.0) (2017-08-08)
2017-08-08 10:26:45 -07:00
Maxime
5f69d42677 add queryHook argument 2017-08-08 10:15:39 -07:00
Haroen Viaene
5123508d96 docs(readme): API parameters docs moved 2017-07-04 09:45:51 +02:00
Maxime
3614194e3b Update README.md 2017-05-29 08:44:58 +02:00
Maxime
bad44510af Update README.md (#183) 2017-05-29 08:44:07 +02:00
Katherine McAuliffe
a656a5bc5c Update README.md (#180)
A few small grammar and typo fixes.
2017-05-15 20:10:44 +02:00
Josh Dzielak
a2d9f93cc3 Add appId to Algolia options
For when someone is running their own crawler.

Came up here: https://discourse.algolia.com/t/couldnt-get-docsearch-to-work/1286/2
2017-05-11 09:40:57 +02:00
Haroen Viaene
bd3441d952 docs(readme): add installation instructions on npm (#169)
docsearch is published on npm too, but it's a bit confusing that it's actually published as `docsearch.js`, so this should definitely be put somewhere in the README
2017-02-10 13:33:42 +01:00
Haroen Viaene
72d673e137 docs(README): update links to search parameters
The link used to point to the ruby explanations, but it didn’t exist at that id. Since it’s using js, I changed it to point to that point in the js documentation
2017-02-08 10:14:42 +01:00
Matthieu Dumont
869a9fbf34 docs(images): absolute URL for README images
So that it works both in the README and documentation.md
Closes #152
2016-12-06 19:00:10 +01:00
Jan Petr
b89c2a9ab0 Add HTTPS to examples (#126) 2016-07-15 14:46:04 +02:00
Maxime Locqueville
69e1dfb43d Merge remote-tracking branch 'origin/develop' 2016-07-07 14:17:24 +02:00
maxiloc
b9f7913417 allow to override handleSelected. Fixes #121 (#123) 2016-07-07 14:14:49 +02:00
Rémy-Christophe Schermesser
c1b0926b32 chore(doc): Update README for v2 (#122) 2016-07-07 14:14:33 +02:00
maxiloc
4ab69a3b9b V2 modifs (#110)
* feat(dom): wrap separator with a span

* feat(option,dom): add debug to root class + add duplicate class on subcategory and title

* fix(dom): do not display content wrapper if there is nothing inside
2016-06-12 19:50:09 +02:00
Tim Carry
ef83775f7e feat(serve): Watch and serve all needed files (#91)
Running `npm run serve` will watch for changes in the source files and
rebuild all `css` and `js` files accordingly in the `dist` folder. It
will also expose the same files on `http://localhost:8080/` (by
default, if port `8080` is already taken it will move to an available
one).

This will let developers use a specific branch/version of docsearch in
their projects. Just open a new tab and run `npm run serve` in the
docsearch repo, and you'll be able to include the scripts from the
running server in your HTML.

As files are automatically regenerated on disk whenever a change is
detected, you can also `require` files by targeting the `dist` folder.
2016-05-12 11:58:28 +02:00
Sylvain Utard
0bdc91fc81 Merge pull request #88 from algolia/wsargent-patch-1
doc(readme): update link to point to main.css
2016-03-24 21:09:30 +01:00
Will Sargent
30bd7a6ee6 doc(readme): update link to point to main.css 2016-03-24 21:04:41 +01:00
Sylvain UTARD
395f6aa68d Display DocSearch's logo as title
Fix #30
2016-03-21 23:09:37 +01:00
Sylvain UTARD
bef7a2e855 doc(readme): ensure the links are correctly interpreted by the
documentation website
2016-03-04 20:41:34 +01:00
Matthieu Dumont
71b652bd92 docs(documentation.md): Fix not working links
Closes #65
2016-01-27 14:55:10 +01:00
Pixelastic
75308d6d69 docs(toc): Run doctoc 2016-01-20 16:14:58 +01:00
Pixelastic
9752f14527 docs(options): Add documentation about custom options 2016-01-20 15:51:46 +01:00
Sylvain UTARD
921085498d Merge branch 'develop' 2015-12-24 01:34:48 +01:00
Sylvain UTARD
a82c63ab73 chore(version): 1.0.0 is out 2015-12-24 01:34:40 +01:00
Sylvain UTARD
177d701b00 v1.0.0
<a name="1.0.0"></a>
# [1.0.0](https://github.com/algolia/docsearch/compare/v0.0.7...v1.0.0) (2015-12-24)

### Bug Fixes

* **isSubCategoryHeader:** ensure we hide the content of the left column if this flag is not set ([0e04ce4](https://github.com/algolia/docsearch/commit/0e04ce4)), closes [#47](https://github.com/algolia/docsearch/issues/47)
2015-12-24 01:11:02 +01:00
Sylvain UTARD
461a1ea412 docs(website): a few CSS & README minor fixes
- highlight background CSS rules was wrongly configured
 - navbar-header text was black
 - active links had a default black background
 - fixed a few links using references instead of actual links (doesn't
   work once extracted to documentation.md)
 - use absolute image path
2015-12-23 18:43:25 +01:00
Sylvain UTARD
092d85acf3 docs(readme): fixed README links 2015-12-23 15:24:04 +01:00
Sylvain UTARD
957defc07c chore(naming): use docsearch everywhere
Fix #40
2015-12-23 15:00:37 +01:00
Pixelastic
bfa06b26c3 docs(readme): Add badges
This adds badges to the readme, including the coverage one (through
coveralls).
2015-12-23 10:47:17 +01:00
Pixelastic
e615957840 docs(readme): Add info about styling and local dev
I've added a screencast in the readme, a screenshot of the default
colorscheme and a copy-paste of the CSS customization example.

The diff of the README is all red because I used
[formd](http://drbunsen.github.io/formd/) on the file to make the
links more readable (it simply uses reference instead of inlining).
2015-12-22 22:21:58 +01:00
Pixelastic
59cf825d0b docs(readme): Small rewording
Small rewording, typos and links.
2015-12-21 12:50:34 +01:00