1
0
Fork 0
docsearch/docs/index.haml
2015-12-18 19:02:55 +01:00

98 lines
4.8 KiB
Text
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

---
layout: default
---
.main-content
.jumbotron
.container.pos-rel
.jumbotron-header
%h1.jumbotron-title
%span.blue
%span.big> D
OC
= succeed "EARCH" do
%span.big S
%p The easiest way to add search to your documentation.
.jumbotron-left-column
%p Weve created the fastest, easiest way to search within documentation.
%p And best of all? Its free!
#join-form
%h3 Want to try it out?
%label Website
%input{:type=>"text", :placeholder => "http://docs.mywebsite.com/"}
%p Well crawl the documentation pages of your website and index them on Algolia.
%label Email
%input{:type=>"text", :placeholder => "my@email.com"}
%p Well send you the code you need to integrate the search autocomplete into your documentation.
%input{:type=>"submit", :name => "join", :value => "Join the beta!", :id => "form-submit"}
#section_why.page-section
.container
.row
.col-sm-10.col-sm-offset-1
%h2.page-section-title Why DocSearch?
%p Were scratching our own itch here. As developers, we spend a lot of time reading documentation, and it isnt always easy to find the information we need.
%p Not blaming anyone here. Building a good search for a documentation is a complex challenge. We happen to have a lot of experience doing that, and we want to share it with the world. For free.
#section_examples.page-section.page-section-dark
.container
.row
.col-sm-10.col-sm-offset-1
%h2.page-section-title DocSearch is live
%p
Weve integrated DocSearch into several open source projects.
%br Take a look.
.row
.col-sm-4.showcase
%a{:href => "//bootstrap.algolia.com", :target => "_blank"}
%img.img-responsive.logo{:src => "./img/showcase/logo-bootstrap.png"}
%img.img-responsive.example{:src => "./img/showcase/example-bootstrap.gif"}
Bootstrap
.col-sm-4.showcase
%a{:href => "//eslint.org/", :target => "_blank"}
%img.img-responsive.logo{:src => "./img/showcase/logo-eslint.png"}
%img.img-responsive.example{:src => "./img/showcase/example-eslint.gif"}
ESLint
.col-sm-4.showcase
%a{:href => "//docs.scala-lang.org/", :target => "_blank"}
%img.img-responsive.logo{:src => "./img/showcase/logo-scala.png"}
%img.img-responsive.example{:src => "./img/showcase/example-scala.gif"}
Scala
.col-sm-4.showcase
%a{:href => "//babeljs.algolia.com/", :target => "_blank"}
%img.img-responsive.logo{:src => "./img/showcase/logo-babel.png"}
%img.img-responsive.example{:src => "./img/showcase/example-babel.gif"}
Babel.js
.col-sm-4.showcase
%a{:href => "//reactjs.algolia.com/", :target => "_blank"}
%img.img-responsive.logo{:src => "./img/showcase/logo-react.png"}
%img.img-responsive.example{:src => "./img/showcase/example-react.gif"}
React.js
#section_how.page-section
.container
.row
%h2.page-section-title How it works
.row
.col-sm-4.how-it-works
%h3
%span.how-it-works-number> 1
We crawl your documentation pages
%p We built a website crawler designed to index every section of your documentation.
%p Just send us the URL of your documentation, and well periodically run the crawler so youre always up-to-date.
.col-sm-4.how-it-works
%h3
%span.how-it-works-number> 2
We configure your search experience
%p You dont need to configure any settings or even have an Algolia account.
%p We take of all of this automatically to ensure the best documentation search experience.
.col-sm-4.how-it-works
%h3
%span.how-it-works-number> 3
You add the autocomplete script to your UI
%p Well send you the script so you can integrate Algolia autocomplete to power your search.
%p You will receive the same speed, relevance and best-in-class UX as our paying customers.
#section_get-started.page-section.page-section-dark
.container
.row
.col-sm-10.col-sm-offset-1
%h2.page-section-title Get started
%p Add the url of your documentation site and your email to the form at the top of the page. Well get back to you with what you need to integrate your new search into your website.
%p Dont forget, DocSearch is completely free! Theres no need to sign up for Algolia or submit any payment information. Lets tackle document search together.