diff --git a/README.md b/README.md index b319f4f17..8d6b203fd 100644 --- a/README.md +++ b/README.md @@ -19,6 +19,8 @@ We've created the fastest, easiest way to search within documentation. Check out + + ## Introduction We're scratching our own itch here. As developers, we spend a lot of time reading documentation, and it isn’t always easy to find the information we need. @@ -54,6 +56,7 @@ To customize the look & feel of the dropdown menu, you can either: * edit the color [variables](https://github.com/algolia/docsearch/blob/master/src/styles/_variables.scss) and rebuild this project CSS, * or override the colors like we did in [dev/docsearch-styling.css](https://github.com/algolia/docsearch/blob/master/dev/docsearch-styling.css). + ## Development workflow ### Local example diff --git a/docs/.DS_Store b/docs/.DS_Store new file mode 100644 index 000000000..1dd08da9f Binary files /dev/null and b/docs/.DS_Store differ diff --git a/docs/Gemfile b/docs/Gemfile index 0227eb6f5..c684a373b 100644 --- a/docs/Gemfile +++ b/docs/Gemfile @@ -4,7 +4,7 @@ source 'https://rubygems.org' group :development, :test do - gem 'jekyll' + gem 'jekyll', '< 3' gem 'haml' gem 'rouge' gem 'sass' diff --git a/docs/Gemfile.lock b/docs/Gemfile.lock index dce1b547f..ff6ee1d2a 100644 --- a/docs/Gemfile.lock +++ b/docs/Gemfile.lock @@ -1,20 +1,23 @@ GEM remote: https://rubygems.org/ specs: + addressable (2.3.8) blankslate (2.1.2.4) - classifier-reborn (2.0.3) + classifier-reborn (2.0.4) fast-stemmer (~> 1.0) coderay (1.1.0) coffee-script (2.4.1) coffee-script-source execjs - coffee-script-source (1.9.1.1) + coffee-script-source (1.10.0) colorator (0.1) em-websocket (0.5.1) eventmachine (>= 0.12.9) http_parser.rb (~> 0.6.0) eventmachine (1.0.8) execjs (2.6.0) + faraday (0.9.2) + multipart-post (>= 1.2, < 3) fast-stemmer (1.0.2) ffi (1.9.10) formatador (0.2.5) @@ -62,7 +65,8 @@ GEM coffee-script (~> 2.2) jekyll-contentblocks (1.0.1) jekyll - jekyll-gist (1.3.4) + jekyll-gist (1.4.0) + octokit (~> 4.2) jekyll-paginate (1.1.0) jekyll-sass-converter (1.3.0) sass (~> 3.2) @@ -70,7 +74,7 @@ GEM listen (~> 3.0) kramdown (1.9.0) liquid (2.6.3) - listen (3.0.3) + listen (3.0.5) rb-fsevent (>= 0.9.3) rb-inotify (>= 0.9) lumberjack (1.0.9) @@ -78,12 +82,15 @@ GEM method_source (0.8.2) mini_portile (0.6.2) multi_json (1.11.2) + multipart-post (2.0.0) nenv (0.2.0) nokogiri (1.6.6.2) mini_portile (~> 0.6.0) notiffany (0.0.8) nenv (~> 0.1) shellany (~> 0.0) + octokit (4.2.0) + sawyer (~> 0.6.0, >= 0.5.3) parslet (1.5.0) blankslate (~> 2.0) posix-spawn (0.3.11) @@ -100,7 +107,10 @@ GEM redcarpet (3.3.3) rouge (1.7.7) safe_yaml (1.0.4) - sass (3.4.19) + sass (3.4.20) + sawyer (0.6.0) + addressable (~> 2.3.5) + faraday (~> 0.8, < 0.10) shellany (0.0.1) slop (3.6.0) thor (0.19.1) @@ -118,7 +128,7 @@ DEPENDENCIES guard-jekyll-plus guard-livereload haml - jekyll + jekyll (< 3) jekyll-contentblocks nokogiri rouge diff --git a/docs/_config.yml b/docs/_config.yml index b8dfaf0b6..afb36b847 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -8,11 +8,28 @@ host: 0.0.0.0 # Navigation navigation: - - text: About - url: /about/ + - + text: Documentation + url: /documentation/ + - + text: About + url: /about/ # Build settings markdown: kramdown +kramdown: + input: GFM + hard_wrap: false + + auto_ids: true + footnote_nr: 1 + entity_output: as_char + smart_quotes: lsquo,rsquo,ldquo,rdquo + enable_coderay: true + + coderay_wrap: div + coderay_line_numbers: nil + coderay_css: style # Assets sass: diff --git a/docs/_includes/header.html b/docs/_includes/header.html index 4d1938e5b..11b9f2b1e 100644 --- a/docs/_includes/header.html +++ b/docs/_includes/header.html @@ -1,13 +1,14 @@ +