📘 The easiest way to add search to your documentation.
a94f4c57dc
* # This is a combination of 2 commits.
# This is the 1st commit message:
# This is a combination of 3 commits.
# This is the 1st commit message:
# This is a combination of 3 commits.
# This is the 1st commit message:
chore(deps): update dependency onchange to v4.1.0
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
# This is the commit message #2:
update README #269
# This is the commit message #3:
fix json
# This is the commit message #2:
enhance as algolia/docsearch-configs#387
# This is the commit message #3:
updating flavicon
# This is the commit message #2:
Update 1-customize-configuration-file.html.md.erb
* # This is a combination of 2 commits.
# This is the 1st commit message:
# This is a combination of 3 commits.
# This is the 1st commit message:
# This is a combination of 3 commits.
# This is the 1st commit message:
chore(deps): update dependency onchange to v4.1.0
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
# This is the commit message #2:
update README #269
# This is the commit message #3:
fix json
# This is the commit message #2:
enhance as algolia/docsearch-configs#387
# This is the commit message #3:
updating flavicon
# This is the commit message #2:
Update 1-customize-configuration-file.html.md.erb
* documenting algolia/docsearch-scraper#387
* documenting algolia/docsearch-scraper#387
* fixing changelog
* fixing typo
* # This is a combination of 2 commits.
# This is the 1st commit message:
# This is a combination of 3 commits.
# This is the 1st commit message:
# This is a combination of 3 commits.
# This is the 1st commit message:
chore(deps): update dependency onchange to v4.1.0
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
# This is the commit message #2:
update README #269
# This is the commit message #3:
fix json
# This is the commit message #2:
enhance as algolia/docsearch-configs#387
# This is the commit message #3:
updating flavicon
# This is the commit message #2:
Update 1-customize-configuration-file.html.md.erb
* # This is a combination of 2 commits.
# This is the 1st commit message:
# This is a combination of 3 commits.
# This is the 1st commit message:
# This is a combination of 3 commits.
# This is the 1st commit message:
chore(deps): update dependency onchange to v4.1.0
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
# This is the commit message #2:
update README #269
# This is the commit message #3:
fix json
# This is the commit message #2:
enhance as algolia/docsearch-configs#387
# This is the commit message #3:
updating flavicon
# This is the commit message #2:
Update 1-customize-configuration-file.html.md.erb
* documenting algolia/docsearch-scraper#387
* documenting algolia/docsearch-scraper#387
* fixing typo
* fixing style issue
* fixing recurrnet issue
* general github handle
* fixing missed conflict
* fix and closes algolia/docsearch-configs-private#82
* remove builded content
* adding hitsperpage
* fix
* enhance
* doc proof reading part 1
* adding how to build an index and updating content
* reformat
* textlint
* typos
* Update behavior.md
* Update config-file.md
* Update crawler-overview.md
* Update dropdown.md
* Update faq.md
* Update how-do-we-build-an-index.md
* Update how-does-it-work.md
* Update inside-the-engine.md
* Update integrations.md
* Update styling.md
* Update tips.md
* Update who-can-apply.md
* Update integrations.md
* Usefull but sometime we do want to ignore it on purpose
*
|
||
|---|---|---|
| .github | ||
| docs | ||
| scripts | ||
| src | ||
| .babelrc | ||
| .coveralls.yml | ||
| .eslintignore | ||
| .eslintrc.js | ||
| .gitignore | ||
| .npmignore | ||
| .nvmrc | ||
| .travis.yml | ||
| CHANGELOG.md | ||
| CONTRIBUTING.md | ||
| index.js | ||
| jest.config.js | ||
| LICENSE | ||
| netlify.toml | ||
| package.json | ||
| README.md | ||
| webpack.config.jsdelivr.babel.js | ||
| webpack.serve.config.babel.js | ||
| yarn.lock | ||
The easiest way to add search to your documentation. For free.
DocSearch will crawl your documentation website, push its content to an Algolia index, and allow you to add a dropdown search menu for your users to find relevant content in no time.
Check out our website for a complete explanation and documentation.
Related projects
DocSearch is made of 3 repositories:
- algolia/docsearch contains the
docsearch.jscode source and the documentation website. - algolia/docsearch-configs contains the JSON files representing all the configs for all the documentations DocSearch is powering
- algolia/docsearch-scraper contains the crawler we use to extract data from your documentation. The code is open-source and you can run it from a Docker image