diff --git a/README.md b/README.md index 3fac91b8..21e5797e 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,42 @@ -Documentation Search -========================= +# Documentation Search + +Add a search autocomplete to your documentation. + +# Usage + +```html + + +``` + +```javascript +documentationSearch({ + apiKey: apiKey, // Mandatory + indexName: indexName, // Mandatory + inputSelector: '#search-input' // Mandatory +}); +``` + +# Examples + +- http://eslint.org/ +- https://bootstrap.algolia.com/ +- https://reactjs.algolia.com/ +- https://babeljs.algolia.com/ + +# How do I get my `apiKey` and `indexName`? + +Just send us [an email](mailto:documentationsearch@algolia.com) with the url of +the documentation you would like to search, and we'll this info back to you. + +# How does it work? + +The JavaScript library is a wrapper on top of our +[autocomplete.js](https://github.com/algolia/autocomplete.js) library, along +with default CSS styling of the dropdown. + +The indexing of the data itself is currently done by an internal tool (we will +release it later), that runs every hour. # Development diff --git a/css/_base.sass b/css/_base.sass deleted file mode 100644 index 63593150..00000000 --- a/css/_base.sass +++ /dev/null @@ -1,21 +0,0 @@ -$font-family-sans-serif: 'Open Sans', "Helvetica Neue", Helvetica, Arial, sans-serif -$font-size-base: 14px - -$headings-font-family: 'Raleway' -$headings-font-weight: 300 - -$brand-primary: #1D96C7 -$code-color: #A3B6CB - -$text-color: rgba(black,.75) - -$anchor-offset: 100px -$community-color: #674492 -$success-color: #58D158 -$gray-light: #F3F3F3 -$dark-blue: #0D1D30 -$light-blue: lighten($dark-blue, 70%) - -$secondary-color: green - -$navbar-height: 50px diff --git a/css/_footer.sass b/css/_footer.sass deleted file mode 100644 index 40ab3675..00000000 --- a/css/_footer.sass +++ /dev/null @@ -1,10 +0,0 @@ -footer.site-footer - padding-top: 2em - margin-top: 0 - border-top: 1px solid $gray-lighter - background-color: white - text-align: center - .fa.fa-heart - color: #E61870 - .input-group-addon - background-color: transparent diff --git a/css/_header.sass b/css/_header.sass deleted file mode 100644 index 9f501341..00000000 --- a/css/_header.sass +++ /dev/null @@ -1,46 +0,0 @@ -header.site-header - position: fixed - - top: 0 - width: 100% - z-index: 99 - background: linear-gradient(to right, rgba(#0a1724, .8) -50%, rgba(#172c4f, .5) 100%) - transition: background 2s ease - nav.navbar - margin-bottom: 0 - background-color: #0B1724 - border-radius: 0 - border: none - .navbar-collapse.in - background-color: #0B1724 !important - animation: fadeInUp .2s ease-in-out - position: fixed - +position(0,0,0,0) - padding: 20% - font-size: 1.2em - li - padding-bottom: 1em - .navbar-brand - font-weight: 600 - color: white - z-index: 1 - .navbar-header - position: relative - z-index: 2 - .navbar-toggle - background-color: $brand-primary - border: solid 1px $brand-primary - color: white - &.collapsed - background-color: transparent - border: solid 1px rgba(white,.4) - color: white - .navbar-nav - > li > a - padding-bottom: 0 - > .active > a - color: #1D96C7 !important - background-color: transparent - -.main-content - margin-top: $navbar-height diff --git a/css/_helper.sass b/css/_helper.sass deleted file mode 100644 index f21c559d..00000000 --- a/css/_helper.sass +++ /dev/null @@ -1,317 +0,0 @@ -//spacer -@mixin spacer - width: 100% - font-size: 0 - margin: 0 - padding: 0 - border: 0 - display: block - -.spacer5 - +spacer - height: 5px -.spacer10 - +spacer - height: 10px -.spacer15 - +spacer - height: 15px -.spacer20 - +spacer - height: 20px -.spacer25 - +spacer - height: 25px -.spacer30 - +spacer - height: 30px -.spacer35 - +spacer - height: 35px -.spacer40 - +spacer - height: 40px -.spacer45 - +spacer - height: 45px -.spacer50 - +spacer - height: 50px -.spacer60 - +spacer - height: 60px -.spacer80 - +spacer - height: 80px -.spacer100 - +spacer - height: 100px -.spacer200 - +spacer - height: 200px - -//width -.w100 - width: 100px -.w150 - width: 150px -.w200 - width: 200px -.m100 - max-width: 100px -.m200 - max-width: 200px -.m300 - max-width: 300px -.m400 - max-width: 400px -.m500 - max-width: 500px -.m600 - max-width: 600px -.m700 - max-width: 700px -.m800 - max-width: 800px -.m900 - max-width: 900px -.m1000 - max-width: 1000px -.m1200 - max-width: 1200px -.m100p - max-width: 100% - -//height -.h100 - height: 100px -.h200 - height: 200px -.h300 - height: 300px -.h500 - height: 500px -.hfull - height: 100% - -// positions -.pos-rel - position: relative -.pos-stc - position: static -.pos-abt - position: absolute - - -//font size -.text-xxl - font-size: 50px -.text-xl - font-size: 32px -.text-lg - font-size: 20px -.text-sm - font-size: 12px -.text-xs - font-size: 10px - -// pull -.pull-in - margin-left: -15px - margin-right: -15px -.pull-out - margin: -15px - -//borders -.b-t - border-top: 1px solid $secondary-color -.b-r - border-right: 1px solid $secondary-color -.b-b - border-bottom: 1px solid $secondary-color -.b-l - border-left: 1px solid $secondary-color - -//padding -.padder - padding: 0 15px -.p-small - padding: 10px -.p-large - padding: 20px -.p-xlarge - padding: 30px -.p-l-large - padding-left: 20px -.p-l-xlarge - padding-left: 30px -.p-r-large - padding-right: 20px -.p-r-xlarge - padding-right: 30px -.p-l-xxlarge - padding-left: 60px -.p-r-xxlarge - padding-right: 60px - -//margin -.m-l-r-auto - margin-left: auto - margin-right: auto -.m-l - margin-left: 15px -.m-l-none - margin-left: 0 -.m-l-mini - margin-left: 5px -.m-l-small - margin-left: 10px -.m-l-large - margin-left: 20px -.m-l-n - margin-left: -15px -.m-l-n-mini - margin-left: -5px -.m-l-n-small - margin-left: -10px -.m-l-n-large - margin-left: -20px -.m-t - margin-top: 15px -.m-t-none - margin-top: 0 -.m-t-mini - margin-top: 5px -.m-t-small - margin-top: 10px -.m-t-large - margin-top: 20px -.m-t-n - margin-top: -15px -.m-t-n-xmini - margin-top: -1px -.m-t-n-mini - margin-top: -5px -.m-t-n-small - margin-top: -10px -.m-t-n-large - margin-top: -20px -.m-r - margin-right: 15px -.m-r-none - margin-right: 0 -.m-r-mini - margin-right: 5px -.m-r-small - margin-right: 10px -.m-r-large - margin-right: 20px -.m-r-n - margin-right: -15px -.m-r-n-mini - margin-right: -5px -.m-r-n-small - margin-right: -10px -.m-r-n-large - margin-right: -20px -.m-b - margin-bottom: 15px -.m-b-none - margin-bottom: 0 -.m-b-mini - margin-bottom: 5px -.m-b-small - margin-bottom: 10px -.m-b-large - margin-bottom: 20px -.m-b-n - margin-bottom: -15px -.m-b-n-mini - margin-bottom: -5px -.m-b-n-small - margin-bottom: -10px -.m-b-n-large - margin-bottom: -20px - -// text -.text-justify - text-align: justify -.vertical-align-middle - display: inline-block !important - vertical-align: middle !important -.text-ellipsis - white-space: nowrap - overflow: hidden - max-width: 100% - text-overflow: ellipsis -.text-break-word - word-wrap: break-word -.nowrap - word-wrap: nowrap - white-space: nowrap - -//line -.line - width: 100% - height: 1px - margin: 10px 0 - font-size: 0 - overflow: hidden - border-width: 0 - background-color: $secondary-color -.line-dashed - border-style: dashed - background: transparent - -.no-line - border-width: 0 -.no-border - border-color: transparent !important -.no-radius - border-radius: 0 -.block - display: block -.inline - display: inline-block -.pull-none - float: none - -.line-v - border-left: 1px solid #dddddd - padding-left: 20px -.line-v-right - border-right: 1px solid #dddddd - padding-right: 20px - - -// others -.clickable - cursor: pointer - -.content-box - @include box-sizing(content-box) - -.faded - opacity: .3 - -// CSS for and -sub, sup - font-size: 50% - line-height: 0 - position: relative - vertical-align: baseline - -sup - top: -0.7em - -sub - bottom: -0.25em - -[ng\:cloak], [ng-cloak], .ng-cloak - display: none !important - -.text-white - color: #FFFFFF - -.bg-white - background-color: white diff --git a/css/_home.sass b/css/_home.sass deleted file mode 100644 index 48c57cb6..00000000 --- a/css/_home.sass +++ /dev/null @@ -1,10 +0,0 @@ -html, body - position: relative - +size(100%,100%) - background-attachment: fixed - -h2 - font-size: 1.8em - font-weight: normal - letter-spacing: 1px - margin-bottom: 1em diff --git a/css/_mixin.sass b/css/_mixin.sass deleted file mode 100644 index 6ab45a18..00000000 --- a/css/_mixin.sass +++ /dev/null @@ -1,17 +0,0 @@ -@mixin position($top: null, $right: null, $bottom: null, $left: null) - top: $top - right: $right - bottom: $bottom - left: $left - -@mixin keyframes($animation-name) - @-webkit-keyframes #{$animation-name} - @content - @-moz-keyframes #{$animation-name} - @content - @-ms-keyframes #{$animation-name} - @content - @-o-keyframes #{$animation-name} - @content - @keyframes #{$animation-name} - @content diff --git a/css/_page.sass b/css/_page.sass deleted file mode 100644 index 7c9837ae..00000000 --- a/css/_page.sass +++ /dev/null @@ -1,3 +0,0 @@ -.page-content - font-size: 1.1em - line-height: 1.5em diff --git a/css/main.sass b/css/main.sass deleted file mode 100644 index 57129a31..00000000 --- a/css/main.sass +++ /dev/null @@ -1,15 +0,0 @@ ---- -# this ensures Jekyll reads the file to be transformed into CSS later -# only Main files contain this front matter, not partials. ---- - -@import "base" -@import "bootstrap" -@import "mixin" -@import "syntax-highlighting" -@import "helper" - -@import "header" -@import "home" -@import "page" -@import "footer" diff --git a/Gemfile b/docs/Gemfile similarity index 100% rename from Gemfile rename to docs/Gemfile diff --git a/Gemfile.lock b/docs/Gemfile.lock similarity index 100% rename from Gemfile.lock rename to docs/Gemfile.lock diff --git a/Guardfile b/docs/Guardfile similarity index 100% rename from Guardfile rename to docs/Guardfile diff --git a/_config.yml b/docs/_config.yml similarity index 100% rename from _config.yml rename to docs/_config.yml diff --git a/_includes/footer.html b/docs/_includes/footer.html similarity index 100% rename from _includes/footer.html rename to docs/_includes/footer.html diff --git a/_includes/header.html b/docs/_includes/header.html similarity index 100% rename from _includes/header.html rename to docs/_includes/header.html diff --git a/_includes/marketing.html b/docs/_includes/marketing.html similarity index 100% rename from _includes/marketing.html rename to docs/_includes/marketing.html diff --git a/_includes/newsletter-mc.html b/docs/_includes/newsletter-mc.html similarity index 100% rename from _includes/newsletter-mc.html rename to docs/_includes/newsletter-mc.html diff --git a/_layouts/default.html b/docs/_layouts/default.html similarity index 100% rename from _layouts/default.html rename to docs/_layouts/default.html diff --git a/_layouts/page.html b/docs/_layouts/page.html similarity index 100% rename from _layouts/page.html rename to docs/_layouts/page.html diff --git a/_plugins/environment_variables.rb b/docs/_plugins/environment_variables.rb similarity index 100% rename from _plugins/environment_variables.rb rename to docs/_plugins/environment_variables.rb diff --git a/_plugins/ext.rb b/docs/_plugins/ext.rb similarity index 100% rename from _plugins/ext.rb rename to docs/_plugins/ext.rb diff --git a/_plugins/haml.rb b/docs/_plugins/haml.rb similarity index 100% rename from _plugins/haml.rb rename to docs/_plugins/haml.rb diff --git a/_plugins/svg.rb b/docs/_plugins/svg.rb similarity index 100% rename from _plugins/svg.rb rename to docs/_plugins/svg.rb diff --git a/about.md b/docs/about.md similarity index 100% rename from about.md rename to docs/about.md diff --git a/docs/css/_base.css b/docs/css/_base.css new file mode 100644 index 00000000..5a2975d6 --- /dev/null +++ b/docs/css/_base.css @@ -0,0 +1,48 @@ +/* +Error: Invalid CSS after "...ial, sans-serif": expected expression (e.g. 1px, bold), was ";" + on line 1 of _base.sass + +1: $font-family-sans-serif: "Open Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; +2: $font-size-base: 14px; +3: +4: $headings-font-family: "Raleway"; +5: $headings-font-weight: 300; +6: + +Backtrace: +_base.sass:1 +/home/tim/.rvm/gems/ruby-2.2.3/gems/sass-3.4.19/lib/sass/scss/parser.rb:1161:in `expected' +/home/tim/.rvm/gems/ruby-2.2.3/gems/sass-3.4.19/lib/sass/script/lexer.rb:221:in `expected!' +/home/tim/.rvm/gems/ruby-2.2.3/gems/sass-3.4.19/lib/sass/script/parser.rb:600:in `assert_done' +/home/tim/.rvm/gems/ruby-2.2.3/gems/sass-3.4.19/lib/sass/script/parser.rb:63:in `parse' +/home/tim/.rvm/gems/ruby-2.2.3/gems/sass-3.4.19/lib/sass/script/parser.rb:183:in `parse' +/home/tim/.rvm/gems/ruby-2.2.3/gems/sass-3.4.19/lib/sass/script.rb:27:in `parse' +/home/tim/.rvm/gems/ruby-2.2.3/gems/sass-3.4.19/lib/sass/engine.rb:1130:in `parse_script' +/home/tim/.rvm/gems/ruby-2.2.3/gems/sass-3.4.19/lib/sass/engine.rb:753:in `parse_variable' +/home/tim/.rvm/gems/ruby-2.2.3/gems/sass-3.4.19/lib/sass/engine.rb:641:in `parse_line' +/home/tim/.rvm/gems/ruby-2.2.3/gems/sass-3.4.19/lib/sass/engine.rb:535:in `build_tree' +/home/tim/.rvm/gems/ruby-2.2.3/gems/sass-3.4.19/lib/sass/engine.rb:554:in `block in append_children' +/home/tim/.rvm/gems/ruby-2.2.3/gems/sass-3.4.19/lib/sass/engine.rb:553:in `each' +/home/tim/.rvm/gems/ruby-2.2.3/gems/sass-3.4.19/lib/sass/engine.rb:553:in `append_children' +/home/tim/.rvm/gems/ruby-2.2.3/gems/sass-3.4.19/lib/sass/engine.rb:406:in `_to_tree' +/home/tim/.rvm/gems/ruby-2.2.3/gems/sass-3.4.19/lib/sass/engine.rb:378:in `_render_with_sourcemap' +/home/tim/.rvm/gems/ruby-2.2.3/gems/sass-3.4.19/lib/sass/engine.rb:295:in `render_with_sourcemap' +/home/tim/.rvm/gems/ruby-2.2.3/gems/sass-3.4.19/lib/sass/plugin/compiler.rb:490:in `update_stylesheet' +/home/tim/.rvm/gems/ruby-2.2.3/gems/sass-3.4.19/lib/sass/plugin/compiler.rb:215:in `block in update_stylesheets' +/home/tim/.rvm/gems/ruby-2.2.3/gems/sass-3.4.19/lib/sass/plugin/compiler.rb:209:in `each' +/home/tim/.rvm/gems/ruby-2.2.3/gems/sass-3.4.19/lib/sass/plugin/compiler.rb:209:in `update_stylesheets' +/home/tim/.rvm/gems/ruby-2.2.3/gems/sass-3.4.19/lib/sass/plugin.rb:82:in `update_stylesheets' +/home/tim/.rvm/gems/ruby-2.2.3/gems/sass-3.4.19/lib/sass/exec/sass_scss.rb:361:in `watch_or_update' +/home/tim/.rvm/gems/ruby-2.2.3/gems/sass-3.4.19/lib/sass/exec/sass_scss.rb:51:in `process_result' +/home/tim/.rvm/gems/ruby-2.2.3/gems/sass-3.4.19/lib/sass/exec/base.rb:52:in `parse' +/home/tim/.rvm/gems/ruby-2.2.3/gems/sass-3.4.19/lib/sass/exec/base.rb:19:in `parse!' +/home/tim/.rvm/gems/ruby-2.2.3/gems/sass-3.4.19/bin/sass:13:in `' +/home/tim/.rvm/gems/ruby-2.2.3/bin/sass:23:in `load' +/home/tim/.rvm/gems/ruby-2.2.3/bin/sass:23:in `
' +/home/tim/.rvm/gems/ruby-2.2.3/bin/ruby_executable_hooks:15:in `eval' +/home/tim/.rvm/gems/ruby-2.2.3/bin/ruby_executable_hooks:15:in `
' +*/ +body:before { + white-space: pre; + font-family: monospace; + content: "Error: Invalid CSS after \"...ial, sans-serif\": expected expression (e.g. 1px, bold), was \";\"\A on line 1 of _base.sass\A \A 1: $font-family-sans-serif: \"Open Sans\", \"Helvetica Neue\", Helvetica, Arial, sans-serif;\A 2: $font-size-base: 14px;\A 3: \A 4: $headings-font-family: \"Raleway\";\A 5: $headings-font-weight: 300;\A 6: "; } diff --git a/docs/css/_base.scss b/docs/css/_base.scss new file mode 100644 index 00000000..6c637de0 --- /dev/null +++ b/docs/css/_base.scss @@ -0,0 +1,23 @@ +$font-family-sans-serif: "Open Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; +$font-size-base: 14px; + +$headings-font-family: "Raleway"; +$headings-font-weight: 300; + +$brand-primary: #1d96c7; +$code-color: #a3b6cb; + +$text-color: rgba(black, 0.75); + +$anchor-offset: 100px; +$community-color: #674492; +$success-color: #58d158; +$gray-light: #f3f3f3; +$dark-blue: #0d1d30; +$light-blue: lighten($dark-blue, 70%); + +$secondary-color: green; + +$navbar-height: 50px; + + diff --git a/css/_bootstrap.scss b/docs/css/_bootstrap.scss similarity index 100% rename from css/_bootstrap.scss rename to docs/css/_bootstrap.scss diff --git a/docs/css/_footer.scss b/docs/css/_footer.scss new file mode 100644 index 00000000..374005c8 --- /dev/null +++ b/docs/css/_footer.scss @@ -0,0 +1,15 @@ +footer.site-footer { + padding-top: 2em; + margin-top: 0; + border-top: 1px solid $gray-lighter; + background-color: white; + text-align: center; + .fa.fa-heart { + color: #e61870; + } + .input-group-addon { + background-color: transparent; + } +} + + diff --git a/docs/css/_header.scss b/docs/css/_header.scss new file mode 100644 index 00000000..ff5d2f12 --- /dev/null +++ b/docs/css/_header.scss @@ -0,0 +1,47 @@ +header.site-header { + position: fixed; + + top: 0; + width: 100%; + z-index: 99; + background: linear-gradient(to right, rgba(#0a1724, .8) -50%, rgba(#172c4f, .5) 100%); + transition: background 2s ease; + nav.navbar { + margin-bottom: 0; + background-color: #0B1724; + border-radius: 0; + border: none; + .navbar-collapse.in { + background-color: #0B1724 !important; + animation: fadeInUp .2s ease-in-out; + position: fixed; + @include position(0,0,0,0); + padding: 20%; + font-size: 1.2em; + li { + padding-bottom: 1em; } } + .navbar-brand { + font-weight: 600; + color: white; + z-index: 1; } + .navbar-header { + position: relative; + z-index: 2; } + .navbar-toggle { + background-color: $brand-primary; + border: solid 1px $brand-primary; + color: white; + &.collapsed { + background-color: transparent; + border: solid 1px rgba(white,.4); + color: white; } } + .navbar-nav { + > li > a { + padding-bottom: 0; } + > .active > a { + color: #1D96C7 !important; + background-color: transparent; } } } } + +.main-content { + margin-top: $navbar-height; } + diff --git a/docs/css/_helper.scss b/docs/css/_helper.scss new file mode 100644 index 00000000..d779ac36 --- /dev/null +++ b/docs/css/_helper.scss @@ -0,0 +1,318 @@ +//spacer +@mixin spacer { + width: 100%; + font-size: 0; + margin: 0; + padding: 0; + border: 0; + display: block; } + +.spacer5 { + @include spacer; + height: 5px; } +.spacer10 { + @include spacer; + height: 10px; } +.spacer15 { + @include spacer; + height: 15px; } +.spacer20 { + @include spacer; + height: 20px; } +.spacer25 { + @include spacer; + height: 25px; } +.spacer30 { + @include spacer; + height: 30px; } +.spacer35 { + @include spacer; + height: 35px; } +.spacer40 { + @include spacer; + height: 40px; } +.spacer45 { + @include spacer; + height: 45px; } +.spacer50 { + @include spacer; + height: 50px; } +.spacer60 { + @include spacer; + height: 60px; } +.spacer80 { + @include spacer; + height: 80px; } +.spacer100 { + @include spacer; + height: 100px; } +.spacer200 { + @include spacer; + height: 200px; } + +//width +.w100 { + width: 100px; } +.w150 { + width: 150px; } +.w200 { + width: 200px; } +.m100 { + max-width: 100px; } +.m200 { + max-width: 200px; } +.m300 { + max-width: 300px; } +.m400 { + max-width: 400px; } +.m500 { + max-width: 500px; } +.m600 { + max-width: 600px; } +.m700 { + max-width: 700px; } +.m800 { + max-width: 800px; } +.m900 { + max-width: 900px; } +.m1000 { + max-width: 1000px; } +.m1200 { + max-width: 1200px; } +.m100p { + max-width: 100%; } + +//height +.h100 { + height: 100px; } +.h200 { + height: 200px; } +.h300 { + height: 300px; } +.h500 { + height: 500px; } +.hfull { + height: 100%; } + +// positions +.pos-rel { + position: relative; } +.pos-stc { + position: static; } +.pos-abt { + position: absolute; } + + +//font size +.text-xxl { + font-size: 50px; } +.text-xl { + font-size: 32px; } +.text-lg { + font-size: 20px; } +.text-sm { + font-size: 12px; } +.text-xs { + font-size: 10px; } + +// pull +.pull-in { + margin-left: -15px; + margin-right: -15px; } +.pull-out { + margin: -15px; } + +//borders +.b-t { + border-top: 1px solid $secondary-color; } +.b-r { + border-right: 1px solid $secondary-color; } +.b-b { + border-bottom: 1px solid $secondary-color; } +.b-l { + border-left: 1px solid $secondary-color; } + +//padding +.padder { + padding: 0 15px; } +.p-small { + padding: 10px; } +.p-large { + padding: 20px; } +.p-xlarge { + padding: 30px; } +.p-l-large { + padding-left: 20px; } +.p-l-xlarge { + padding-left: 30px; } +.p-r-large { + padding-right: 20px; } +.p-r-xlarge { + padding-right: 30px; } +.p-l-xxlarge { + padding-left: 60px; } +.p-r-xxlarge { + padding-right: 60px; } + +//margin +.m-l-r-auto { + margin-left: auto; + margin-right: auto; } +.m-l { + margin-left: 15px; } +.m-l-none { + margin-left: 0; } +.m-l-mini { + margin-left: 5px; } +.m-l-small { + margin-left: 10px; } +.m-l-large { + margin-left: 20px; } +.m-l-n { + margin-left: -15px; } +.m-l-n-mini { + margin-left: -5px; } +.m-l-n-small { + margin-left: -10px; } +.m-l-n-large { + margin-left: -20px; } +.m-t { + margin-top: 15px; } +.m-t-none { + margin-top: 0; } +.m-t-mini { + margin-top: 5px; } +.m-t-small { + margin-top: 10px; } +.m-t-large { + margin-top: 20px; } +.m-t-n { + margin-top: -15px; } +.m-t-n-xmini { + margin-top: -1px; } +.m-t-n-mini { + margin-top: -5px; } +.m-t-n-small { + margin-top: -10px; } +.m-t-n-large { + margin-top: -20px; } +.m-r { + margin-right: 15px; } +.m-r-none { + margin-right: 0; } +.m-r-mini { + margin-right: 5px; } +.m-r-small { + margin-right: 10px; } +.m-r-large { + margin-right: 20px; } +.m-r-n { + margin-right: -15px; } +.m-r-n-mini { + margin-right: -5px; } +.m-r-n-small { + margin-right: -10px; } +.m-r-n-large { + margin-right: -20px; } +.m-b { + margin-bottom: 15px; } +.m-b-none { + margin-bottom: 0; } +.m-b-mini { + margin-bottom: 5px; } +.m-b-small { + margin-bottom: 10px; } +.m-b-large { + margin-bottom: 20px; } +.m-b-n { + margin-bottom: -15px; } +.m-b-n-mini { + margin-bottom: -5px; } +.m-b-n-small { + margin-bottom: -10px; } +.m-b-n-large { + margin-bottom: -20px; } + +// text +.text-justify { + text-align: justify; } +.vertical-align-middle { + display: inline-block !important; + vertical-align: middle !important; } +.text-ellipsis { + white-space: nowrap; + overflow: hidden; + max-width: 100%; + text-overflow: ellipsis; } +.text-break-word { + word-wrap: break-word; } +.nowrap { + word-wrap: nowrap; + white-space: nowrap; } + +//line +.line { + width: 100%; + height: 1px; + margin: 10px 0; + font-size: 0; + overflow: hidden; + border-width: 0; + background-color: $secondary-color; } +.line-dashed { + border-style: dashed; + background: transparent; } + +.no-line { + border-width: 0; } +.no-border { + border-color: transparent !important; } +.no-radius { + border-radius: 0; } +.block { + display: block; } +.inline { + display: inline-block; } +.pull-none { + float: none; } + +.line-v { + border-left: 1px solid #dddddd; + padding-left: 20px; } +.line-v-right { + border-right: 1px solid #dddddd; + padding-right: 20px; } + + +// others +.clickable { + cursor: pointer; } + +.content-box { + @include box-sizing(content-box); } + +.faded { + opacity: .3; } + +// CSS for and +sub, sup { + font-size: 50%; + line-height: 0; + position: relative; + vertical-align: baseline; } + +sup { + top: -0.7em; } + +sub { + bottom: -0.25em; } + +[ng\:cloak], [ng-cloak], .ng-cloak { + display: none !important; } + +.text-white { + color: #FFFFFF; } + +.bg-white { + background-color: white; } + diff --git a/docs/css/_home.scss b/docs/css/_home.scss new file mode 100644 index 00000000..92fc4a8e --- /dev/null +++ b/docs/css/_home.scss @@ -0,0 +1,15 @@ +html, body { + position: relative; + @include size(100%,100%); + background-attachment: fixed; } + +h2 { + font-size: 1.8em; + font-weight: normal; + letter-spacing: 1px; + margin-bottom: 1em; } + +.showcase--image { + max-width: 200px; +} + diff --git a/docs/css/_mixin.scss b/docs/css/_mixin.scss new file mode 100644 index 00000000..8b79f4e4 --- /dev/null +++ b/docs/css/_mixin.scss @@ -0,0 +1,18 @@ +@mixin position($top: null, $right: null, $bottom: null, $left: null) { + top: $top; + right: $right; + bottom: $bottom; + left: $left; } + +@mixin keyframes($animation-name) { + @-webkit-keyframes #{$animation-name} { + @content; } + @-moz-keyframes #{$animation-name} { + @content; } + @-ms-keyframes #{$animation-name} { + @content; } + @-o-keyframes #{$animation-name} { + @content; } + @keyframes #{$animation-name} { + @content; } } + diff --git a/docs/css/_page.scss b/docs/css/_page.scss new file mode 100644 index 00000000..a8be2de0 --- /dev/null +++ b/docs/css/_page.scss @@ -0,0 +1,4 @@ +.page-content { + font-size: 1.1em; + line-height: 1.5em; } + diff --git a/css/_syntax-highlighting.scss b/docs/css/_syntax-highlighting.scss similarity index 100% rename from css/_syntax-highlighting.scss rename to docs/css/_syntax-highlighting.scss diff --git a/css/bootstrap/_alerts.scss b/docs/css/bootstrap/_alerts.scss similarity index 100% rename from css/bootstrap/_alerts.scss rename to docs/css/bootstrap/_alerts.scss diff --git a/css/bootstrap/_badges.scss b/docs/css/bootstrap/_badges.scss similarity index 100% rename from css/bootstrap/_badges.scss rename to docs/css/bootstrap/_badges.scss diff --git a/css/bootstrap/_breadcrumbs.scss b/docs/css/bootstrap/_breadcrumbs.scss similarity index 100% rename from css/bootstrap/_breadcrumbs.scss rename to docs/css/bootstrap/_breadcrumbs.scss diff --git a/css/bootstrap/_button-groups.scss b/docs/css/bootstrap/_button-groups.scss similarity index 100% rename from css/bootstrap/_button-groups.scss rename to docs/css/bootstrap/_button-groups.scss diff --git a/css/bootstrap/_buttons.scss b/docs/css/bootstrap/_buttons.scss similarity index 100% rename from css/bootstrap/_buttons.scss rename to docs/css/bootstrap/_buttons.scss diff --git a/css/bootstrap/_carousel.scss b/docs/css/bootstrap/_carousel.scss similarity index 100% rename from css/bootstrap/_carousel.scss rename to docs/css/bootstrap/_carousel.scss diff --git a/css/bootstrap/_close.scss b/docs/css/bootstrap/_close.scss similarity index 100% rename from css/bootstrap/_close.scss rename to docs/css/bootstrap/_close.scss diff --git a/css/bootstrap/_code.scss b/docs/css/bootstrap/_code.scss similarity index 100% rename from css/bootstrap/_code.scss rename to docs/css/bootstrap/_code.scss diff --git a/css/bootstrap/_component-animations.scss b/docs/css/bootstrap/_component-animations.scss similarity index 100% rename from css/bootstrap/_component-animations.scss rename to docs/css/bootstrap/_component-animations.scss diff --git a/css/bootstrap/_dropdowns.scss b/docs/css/bootstrap/_dropdowns.scss similarity index 100% rename from css/bootstrap/_dropdowns.scss rename to docs/css/bootstrap/_dropdowns.scss diff --git a/css/bootstrap/_forms.scss b/docs/css/bootstrap/_forms.scss similarity index 100% rename from css/bootstrap/_forms.scss rename to docs/css/bootstrap/_forms.scss diff --git a/css/bootstrap/_glyphicons.scss b/docs/css/bootstrap/_glyphicons.scss similarity index 100% rename from css/bootstrap/_glyphicons.scss rename to docs/css/bootstrap/_glyphicons.scss diff --git a/css/bootstrap/_grid.scss b/docs/css/bootstrap/_grid.scss similarity index 100% rename from css/bootstrap/_grid.scss rename to docs/css/bootstrap/_grid.scss diff --git a/css/bootstrap/_input-groups.scss b/docs/css/bootstrap/_input-groups.scss similarity index 100% rename from css/bootstrap/_input-groups.scss rename to docs/css/bootstrap/_input-groups.scss diff --git a/css/bootstrap/_jumbotron.scss b/docs/css/bootstrap/_jumbotron.scss similarity index 100% rename from css/bootstrap/_jumbotron.scss rename to docs/css/bootstrap/_jumbotron.scss diff --git a/css/bootstrap/_labels.scss b/docs/css/bootstrap/_labels.scss similarity index 100% rename from css/bootstrap/_labels.scss rename to docs/css/bootstrap/_labels.scss diff --git a/css/bootstrap/_list-group.scss b/docs/css/bootstrap/_list-group.scss similarity index 100% rename from css/bootstrap/_list-group.scss rename to docs/css/bootstrap/_list-group.scss diff --git a/css/bootstrap/_media.scss b/docs/css/bootstrap/_media.scss similarity index 100% rename from css/bootstrap/_media.scss rename to docs/css/bootstrap/_media.scss diff --git a/css/bootstrap/_mixins.scss b/docs/css/bootstrap/_mixins.scss similarity index 100% rename from css/bootstrap/_mixins.scss rename to docs/css/bootstrap/_mixins.scss diff --git a/css/bootstrap/_modals.scss b/docs/css/bootstrap/_modals.scss similarity index 100% rename from css/bootstrap/_modals.scss rename to docs/css/bootstrap/_modals.scss diff --git a/css/bootstrap/_navbar.scss b/docs/css/bootstrap/_navbar.scss similarity index 100% rename from css/bootstrap/_navbar.scss rename to docs/css/bootstrap/_navbar.scss diff --git a/css/bootstrap/_navs.scss b/docs/css/bootstrap/_navs.scss similarity index 100% rename from css/bootstrap/_navs.scss rename to docs/css/bootstrap/_navs.scss diff --git a/css/bootstrap/_normalize.scss b/docs/css/bootstrap/_normalize.scss similarity index 100% rename from css/bootstrap/_normalize.scss rename to docs/css/bootstrap/_normalize.scss diff --git a/css/bootstrap/_pager.scss b/docs/css/bootstrap/_pager.scss similarity index 100% rename from css/bootstrap/_pager.scss rename to docs/css/bootstrap/_pager.scss diff --git a/css/bootstrap/_pagination.scss b/docs/css/bootstrap/_pagination.scss similarity index 100% rename from css/bootstrap/_pagination.scss rename to docs/css/bootstrap/_pagination.scss diff --git a/css/bootstrap/_panels.scss b/docs/css/bootstrap/_panels.scss similarity index 100% rename from css/bootstrap/_panels.scss rename to docs/css/bootstrap/_panels.scss diff --git a/css/bootstrap/_popovers.scss b/docs/css/bootstrap/_popovers.scss similarity index 100% rename from css/bootstrap/_popovers.scss rename to docs/css/bootstrap/_popovers.scss diff --git a/css/bootstrap/_print.scss b/docs/css/bootstrap/_print.scss similarity index 100% rename from css/bootstrap/_print.scss rename to docs/css/bootstrap/_print.scss diff --git a/css/bootstrap/_progress-bars.scss b/docs/css/bootstrap/_progress-bars.scss similarity index 100% rename from css/bootstrap/_progress-bars.scss rename to docs/css/bootstrap/_progress-bars.scss diff --git a/css/bootstrap/_responsive-embed.scss b/docs/css/bootstrap/_responsive-embed.scss similarity index 100% rename from css/bootstrap/_responsive-embed.scss rename to docs/css/bootstrap/_responsive-embed.scss diff --git a/css/bootstrap/_responsive-utilities.scss b/docs/css/bootstrap/_responsive-utilities.scss similarity index 100% rename from css/bootstrap/_responsive-utilities.scss rename to docs/css/bootstrap/_responsive-utilities.scss diff --git a/css/bootstrap/_scaffolding.scss b/docs/css/bootstrap/_scaffolding.scss similarity index 100% rename from css/bootstrap/_scaffolding.scss rename to docs/css/bootstrap/_scaffolding.scss diff --git a/css/bootstrap/_tables.scss b/docs/css/bootstrap/_tables.scss similarity index 100% rename from css/bootstrap/_tables.scss rename to docs/css/bootstrap/_tables.scss diff --git a/css/bootstrap/_theme.scss b/docs/css/bootstrap/_theme.scss similarity index 100% rename from css/bootstrap/_theme.scss rename to docs/css/bootstrap/_theme.scss diff --git a/css/bootstrap/_thumbnails.scss b/docs/css/bootstrap/_thumbnails.scss similarity index 100% rename from css/bootstrap/_thumbnails.scss rename to docs/css/bootstrap/_thumbnails.scss diff --git a/css/bootstrap/_tooltip.scss b/docs/css/bootstrap/_tooltip.scss similarity index 100% rename from css/bootstrap/_tooltip.scss rename to docs/css/bootstrap/_tooltip.scss diff --git a/css/bootstrap/_type.scss b/docs/css/bootstrap/_type.scss similarity index 100% rename from css/bootstrap/_type.scss rename to docs/css/bootstrap/_type.scss diff --git a/css/bootstrap/_utilities.scss b/docs/css/bootstrap/_utilities.scss similarity index 100% rename from css/bootstrap/_utilities.scss rename to docs/css/bootstrap/_utilities.scss diff --git a/css/bootstrap/_variables.scss b/docs/css/bootstrap/_variables.scss similarity index 100% rename from css/bootstrap/_variables.scss rename to docs/css/bootstrap/_variables.scss diff --git a/css/bootstrap/_wells.scss b/docs/css/bootstrap/_wells.scss similarity index 100% rename from css/bootstrap/_wells.scss rename to docs/css/bootstrap/_wells.scss diff --git a/css/bootstrap/mixins/_alerts.scss b/docs/css/bootstrap/mixins/_alerts.scss similarity index 100% rename from css/bootstrap/mixins/_alerts.scss rename to docs/css/bootstrap/mixins/_alerts.scss diff --git a/css/bootstrap/mixins/_background-variant.scss b/docs/css/bootstrap/mixins/_background-variant.scss similarity index 100% rename from css/bootstrap/mixins/_background-variant.scss rename to docs/css/bootstrap/mixins/_background-variant.scss diff --git a/css/bootstrap/mixins/_border-radius.scss b/docs/css/bootstrap/mixins/_border-radius.scss similarity index 100% rename from css/bootstrap/mixins/_border-radius.scss rename to docs/css/bootstrap/mixins/_border-radius.scss diff --git a/css/bootstrap/mixins/_buttons.scss b/docs/css/bootstrap/mixins/_buttons.scss similarity index 100% rename from css/bootstrap/mixins/_buttons.scss rename to docs/css/bootstrap/mixins/_buttons.scss diff --git a/css/bootstrap/mixins/_center-block.scss b/docs/css/bootstrap/mixins/_center-block.scss similarity index 100% rename from css/bootstrap/mixins/_center-block.scss rename to docs/css/bootstrap/mixins/_center-block.scss diff --git a/css/bootstrap/mixins/_clearfix.scss b/docs/css/bootstrap/mixins/_clearfix.scss similarity index 100% rename from css/bootstrap/mixins/_clearfix.scss rename to docs/css/bootstrap/mixins/_clearfix.scss diff --git a/css/bootstrap/mixins/_forms.scss b/docs/css/bootstrap/mixins/_forms.scss similarity index 100% rename from css/bootstrap/mixins/_forms.scss rename to docs/css/bootstrap/mixins/_forms.scss diff --git a/css/bootstrap/mixins/_gradients.scss b/docs/css/bootstrap/mixins/_gradients.scss similarity index 100% rename from css/bootstrap/mixins/_gradients.scss rename to docs/css/bootstrap/mixins/_gradients.scss diff --git a/css/bootstrap/mixins/_grid-framework.scss b/docs/css/bootstrap/mixins/_grid-framework.scss similarity index 100% rename from css/bootstrap/mixins/_grid-framework.scss rename to docs/css/bootstrap/mixins/_grid-framework.scss diff --git a/css/bootstrap/mixins/_grid.scss b/docs/css/bootstrap/mixins/_grid.scss similarity index 100% rename from css/bootstrap/mixins/_grid.scss rename to docs/css/bootstrap/mixins/_grid.scss diff --git a/css/bootstrap/mixins/_hide-text.scss b/docs/css/bootstrap/mixins/_hide-text.scss similarity index 100% rename from css/bootstrap/mixins/_hide-text.scss rename to docs/css/bootstrap/mixins/_hide-text.scss diff --git a/css/bootstrap/mixins/_image.scss b/docs/css/bootstrap/mixins/_image.scss similarity index 100% rename from css/bootstrap/mixins/_image.scss rename to docs/css/bootstrap/mixins/_image.scss diff --git a/css/bootstrap/mixins/_labels.scss b/docs/css/bootstrap/mixins/_labels.scss similarity index 100% rename from css/bootstrap/mixins/_labels.scss rename to docs/css/bootstrap/mixins/_labels.scss diff --git a/css/bootstrap/mixins/_list-group.scss b/docs/css/bootstrap/mixins/_list-group.scss similarity index 100% rename from css/bootstrap/mixins/_list-group.scss rename to docs/css/bootstrap/mixins/_list-group.scss diff --git a/css/bootstrap/mixins/_nav-divider.scss b/docs/css/bootstrap/mixins/_nav-divider.scss similarity index 100% rename from css/bootstrap/mixins/_nav-divider.scss rename to docs/css/bootstrap/mixins/_nav-divider.scss diff --git a/css/bootstrap/mixins/_nav-vertical-align.scss b/docs/css/bootstrap/mixins/_nav-vertical-align.scss similarity index 100% rename from css/bootstrap/mixins/_nav-vertical-align.scss rename to docs/css/bootstrap/mixins/_nav-vertical-align.scss diff --git a/css/bootstrap/mixins/_opacity.scss b/docs/css/bootstrap/mixins/_opacity.scss similarity index 100% rename from css/bootstrap/mixins/_opacity.scss rename to docs/css/bootstrap/mixins/_opacity.scss diff --git a/css/bootstrap/mixins/_pagination.scss b/docs/css/bootstrap/mixins/_pagination.scss similarity index 100% rename from css/bootstrap/mixins/_pagination.scss rename to docs/css/bootstrap/mixins/_pagination.scss diff --git a/css/bootstrap/mixins/_panels.scss b/docs/css/bootstrap/mixins/_panels.scss similarity index 100% rename from css/bootstrap/mixins/_panels.scss rename to docs/css/bootstrap/mixins/_panels.scss diff --git a/css/bootstrap/mixins/_progress-bar.scss b/docs/css/bootstrap/mixins/_progress-bar.scss similarity index 100% rename from css/bootstrap/mixins/_progress-bar.scss rename to docs/css/bootstrap/mixins/_progress-bar.scss diff --git a/css/bootstrap/mixins/_reset-filter.scss b/docs/css/bootstrap/mixins/_reset-filter.scss similarity index 100% rename from css/bootstrap/mixins/_reset-filter.scss rename to docs/css/bootstrap/mixins/_reset-filter.scss diff --git a/css/bootstrap/mixins/_reset-text.scss b/docs/css/bootstrap/mixins/_reset-text.scss similarity index 100% rename from css/bootstrap/mixins/_reset-text.scss rename to docs/css/bootstrap/mixins/_reset-text.scss diff --git a/css/bootstrap/mixins/_resize.scss b/docs/css/bootstrap/mixins/_resize.scss similarity index 100% rename from css/bootstrap/mixins/_resize.scss rename to docs/css/bootstrap/mixins/_resize.scss diff --git a/css/bootstrap/mixins/_responsive-visibility.scss b/docs/css/bootstrap/mixins/_responsive-visibility.scss similarity index 100% rename from css/bootstrap/mixins/_responsive-visibility.scss rename to docs/css/bootstrap/mixins/_responsive-visibility.scss diff --git a/css/bootstrap/mixins/_size.scss b/docs/css/bootstrap/mixins/_size.scss similarity index 100% rename from css/bootstrap/mixins/_size.scss rename to docs/css/bootstrap/mixins/_size.scss diff --git a/css/bootstrap/mixins/_tab-focus.scss b/docs/css/bootstrap/mixins/_tab-focus.scss similarity index 100% rename from css/bootstrap/mixins/_tab-focus.scss rename to docs/css/bootstrap/mixins/_tab-focus.scss diff --git a/css/bootstrap/mixins/_table-row.scss b/docs/css/bootstrap/mixins/_table-row.scss similarity index 100% rename from css/bootstrap/mixins/_table-row.scss rename to docs/css/bootstrap/mixins/_table-row.scss diff --git a/css/bootstrap/mixins/_text-emphasis.scss b/docs/css/bootstrap/mixins/_text-emphasis.scss similarity index 100% rename from css/bootstrap/mixins/_text-emphasis.scss rename to docs/css/bootstrap/mixins/_text-emphasis.scss diff --git a/css/bootstrap/mixins/_text-overflow.scss b/docs/css/bootstrap/mixins/_text-overflow.scss similarity index 100% rename from css/bootstrap/mixins/_text-overflow.scss rename to docs/css/bootstrap/mixins/_text-overflow.scss diff --git a/css/bootstrap/mixins/_vendor-prefixes.scss b/docs/css/bootstrap/mixins/_vendor-prefixes.scss similarity index 100% rename from css/bootstrap/mixins/_vendor-prefixes.scss rename to docs/css/bootstrap/mixins/_vendor-prefixes.scss diff --git a/docs/css/main.scss b/docs/css/main.scss new file mode 100644 index 00000000..46e6a11b --- /dev/null +++ b/docs/css/main.scss @@ -0,0 +1,15 @@ +--- +# this ensures Jekyll reads the file to be transformed into CSS later +# only Main files contain this front matter, not partials. +--- + +@import "base"; +@import "bootstrap"; +@import "mixin"; +@import "syntax-highlighting"; +@import "helper"; + +@import "header"; +@import "home"; +@import "page"; +@import "footer"; diff --git a/img/logo-algolia-dark.png b/docs/img/logo-algolia-dark.png similarity index 100% rename from img/logo-algolia-dark.png rename to docs/img/logo-algolia-dark.png diff --git a/docs/img/showcase/babeljs.png b/docs/img/showcase/babeljs.png new file mode 100644 index 00000000..8650bbfe Binary files /dev/null and b/docs/img/showcase/babeljs.png differ diff --git a/docs/img/showcase/bootstrap.png b/docs/img/showcase/bootstrap.png new file mode 100644 index 00000000..1bea0e1e Binary files /dev/null and b/docs/img/showcase/bootstrap.png differ diff --git a/docs/img/showcase/eslint.png b/docs/img/showcase/eslint.png new file mode 100644 index 00000000..24f48402 Binary files /dev/null and b/docs/img/showcase/eslint.png differ diff --git a/docs/img/showcase/reactjs.png b/docs/img/showcase/reactjs.png new file mode 100644 index 00000000..3a24a589 Binary files /dev/null and b/docs/img/showcase/reactjs.png differ diff --git a/index.haml b/docs/index.haml similarity index 53% rename from index.haml rename to docs/index.haml index ba8c1538..210cc357 100644 --- a/index.haml +++ b/docs/index.haml @@ -7,9 +7,26 @@ layout: default .container %h1 Documentation Search - %p Lorem ipsum dolor sit amet, consectetur adipisicing elit. Debitis aut quos delectus natus! Possimus, minus. Voluptas inventore autem adipisci, perspiciatis accusantium eum nulla veritatis dolore commodi illo obcaecati velit reiciendis. + %p Add relevant, fast and reliable search to your documentation website in minutes. + + %p.text-center .container + %h1 Showcase + .row.text-center + .col-sm-3.showcase + %img.img-responsive{src: '/img/showcase/eslint.png'} + %p Eslint + .col-sm-3 + %img.img-responsive{src: '/img/showcase/babeljs.png'} + %p Babel + .col-sm-3 + %img.img-responsive{src: '/img/showcase/bootstrap.png'} + %p Bootstrap + .col-sm-3 + %img.img-responsive{src: '/img/showcase/reactjs.png'} + %p React + %h1 Features .row.text-center .col-sm-4 @@ -22,5 +39,5 @@ layout: default %img{src: 'http://placehold.it/200x200'} %p Lorem ipsum dolor sit amet, consectetur adipisicing elit. In, sit, veritatis tempora ipsum, provident fugiat quas, eum dicta architecto - %h1 Showcase - %p Lorem ipsum dolor sit amet, consectetur adipisicing elit. Cupiditate sed ea aliquam non quod nobis officia laudantium fugiat temporibus animi, voluptas odio quisquam, debitis aspernatur molestiae ratione veniam, soluta reprehenderit. + + %p Here are some examples of what you could build with documentationsearch.js. diff --git a/js/bootstrap.min.js b/docs/js/bootstrap.min.js similarity index 100% rename from js/bootstrap.min.js rename to docs/js/bootstrap.min.js