diff --git a/CHANGELOG.md b/CHANGELOG.md index 3cf87660c..88ac81877 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,322 +1,336 @@ - +# [2.6.0](https://github.com/algolia/docsearch/compare/v2.5.2...v2.6.0) (2018-11-07) + + +### Bug Fixes + +* **deps:** update dependency algolia-aerial to v1.3.4 ([7e72fe0](https://github.com/algolia/docsearch/commit/7e72fe0)) +* **deps:** update dependency algolia-aerial to v1.5.3 ([665438e](https://github.com/algolia/docsearch/commit/665438e)) +* **deps:** update dependency algolia-frontend-components to v0.0.35 ([bd5c03f](https://github.com/algolia/docsearch/commit/bd5c03f)) +* **deps:** update dependency autocomplete.js to ^0.30.0 ([21eb76a](https://github.com/algolia/docsearch/commit/21eb76a)) +* **deps:** update dependency autocomplete.js to ^0.31.0 ([6c65eb2](https://github.com/algolia/docsearch/commit/6c65eb2)) +* **deps:** update dependency chalk to v2 ([#323](https://github.com/algolia/docsearch/issues/323)) ([f8962bd](https://github.com/algolia/docsearch/commit/f8962bd)) +* **deps:** update dependency deepmerge to v2 ([#324](https://github.com/algolia/docsearch/issues/324)) ([db212d0](https://github.com/algolia/docsearch/commit/db212d0)) +* **deps:** update dependency progress to v2 ([#325](https://github.com/algolia/docsearch/issues/325)) ([a99347a](https://github.com/algolia/docsearch/commit/a99347a)) +* **wording:** fixed case of DocSearch ([#262](https://github.com/algolia/docsearch/issues/262)) ([d451545](https://github.com/algolia/docsearch/commit/d451545)) -## [2.5.2](https://github.com/algolia/docsearch/compare/v2.5.1...v2.5.2) (2017-12-07) ### Features -- **doc:** Precise attribution policy regarding `powered by algolia` -- **doc:** Enhance doc -- **build:** Provide styles in npm packages - -### Dependency updates - -- Renovate -- autoprefixer 7.2.1 -- babel-eslint 8.0.3 -- eslint 4.12.1 -- gh-pages 1.1.0 -- jsdom 11.5.1 -- node-sass 4.7.2 -- onchange 3.3.0 -- prettier 1.9.1 -- sinon 4.1.2 -- uglify-js 3.2.1 -- webpack 3.10.0 -- webpack-dev-server 2.9.7 -- babel-eslint 8.0.3 - - +* **css:** Update menu on small screen ([b5733d2](https://github.com/algolia/docsearch/commit/b5733d2)) +* **docsearch:** Add custom classes on titles for better crawling ([fc79098](https://github.com/algolia/docsearch/commit/fc79098)) -## [2.5.1](https://github.com/algolia/docsearch/compare/v2.5.0...v2.5.1) (2017-11-28) -### Bug Fixes -- **build:** fix minification since uglifyjs 3 ([68d3e0b](https://github.com/algolia/docsearch/commit/68d3e0b827603c7dc589f60b907fab25a60d0ff9)) +## [2.5.2](https://github.com/algolia/docsearch/compare/v2.5.1...v2.5.2) (2017-12-07) + + + +## [2.5.1](https://github.com/algolia/docsearch/compare/v2.5.0...v2.5.1) (2017-11-28) + - # [2.5.0](https://github.com/algolia/docsearch/compare/v2.4.1...v2.5.0) (2017-11-28) + ### Bug Fixes -- **autocompleteOptions:** allow cssClasses options ([#246](https://github.com/algolia/docsearch/issues/246)) ([6de70c3](https://github.com/algolia/docsearch/commit/6de70c3)) +* **autocompleteOptions:** allow cssClasses options ([#246](https://github.com/algolia/docsearch/issues/246)) ([6de70c3](https://github.com/algolia/docsearch/commit/6de70c3)) + ### Features -- **global:** Add responsive feature to the dropdown ([777d2d4](https://github.com/algolia/docsearch/commit/777d2d4)) +* **global:** Add responsive feature to the dropdown ([777d2d4](https://github.com/algolia/docsearch/commit/777d2d4)) - -## [2.4.1](https://github.com/algolia/docsearch/compare/v2.4.0...v2.4.1) (2017-08-08) -### Features +## [2.4.1](https://github.com/algolia/docsearch/compare/v2.4.0...v2.4.1) (2017-08-08) -- **doc:** Enhance doc - # [2.4.0](https://github.com/algolia/docsearch/compare/v2.3.3...v2.4.0) (2017-08-08) -### Features -- **doc:** Enhance doc - - ## [2.3.3](https://github.com/algolia/docsearch/compare/v2.3.2...v2.3.3) (2017-03-27) + ### Bug Fixes -- **build:** fix badly handled webpack upgrade ([3cbfbb1](https://github.com/algolia/docsearch/commit/3cbfbb1)) +* **build:** fix badly handled webpack upgrade ([3cbfbb1](https://github.com/algolia/docsearch/commit/3cbfbb1)) + - ## [2.3.2](https://github.com/algolia/docsearch/compare/v2.3.1...v2.3.2) (2017-03-27) - + ## [2.3.1](https://github.com/algolia/docsearch/compare/v2.3.0...v2.3.1) (2017-02-23) - + # [2.3.0](https://github.com/algolia/docsearch/compare/v2.2.1...v2.3.0) (2017-02-08) - + ## [2.2.1](https://github.com/algolia/docsearch/compare/v2.2.0...v2.2.1) (2017-01-11) - + # [2.2.0](https://github.com/algolia/docsearch/compare/v2.1.8...v2.2.0) (2016-12-13) - + ## [2.1.8](https://github.com/algolia/docsearch/compare/v2.1.7...v2.1.8) (2016-10-04) - + ## [2.1.7](https://github.com/algolia/docsearch/compare/v2.1.6...v2.1.7) (2016-10-03) + ### Bug Fixes -- **zepto:** upgrade autocomplete.js ([#150](https://github.com/algolia/docsearch/issues/150)) ([e024917](https://github.com/algolia/docsearch/commit/e024917)) +* **zepto:** upgrade autocomplete.js ([#150](https://github.com/algolia/docsearch/issues/150)) ([e024917](https://github.com/algolia/docsearch/commit/e024917)) + - ## [2.1.6](https://github.com/algolia/docsearch/compare/v2.1.5...v2.1.6) (2016-10-02) - + ## [2.1.5](https://github.com/algolia/docsearch/compare/v2.1.4...v2.1.5) (2016-09-15) + ### Bug Fixes -- **empty:** query should be escaped (self-XSS) ([#147](https://github.com/algolia/docsearch/issues/147)) ([3aed41b](https://github.com/algolia/docsearch/commit/3aed41b)) +* **empty:** query should be escaped (self-XSS) ([#147](https://github.com/algolia/docsearch/issues/147)) ([3aed41b](https://github.com/algolia/docsearch/commit/3aed41b)) + - ## [2.1.4](https://github.com/algolia/docsearch/compare/v2.1.3...v2.1.4) (2016-08-03) - + ## [2.1.3](https://github.com/algolia/docsearch/compare/v2.1.2...v2.1.3) (2016-08-03) - + ## [2.1.2](https://github.com/algolia/docsearch/compare/v2.1.1...v2.1.2) (2016-07-22) - + ## [2.1.1](https://github.com/algolia/docsearch/compare/v2.1.0...v2.1.1) (2016-07-22) - + # [2.1.0](https://github.com/algolia/docsearch/compare/v2.0.7...v2.1.0) (2016-07-07) + ### Bug Fixes -- **doc:** docsearch header link ([#117](https://github.com/algolia/docsearch/issues/117)) ([66e68a9](https://github.com/algolia/docsearch/commit/66e68a9)) +* **doc:** docsearch header link ([#117](https://github.com/algolia/docsearch/issues/117)) ([66e68a9](https://github.com/algolia/docsearch/commit/66e68a9)) + - ## [2.0.7](https://github.com/algolia/docsearch/compare/v2.0.6...v2.0.7) (2016-06-28) - + ## [2.0.6](https://github.com/algolia/docsearch/compare/v2.0.5...v2.0.6) (2016-06-28) + ### Bug Fixes -- **typos:** no result page ([0f40e1d](https://github.com/algolia/docsearch/commit/0f40e1d)) +* **typos:** no result page ([0f40e1d](https://github.com/algolia/docsearch/commit/0f40e1d)) + ### Features -- **docs:** new community header / footer ([#114](https://github.com/algolia/docsearch/issues/114)) ([af76d31](https://github.com/algolia/docsearch/commit/af76d31)) +* **docs:** new community header / footer ([#114](https://github.com/algolia/docsearch/issues/114)) ([af76d31](https://github.com/algolia/docsearch/commit/af76d31)) + - ## [2.0.5](https://github.com/algolia/docsearch/compare/v2.0.4...v2.0.5) (2016-06-21) + ### Bug Fixes -- **DOM:** potential issue with simple layout if there is lvl0, lvl2 but no lvl1 ([57c0101](https://github.com/algolia/docsearch/commit/57c0101)) +* **DOM:** potential issue with simple layout if there is lvl0, lvl2 but no lvl1 ([57c0101](https://github.com/algolia/docsearch/commit/57c0101)) + - ## [2.0.4](https://github.com/algolia/docsearch/compare/v2.0.3...v2.0.4) (2016-06-21) + ### Features -- **DOM:** split simple and collumns template ([2a3b7eb](https://github.com/algolia/docsearch/commit/2a3b7eb)) +* **DOM:** split simple and collumns template ([2a3b7eb](https://github.com/algolia/docsearch/commit/2a3b7eb)) + - ## [2.0.3](https://github.com/algolia/docsearch/compare/v2.0.2...v2.0.3) (2016-06-20) - + ## [2.0.2](https://github.com/algolia/docsearch/compare/v2.0.1...v2.0.2) (2016-06-14) + ### Features -- **dom:** better handling of simple design ([6bba640](https://github.com/algolia/docsearch/commit/6bba640)) +* **dom:** better handling of simple design ([6bba640](https://github.com/algolia/docsearch/commit/6bba640)) + - ## [2.0.1](https://github.com/algolia/docsearch/compare/v2.0.0...v2.0.1) (2016-06-14) - + # [2.0.0](https://github.com/algolia/docsearch/compare/v1.3.0...v2.0.0) (2016-06-14) + ### Features -- **v2:** modification for v2 ([#112](https://github.com/algolia/docsearch/issues/112)) ([f0a7e6b](https://github.com/algolia/docsearch/commit/f0a7e6b)), closes [#92](https://github.com/algolia/docsearch/issues/92) [#102](https://github.com/algolia/docsearch/issues/102) +* **v2:** modification for v2 ([#112](https://github.com/algolia/docsearch/issues/112)) ([f0a7e6b](https://github.com/algolia/docsearch/commit/f0a7e6b)), closes [#92](https://github.com/algolia/docsearch/issues/92) [#102](https://github.com/algolia/docsearch/issues/102) + - # [1.3.0](https://github.com/algolia/docsearch/compare/1.2.0...v1.3.0) (2016-06-12) - + # [1.2.0](https://github.com/algolia/docsearch/compare/v1.1.3...1.2.0) (2016-06-10) + ### Features -- **DOM:** add an align class ([#108](https://github.com/algolia/docsearch/issues/108)) ([9421897](https://github.com/algolia/docsearch/commit/9421897)) -- **serve:** Watch and serve all needed files ([#91](https://github.com/algolia/docsearch/issues/91)) ([ef83775](https://github.com/algolia/docsearch/commit/ef83775)) -- **website:** add echo ([#94](https://github.com/algolia/docsearch/issues/94)) ([8a34ecb](https://github.com/algolia/docsearch/commit/8a34ecb)) +* **DOM:** add an align class ([#108](https://github.com/algolia/docsearch/issues/108)) ([9421897](https://github.com/algolia/docsearch/commit/9421897)) +* **serve:** Watch and serve all needed files ([#91](https://github.com/algolia/docsearch/issues/91)) ([ef83775](https://github.com/algolia/docsearch/commit/ef83775)) +* **website:** add echo ([#94](https://github.com/algolia/docsearch/issues/94)) ([8a34ecb](https://github.com/algolia/docsearch/commit/8a34ecb)) + - ## [1.1.3](https://github.com/algolia/docsearch/compare/v1.1.2...v1.1.3) (2016-04-04) + ### Bug Fixes -- **autocomplete.js:** upgrade the underlying autocomplete.js to ensur… ([4d7022e](https://github.com/algolia/docsearch/commit/4d7022e)), closes [#89](https://github.com/algolia/docsearch/issues/89) +* **autocomplete.js:** upgrade the underlying autocomplete.js to ensur… ([4d7022e](https://github.com/algolia/docsearch/commit/4d7022e)), closes [#89](https://github.com/algolia/docsearch/issues/89) + - ## [1.1.2](https://github.com/algolia/docsearch/compare/v1.1.1...v1.1.2) (2016-03-24) + ### Features -- **website:** React :raised_hands:, popped out on the top with React ([db9c100](https://github.com/algolia/docsearch/commit/db9c100)) +* **website:** React :raised_hands:, popped out on the top with React ([db9c100](https://github.com/algolia/docsearch/commit/db9c100)) + - ## [1.1.1](https://github.com/algolia/docsearch/compare/v1.1.0...v1.1.1) (2016-03-16) + ### Bug Fixes -- **algoliaOptions:** ensure we keep default options ([b284dda](https://github.com/algolia/docsearch/commit/b284dda)), closes [#78](https://github.com/algolia/docsearch/issues/78) -- **autocomplete:** auto select top result ([473824a](https://github.com/algolia/docsearch/commit/473824a)), closes [#81](https://github.com/algolia/docsearch/issues/81) -- **dev:** Fixed the dev example, targeting an existing index ([df13e34](https://github.com/algolia/docsearch/commit/df13e34)) -- **website:** responsive logo ([b856d67](https://github.com/algolia/docsearch/commit/b856d67)) +* **algoliaOptions:** ensure we keep default options ([b284dda](https://github.com/algolia/docsearch/commit/b284dda)), closes [#78](https://github.com/algolia/docsearch/issues/78) +* **autocomplete:** auto select top result ([473824a](https://github.com/algolia/docsearch/commit/473824a)), closes [#81](https://github.com/algolia/docsearch/issues/81) +* **dev:** Fixed the dev example, targeting an existing index ([df13e34](https://github.com/algolia/docsearch/commit/df13e34)) +* **website:** responsive logo ([b856d67](https://github.com/algolia/docsearch/commit/b856d67)) + ### Features -- **serve:** Add `npm run serve` to expose js and css locally ([31e5d13](https://github.com/algolia/docsearch/commit/31e5d13)) -- **website:** community header ([366cc0d](https://github.com/algolia/docsearch/commit/366cc0d)) -- **website:** Logo Update - Og screen + favicon ([c7eb54a](https://github.com/algolia/docsearch/commit/c7eb54a)) -- **website:** removed demos ([6d8eb34](https://github.com/algolia/docsearch/commit/6d8eb34)) -- **website:** update ([9498e3b](https://github.com/algolia/docsearch/commit/9498e3b)) -- **website:** updated logo ([fa413d9](https://github.com/algolia/docsearch/commit/fa413d9)) +* **serve:** Add `npm run serve` to expose js and css locally ([31e5d13](https://github.com/algolia/docsearch/commit/31e5d13)) +* **website:** community header ([366cc0d](https://github.com/algolia/docsearch/commit/366cc0d)) +* **website:** Logo Update - Og screen + favicon ([c7eb54a](https://github.com/algolia/docsearch/commit/c7eb54a)) +* **website:** removed demos ([6d8eb34](https://github.com/algolia/docsearch/commit/6d8eb34)) +* **website:** update ([9498e3b](https://github.com/algolia/docsearch/commit/9498e3b)) +* **website:** updated logo ([fa413d9](https://github.com/algolia/docsearch/commit/fa413d9)) + - # [1.1.0](https://github.com/algolia/docsearch/compare/v1.0.2...v1.1.0) (2016-02-01) + ### Bug Fixes -- **dropdown:** Visually group suggestions together ([592c8f2](https://github.com/algolia/docsearch/commit/592c8f2)) +* **dropdown:** Visually group suggestions together ([592c8f2](https://github.com/algolia/docsearch/commit/592c8f2)) + ### Features -- **website:** ensure the inputs are mandatory ([e59d132](https://github.com/algolia/docsearch/commit/e59d132)) +* **website:** ensure the inputs are mandatory ([e59d132](https://github.com/algolia/docsearch/commit/e59d132)) + - ## [1.0.2](https://github.com/algolia/docsearch/compare/v1.0.1...v1.0.2) (2015-12-28) + ### Bug Fixes -- **debut:** do not enable debug by default ([188f49e](https://github.com/algolia/docsearch/commit/188f49e)) -- **url:** Removes concatenation of URL with hash if it contains a hash ([348df1c](https://github.com/algolia/docsearch/commit/348df1c)), closes [#53](https://github.com/algolia/docsearch/issues/53) -- **usage:** fixed usage to match the latest prototype version ([f6edc9e](https://github.com/algolia/docsearch/commit/f6edc9e)) +* **debut:** do not enable debug by default ([188f49e](https://github.com/algolia/docsearch/commit/188f49e)) +* **url:** Removes concatenation of URL with hash if it contains a hash ([348df1c](https://github.com/algolia/docsearch/commit/348df1c)), closes [#53](https://github.com/algolia/docsearch/issues/53) +* **usage:** fixed usage to match the latest prototype version ([f6edc9e](https://github.com/algolia/docsearch/commit/f6edc9e)) + - ## [1.0.1](https://github.com/algolia/docsearch/compare/v1.0.0...v1.0.1) (2015-12-24) + ### Bug Fixes -- **handleSelected:** ensure we're calling setVal on the right object ([31abbd7](https://github.com/algolia/docsearch/commit/31abbd7)), closes [#51](https://github.com/algolia/docsearch/issues/51) +* **handleSelected:** ensure we're calling setVal on the right object ([31abbd7](https://github.com/algolia/docsearch/commit/31abbd7)), closes [#51](https://github.com/algolia/docsearch/issues/51) + - # [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) +* **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) + - ## [0.0.7](https://github.com/algolia/docsearch/compare/v0.0.6...v0.0.7) (2015-12-22) + ### Bug Fixes -- **appId:** Allow passing a custom appId ([e1777d3](https://github.com/algolia/docsearch/commit/e1777d3)), closes [#21](https://github.com/algolia/docsearch/issues/21) -- **css:** Renaming all `ads-` prefix to `algolia-docsearch-` ([c6fc53f](https://github.com/algolia/docsearch/commit/c6fc53f)) +* **appId:** Allow passing a custom appId ([e1777d3](https://github.com/algolia/docsearch/commit/e1777d3)), closes [#21](https://github.com/algolia/docsearch/issues/21) +* **css:** Renaming all `ads-` prefix to `algolia-docsearch-` ([c6fc53f](https://github.com/algolia/docsearch/commit/c6fc53f)) + - ## [0.0.6](https://github.com/algolia/docsearch/compare/v0.0.5...v0.0.6) (2015-12-16) - + ## [0.0.5](https://github.com/algolia/docsearch/compare/v0.0.4...v0.0.5) (2015-12-16) - + ## [0.0.4](https://github.com/algolia/docsearch/compare/v0.0.3...v0.0.4) (2015-12-16) - + ## [0.0.3](https://github.com/algolia/docsearch/compare/v0.0.2...v0.0.3) (2015-12-16) - + ## [0.0.2](https://github.com/algolia/docsearch/compare/bdac9dd...v0.0.2) (2015-12-16) + ### Bug Fixes -- **colors:** Reduce number of colors ([125d1c7](https://github.com/algolia/docsearch/commit/125d1c7)) -- **snippet:** Fix typo in method name ([751dfdb](https://github.com/algolia/docsearch/commit/751dfdb)) +* **colors:** Reduce number of colors ([125d1c7](https://github.com/algolia/docsearch/commit/125d1c7)) +* **snippet:** Fix typo in method name ([751dfdb](https://github.com/algolia/docsearch/commit/751dfdb)) + ### Features -- **gh-pages:** Add gh-pages deploy script ([ab1a299](https://github.com/algolia/docsearch/commit/ab1a299)) -- **main:** Add main wrapper ([bdac9dd](https://github.com/algolia/docsearch/commit/bdac9dd)) -- **styling:** Set grayscale as default, add styling as external file ([5d8cca8](https://github.com/algolia/docsearch/commit/5d8cca8)) +* **gh-pages:** Add gh-pages deploy script ([ab1a299](https://github.com/algolia/docsearch/commit/ab1a299)) +* **main:** Add main wrapper ([bdac9dd](https://github.com/algolia/docsearch/commit/bdac9dd)) +* **styling:** Set grayscale as default, add styling as external file ([5d8cca8](https://github.com/algolia/docsearch/commit/5d8cca8)) + + + diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b576ad754..8295131e5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,21 +3,15 @@ Hi (future) collaborator! -**Table of Contents** - -- [Where to start?][1] -- [Development workflow][2] - - [Requirements][3] - - [Launch][4] - - [Local build][5] -- [Commit message guidelines][6] - - [Revert][7] - - [Type][8] - - [Scope][9] - - [Subject][10] - - [Body][11] - - [Footer][12] -- [Releasing][13] + +- [Where to start?](#where-to-start) +- [Development workflow](#development-workflow) + - [Requirements](#requirements) + - [Build](#build) + - [Serve](#serve) + - [Test](#test) + - [Docs](#docs) + - [Release](#release) diff --git a/README.md b/README.md index 2d1b373a6..9164c0ba0 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,11 @@ + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [Related projects](#related-projects) + + + [![DocSearch][1]][8] The easiest way to add search to your documentation. For free. diff --git a/package.json b/package.json index 8fc485ba8..77520f607 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "docsearch.js", - "version": "2.5.2", + "version": "2.6.0", "description": "Add an autocomplete dropdown to your documentation", "main": "dist/npm/index.js", "scripts": { diff --git a/src/lib/version.js b/src/lib/version.js index 077251723..265de7683 100644 --- a/src/lib/version.js +++ b/src/lib/version.js @@ -1 +1 @@ -export default '2.5.2'; +export default '2.6.0';