diff --git a/CHANGELOG.md b/CHANGELOG.md index e6b88186d5a9..913653a50b8a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,35 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0. ## [Unreleased] +## [1.0.8] - 2018-03-12 + +This is a targeted feature and bug fix release. A couple of things of interest are that this release fixes some [issues](https://github.com/facebook/Docusaurus/issues/468) with Windows that were occurring, particularly when building the docs, both locally and publishing, as well as addressing an [issue](https://github.com/facebook/Docusaurus/issues/344) for support for a secondary, on-page sidebar for local page navigation, which is now enabled for docusaurus.io. Total commits in this release is 27, including the release itself. + +### Breaking Changes + +N/A + +### Added + +- [Add separate, on-page navigation sidebar option so that you can see links to local page topics](https://github.com/facebook/Docusaurus/commit/4ff2fe280ebd41c4b491936fdd4ae75b7805ed61), thanks @microbouji. +- [You can now use a custom `appId` for your Algolia search](https://github.com/facebook/Docusaurus/commit/4ea8158c0cf2105b0fec767289fd722ebc6e3a92), thanks @atroncy. +- [The header navigation now shows the active link clearly](https://github.com/facebook/Docusaurus/commit/48ee457ec98b728343196362d5d42c0dc3d1cff9), thanks @microbouji. +- [Replace Circle CI 1.0 publishing documentation with Circle CI 2.0](https://docusaurus.io/docs/en/publishing.html#using-circle-ci-20), thanks @ashleytqy. + +### Fixed/Changed + +- [Use `path` functions in order to fix building on Windows](https://github.com/facebook/Docusaurus/commit/cbdab2ba1112e8949683d23ce20034aa17d9013d) +- [`latestVersion` was fixed when running the local server](https://github.com/facebook/Docusaurus/commit/4a10be8002af4bf59a3830d75c5860b83df3d2a6), thanks @sunnylqm. +- [Environment variables take precedent over config options when publishing](https://github.com/facebook/Docusaurus/commit/d2bff6929e410f03bc4758538020167c828b156e), thanks @juanpicado. +- [i18n support fixed for the home page link in the header](https://github.com/facebook/Docusaurus/commit/f8486e02ae2b28e7c04cf72617a31716b64a445c) and [the sidebar navigation](https://github.com/facebook/Docusaurus/commit/4553afda2bdb68db2f5f014a117cf93e81014037), thank @cheercroaker. +- [Document an existing feature that has already existed, `ogImage`](https://github.com/facebook/Docusaurus/commit/a8d7299ef2c055e7cd48cf6a78ed2204a964bdaa), thanks @miralemd. +- [`siteConfig.users` is now optional](https://github.com/facebook/Docusaurus/commit/8c2145585c415f0e1b093c33cc2aba46c407b575), thanks @aimeerpierce. +- [`id` used instead of `name` in anchors, bringing us more HTML 5 compliant](https://github.com/facebook/Docusaurus/commit/c800870fefe0f3f1987ea0731d0ad1391ea35471), thanks @ronami. + +### Removed + +N/A + ## [1.0.7] - 2018-02-17 **This is a hotfix release** @@ -26,13 +55,13 @@ N/A - [Relax restriction on versioned doc ids with dashes](https://github.com/facebook/Docusaurus/commit/ec6ff9284c03e3287089f65e596a2293097c23ab) - [Broken link in the site config docs](https://github.com/facebook/Docusaurus/commit/f79cfaa3a11270665ab528b26a37f2598a878bff), thanks @justinmusgrove. -## Removed +### Removed N/A ## [1.0.6] - 2018-02-12 -This is a bigger release than normal as it has been a month since releases. It contains bug fixes, duplicate code removal, a few new feaatures, and documentation updates. Total commits in this release is 38, including the release itself. +This is a bigger release than normal as it has been a month since releases. It contains bug fixes, duplicate code removal, a few new features, and documentation updates. Total commits in this release is 38, including the release itself. ### Breaking Changes @@ -43,7 +72,7 @@ N/A - Option to control number of blog posts in sidebar ([#432](https://github.com/facebook/Docusaurus/commit/dfb70e18296fe0feb53ac05e807cba290b5da3d7), thanks @ericnakagawa) - `font-family` is now a configurable parameter ([#294](https://github.com/facebook/Docusaurus/commit/a241a466697a2bb9fa022df29fba35dd49e29715), thanks @cowlingj) - Configurable edit URL link, per doc ([#443](https://github.com/facebook/Docusaurus/commit/41750667cd74b66c2bdde00619d290fc293a01d3), thanks @Glavin001) -- New Docusaurus [users](https://docusaurus.io/en/users.html): [Vuls](https://vuls.io/), [react-native-ios-kit](https://callstack.github.io/react-native-ios-kit) and [Verdaccio](http://www.verdaccio.org/) +- New Docusaurus [users](https://docusaurus.io/en/users.html): [Vuls](https://vuls.io/), [react-native-ios-kit](https://callstack.github.io/react-native-ios-kit) and [Verdaccio](http://www.verdaccio.org/) - Docs section about referencing site documents ([#394](https://github.com/facebook/Docusaurus/commit/1d967a941cfc7256588ce8b88291d7f3c86c1983) ) - Clarified docs on [publishing to a user/org page](https://docusaurus.io/docs/en/publishing.html#using-github-pages) @@ -124,7 +153,8 @@ N/A - Blog - Documentation -[Unreleased]: https://github.com/facebook/Docusaurus/compare/v1.0.7...HEAD +[Unreleased]: https://github.com/facebook/Docusaurus/compare/v1.0.8...HEAD +[1.0.8]: https://github.com/facebook/Docusaurus/compare/v1.0.7...v1.0.8 [1.0.7]: https://github.com/facebook/Docusaurus/compare/v1.0.6...v1.0.7 [1.0.6]: https://github.com/facebook/Docusaurus/compare/v1.0.5...v1.0.6 [1.0.5]: https://github.com/facebook/Docusaurus/compare/v1.0.4...v1.0.5 diff --git a/package-lock.json b/package-lock.json index c20ff0ab8477..cafcf9255047 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,6 +1,6 @@ { "name": "docusaurus", - "version": "1.0.7", + "version": "1.0.8", "lockfileVersion": 1, "requires": true, "dependencies": { diff --git a/package.json b/package.json index bae536325bbd..17423eb5e363 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "docusaurus", "description": "Easy to Maintain Open Source Documentation Websites", - "version": "1.0.7", + "version": "1.0.8", "license": "MIT", "keywords": [ "documentation",