From 9f6460fde096e988e4454e6ec5dac7ceea7500b0 Mon Sep 17 00:00:00 2001 From: Yangshun Tay Date: Sat, 12 Oct 2019 01:11:34 -0700 Subject: [PATCH] misc: facebook/Docusaurus -> facebook/docusaurus --- .github/ISSUE_TEMPLATE.md | 2 +- .github/ISSUE_TEMPLATE/bug.md | 2 +- .github/ISSUE_TEMPLATE/documentation.md | 2 +- .github/ISSUE_TEMPLATE/feature.md | 2 +- .github/ISSUE_TEMPLATE/proposal.md | 2 +- .github/PULL_REQUEST_TEMPLATE.md | 4 +- CHANGELOG.md | 594 +++++++++--------- CONTRIBUTING.md | 4 +- README.md | 6 +- admin/prerelease.md | 6 +- admin/publish.md | 8 +- docs/api-doc-markdown.md | 2 +- docs/getting-started-installation.md | 2 +- docs/getting-started-publishing.md | 2 +- docs/guides-navigation.md | 2 +- packages/docusaurus-1.x/README.md | 8 +- .../docusaurus-1.x/examples/basics/README.md | 2 +- .../__fixtures__/2018-08-17-docusaurus.md | 2 +- .../__tests__/__snapshots__/blog.test.js.snap | 2 +- packages/docusaurus-1.x/package.json | 2 +- packages/docusaurus/package.json | 4 +- .../blog/2017-12-14-introducing-docusaurus.md | 8 +- .../blog/2018-09-11-Towards-Docusaurus-2.md | 10 +- website-1.x/pages/en/help.js | 2 +- website-1.x/pages/en/index.js | 2 +- .../version-1.10.x/api-doc-markdown.md | 2 +- .../getting-started-publishing.md | 2 +- .../version-1.10.x/guides-navigation.md | 2 +- .../version-1.12.0/api-doc-markdown.md | 2 +- .../getting-started-publishing.md | 2 +- .../version-1.9.x/api-doc-markdown.md | 2 +- .../getting-started-installation.md | 2 +- .../getting-started-publishing.md | 2 +- .../version-1.9.x/guides-navigation.md | 2 +- website/docs/contributing.md | 4 +- website/src/pages/index.js | 2 +- 36 files changed, 353 insertions(+), 353 deletions(-) diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index c7c7b52fe2..03e1b71eb1 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,3 +1,3 @@ -## ๐Ÿ‘‰ [Please follow one of these issue templates](https://github.com/facebook/Docusaurus/issues/new/choose) ๐Ÿ‘ˆ +## ๐Ÿ‘‰ [Please follow one of these issue templates](https://github.com/facebook/docusaurus/issues/new/choose) ๐Ÿ‘ˆ Note: to keep the backlog clean and actionable, issues may be immediately closed if they do not follow one of the above issue templates. diff --git a/.github/ISSUE_TEMPLATE/bug.md b/.github/ISSUE_TEMPLATE/bug.md index c6da4d8ddf..821ba92994 100644 --- a/.github/ISSUE_TEMPLATE/bug.md +++ b/.github/ISSUE_TEMPLATE/bug.md @@ -7,7 +7,7 @@ about: Submit a bug report to help us improve (A clear and concise description of what the bug is) -### Have you read the [Contributing Guidelines on issues](https://github.com/facebook/Docusaurus/blob/master/CONTRIBUTING.md#reporting-new-issues)? +### Have you read the [Contributing Guidelines on issues](https://github.com/facebook/docusaurus/blob/master/CONTRIBUTING.md#reporting-new-issues)? (Write your answer here.) diff --git a/.github/ISSUE_TEMPLATE/documentation.md b/.github/ISSUE_TEMPLATE/documentation.md index 05d8559789..3ac913bd6e 100644 --- a/.github/ISSUE_TEMPLATE/documentation.md +++ b/.github/ISSUE_TEMPLATE/documentation.md @@ -7,6 +7,6 @@ about: Report an issue related to documentation (A clear and concise description of what the issue is.) -### Have you read the [Contributing Guidelines on issues](https://github.com/facebook/Docusaurus/blob/master/CONTRIBUTING.md#reporting-new-issues)? +### Have you read the [Contributing Guidelines on issues](https://github.com/facebook/docusaurus/blob/master/CONTRIBUTING.md#reporting-new-issues)? (Write your answer here.) diff --git a/.github/ISSUE_TEMPLATE/feature.md b/.github/ISSUE_TEMPLATE/feature.md index e918090603..07d7f1a94c 100644 --- a/.github/ISSUE_TEMPLATE/feature.md +++ b/.github/ISSUE_TEMPLATE/feature.md @@ -12,7 +12,7 @@ about: Submit a proposal/request for a new feature (A clear and concise description of what the feature is.) -## Have you read the [Contributing Guidelines on issues](https://github.com/facebook/Docusaurus/blob/master/CONTRIBUTING.md#reporting-new-issues)? +## Have you read the [Contributing Guidelines on issues](https://github.com/facebook/docusaurus/blob/master/CONTRIBUTING.md#reporting-new-issues)? (Write your answer here.) diff --git a/.github/ISSUE_TEMPLATE/proposal.md b/.github/ISSUE_TEMPLATE/proposal.md index 6440a2fa05..218d8d87d9 100644 --- a/.github/ISSUE_TEMPLATE/proposal.md +++ b/.github/ISSUE_TEMPLATE/proposal.md @@ -12,6 +12,6 @@ about: Propose a non-trivial change to Docusaurus (A clear and concise description of what the proposal is.) -### Have you read the [Contributing Guidelines on issues](https://github.com/facebook/Docusaurus/blob/master/CONTRIBUTING.md#reporting-new-issues)? +### Have you read the [Contributing Guidelines on issues](https://github.com/facebook/docusaurus/blob/master/CONTRIBUTING.md#reporting-new-issues)? (Write your answer here.) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 0df1c49e02..8a4ba54d4a 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -3,7 +3,7 @@ Thank you for sending the PR! We appreciate you spending the time to work on the Help us understand your motivation by explaining why you decided to make this change. -You can learn more about contributing to Docusaurus here: https://github.com/facebook/Docusaurus/blob/master/CONTRIBUTING.md +You can learn more about contributing to Docusaurus here: https://github.com/facebook/docusaurus/blob/master/CONTRIBUTING.md Happy contributing! @@ -13,7 +13,7 @@ Happy contributing! (Write your motivation here.) -### Have you read the [Contributing Guidelines on pull requests](https://github.com/facebook/Docusaurus/blob/master/CONTRIBUTING.md#pull-requests)? +### Have you read the [Contributing Guidelines on pull requests](https://github.com/facebook/docusaurus/blob/master/CONTRIBUTING.md#pull-requests)? (Write your answer here.) diff --git a/CHANGELOG.md b/CHANGELOG.md index eac876e23a..31fb687944 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -62,10 +62,10 @@ We also welcome @wgao19 to the core team! She'll be helping us with Docusaurus 2 ### Changes -- fix: reload siteConfig.js automatically when locally served page is refreshed ([#1509](https://github.com/facebook/Docusaurus/pull/1509)) -- fix: don't collapse the blog navigation even if collapsible is true ([#1519](https://github.com/facebook/Docusaurus/pull/1519)) -- fix: enable live reloading title of doc ([#1507](https://github.com/facebook/Docusaurus/pull/1507)) -- feat: highlight nav item in onPageNav ToC ([#1524](https://github.com/facebook/Docusaurus/pull/1524)) +- fix: reload siteConfig.js automatically when locally served page is refreshed ([#1509](https://github.com/facebook/docusaurus/pull/1509)) +- fix: don't collapse the blog navigation even if collapsible is true ([#1519](https://github.com/facebook/docusaurus/pull/1519)) +- fix: enable live reloading title of doc ([#1507](https://github.com/facebook/docusaurus/pull/1507)) +- feat: highlight nav item in onPageNav ToC ([#1524](https://github.com/facebook/docusaurus/pull/1524)) ## [1.10.0] - 2019-05-21 @@ -91,15 +91,15 @@ Thank you to following contributors: ### Main Changes -- feat: allow different host through CLI flag ([#1475](https://github.com/facebook/Docusaurus/pull/1475)) -- fix: docusaurus code tab logic by ([#1369](https://github.com/facebook/Docusaurus/pull/1369)). This fixes [code tabs does not allow HTML comments within codeblock](https://github.com/facebook/Docusaurus/issues/1260) and [Code tabs break numbered lists and cannot be indented](https://github.com/facebook/Docusaurus/pull/1371). -- fix: add missing `markdownOptions` siteConfig feature to override remarkable options ([#1430](https://github.com/facebook/Docusaurus/pull/1430)) -- fix: right table of content does not render special characters ([#1458](https://github.com/facebook/Docusaurus/pull/1458)) -- fix(regression): missing CLI commands introduced in v1.8.0 ([#1478](https://github.com/facebook/Docusaurus/pull/1478)) -- fix: h3 topics with Markdown formatting causes a glitch on mobile ([#1467](https://github.com/facebook/Docusaurus/pull/1467)) -- fix: wrong url in next/prev button in some cases ([#1488](https://github.com/facebook/Docusaurus/pull/1488)) -- fix: content displayed on bottom of mobile viewport when TOC is active ([#1489](https://github.com/facebook/Docusaurus/pull/1489)) -- fix: mobile navigation should show deepest breadcrumb instead of outer ([#1493](https://github.com/facebook/Docusaurus/pull/1493)) +- feat: allow different host through CLI flag ([#1475](https://github.com/facebook/docusaurus/pull/1475)) +- fix: docusaurus code tab logic by ([#1369](https://github.com/facebook/docusaurus/pull/1369)). This fixes [code tabs does not allow HTML comments within codeblock](https://github.com/facebook/docusaurus/issues/1260) and [Code tabs break numbered lists and cannot be indented](https://github.com/facebook/docusaurus/pull/1371). +- fix: add missing `markdownOptions` siteConfig feature to override remarkable options ([#1430](https://github.com/facebook/docusaurus/pull/1430)) +- fix: right table of content does not render special characters ([#1458](https://github.com/facebook/docusaurus/pull/1458)) +- fix(regression): missing CLI commands introduced in v1.8.0 ([#1478](https://github.com/facebook/docusaurus/pull/1478)) +- fix: h3 topics with Markdown formatting causes a glitch on mobile ([#1467](https://github.com/facebook/docusaurus/pull/1467)) +- fix: wrong url in next/prev button in some cases ([#1488](https://github.com/facebook/docusaurus/pull/1488)) +- fix: content displayed on bottom of mobile viewport when TOC is active ([#1489](https://github.com/facebook/docusaurus/pull/1489)) +- fix: mobile navigation should show deepest breadcrumb instead of outer ([#1493](https://github.com/facebook/docusaurus/pull/1493)) ## [1.9.0] - 2019-4-29 @@ -123,13 +123,13 @@ Thank you to the following contributors: ### Fixed/Added -- docs: consistent badge style ([#1371](https://github.com/facebook/Docusaurus/pull/1371)) -- fix: prism syntax highlight .tsx properly ([#1391](https://github.com/facebook/Docusaurus/pull/1391)) -- feat: add tutorial ([#1381](https://github.com/facebook/Docusaurus/pull/1381)) -- feat: change icon for navToggle ([#1394](https://github.com/facebook/Docusaurus/pull/1394)) -- fix: blog docs example as object property ([#1403](https://github.com/facebook/Docusaurus/pull/1403)) -- docs: docs-examples-from-docusaurus is now installed as doc ([#1406](https://github.com/facebook/Docusaurus/pull/1406)) -- fix: upgrade underscore.string to 3.3.5 ([#1404](https://github.com/facebook/Docusaurus/pull/1404)) +- docs: consistent badge style ([#1371](https://github.com/facebook/docusaurus/pull/1371)) +- fix: prism syntax highlight .tsx properly ([#1391](https://github.com/facebook/docusaurus/pull/1391)) +- feat: add tutorial ([#1381](https://github.com/facebook/docusaurus/pull/1381)) +- feat: change icon for navToggle ([#1394](https://github.com/facebook/docusaurus/pull/1394)) +- fix: blog docs example as object property ([#1403](https://github.com/facebook/docusaurus/pull/1403)) +- docs: docs-examples-from-docusaurus is now installed as doc ([#1406](https://github.com/facebook/docusaurus/pull/1406)) +- fix: upgrade underscore.string to 3.3.5 ([#1404](https://github.com/facebook/docusaurus/pull/1404)) ## [1.8.1] - 2019-4-15 @@ -148,17 +148,17 @@ Thank you to the following contributors: ### Fixed/Added -- feat: Add --skip-next-release option to yarn build ([#1292](https://github.com/facebook/Docusaurus/pull/1292)) -- fix: handle case insensitive table of contents token ([#1288](https://github.com/facebook/Docusaurus/pull/1288)) -- fix: anchors links for underscore character ([#1309](https://github.com/facebook/Docusaurus/pull/1309)) -- fix: autogenerated versions.js should not be confusing ([#1314](https://github.com/facebook/Docusaurus/pull/1314)) +- feat: Add --skip-next-release option to yarn build ([#1292](https://github.com/facebook/docusaurus/pull/1292)) +- fix: handle case insensitive table of contents token ([#1288](https://github.com/facebook/docusaurus/pull/1288)) +- fix: anchors links for underscore character ([#1309](https://github.com/facebook/docusaurus/pull/1309)) +- fix: autogenerated versions.js should not be confusing ([#1314](https://github.com/facebook/docusaurus/pull/1314)) ### Internal -- Change Docusaurus landing page ([#1290](https://github.com/facebook/Docusaurus/pull/1290)) -- We restructured our repository as a monorepo ([#1297](https://github.com/facebook/Docusaurus/pull/1297)) -- We folded docusaurus versions (e.g: 1.1.0, 1.1.1, 1.1.2 -> 1.1.x) ([#1313](https://github.com/facebook/Docusaurus/pull/1313)) -- optimize docusaurus continuous integration ([#1308](https://github.com/facebook/Docusaurus/pull/1308)) +- Change Docusaurus landing page ([#1290](https://github.com/facebook/docusaurus/pull/1290)) +- We restructured our repository as a monorepo ([#1297](https://github.com/facebook/docusaurus/pull/1297)) +- We folded docusaurus versions (e.g: 1.1.0, 1.1.1, 1.1.2 -> 1.1.x) ([#1313](https://github.com/facebook/docusaurus/pull/1313)) +- optimize docusaurus continuous integration ([#1308](https://github.com/facebook/docusaurus/pull/1308)) ## [1.7.3] - 2019-3-19 @@ -185,27 +185,27 @@ Thank you to the following contributors who helped with this release: ### Fixed/Changed -- Update code.facebook.com links to appropriate new destination ([#1224](https://github.com/facebook/Docusaurus/pull/1224)) -- docs: showcase user accord-project ([#1225](https://github.com/facebook/Docusaurus/pull/1225)) +- Update code.facebook.com links to appropriate new destination ([#1224](https://github.com/facebook/docusaurus/pull/1224)) +- docs: showcase user accord-project ([#1225](https://github.com/facebook/docusaurus/pull/1225)) - fix: change mainContainer padding to align with sidebars -- docs: mention about CNAME option in publishing docs ([#1227](https://github.com/facebook/Docusaurus/pull/1227)) -- docs: add ScanTrust to users ([#1228](https://github.com/facebook/Docusaurus/pull/1228)) -- chore: upgrade husky to 1.3.1 ([#1229](https://github.com/facebook/Docusaurus/pull/1229)) -- Remove more references to code.facebook.com ([#1231](https://github.com/facebook/Docusaurus/pull/1231)) -- fix: use clean url for og:url when cleanUrl is true ([#1242](https://github.com/facebook/Docusaurus/pull/1242)) -- fix: hovering algolia logo break its background color ([#1240](https://github.com/facebook/Docusaurus/pull/1240)) -- docs: update CaptainDuckDuck to CapRover ([#1244](https://github.com/facebook/Docusaurus/pull/1244)) -- chore: rename siteConfig.js to docusaurus.config.js ([#1245](https://github.com/facebook/Docusaurus/pull/1245)) -- fix: make referenced links work with code block tabs ([#1249](https://github.com/facebook/Docusaurus/pull/1249)) -- docs: showcase user Scalafmt ([#1250](https://github.com/facebook/Docusaurus/pull/1250)) -- fix: wrong sidebar_label and title on versioned_docs ([#1265](https://github.com/facebook/Docusaurus/pull/1265)) -- docs: update api-pages.md to document about overriding default styles ([#1266](https://github.com/facebook/Docusaurus/pull/1266)) -- fix: upgrade jest to remove security vulnerability ([#1276](https://github.com/facebook/Docusaurus/pull/1276)) -- docs: showcase user Microkubes ([#1274](https://github.com/facebook/Docusaurus/pull/1274)) -- docs: showcase user Twirp ([#1275](https://github.com/facebook/Docusaurus/pull/1275)) -- docs: add Polymath to users ([#1276](https://github.com/facebook/Docusaurus/pull/1276)) -- fix: relative path markdown linking on versioned docs ([#1281](https://github.com/facebook/Docusaurus/pull/1281)) -- fix(codetabs): fix key warning ([#1284](https://github.com/facebook/Docusaurus/pull/1284)) +- docs: mention about CNAME option in publishing docs ([#1227](https://github.com/facebook/docusaurus/pull/1227)) +- docs: add ScanTrust to users ([#1228](https://github.com/facebook/docusaurus/pull/1228)) +- chore: upgrade husky to 1.3.1 ([#1229](https://github.com/facebook/docusaurus/pull/1229)) +- Remove more references to code.facebook.com ([#1231](https://github.com/facebook/docusaurus/pull/1231)) +- fix: use clean url for og:url when cleanUrl is true ([#1242](https://github.com/facebook/docusaurus/pull/1242)) +- fix: hovering algolia logo break its background color ([#1240](https://github.com/facebook/docusaurus/pull/1240)) +- docs: update CaptainDuckDuck to CapRover ([#1244](https://github.com/facebook/docusaurus/pull/1244)) +- chore: rename siteConfig.js to docusaurus.config.js ([#1245](https://github.com/facebook/docusaurus/pull/1245)) +- fix: make referenced links work with code block tabs ([#1249](https://github.com/facebook/docusaurus/pull/1249)) +- docs: showcase user Scalafmt ([#1250](https://github.com/facebook/docusaurus/pull/1250)) +- fix: wrong sidebar_label and title on versioned_docs ([#1265](https://github.com/facebook/docusaurus/pull/1265)) +- docs: update api-pages.md to document about overriding default styles ([#1266](https://github.com/facebook/docusaurus/pull/1266)) +- fix: upgrade jest to remove security vulnerability ([#1276](https://github.com/facebook/docusaurus/pull/1276)) +- docs: showcase user Microkubes ([#1274](https://github.com/facebook/docusaurus/pull/1274)) +- docs: showcase user Twirp ([#1275](https://github.com/facebook/docusaurus/pull/1275)) +- docs: add Polymath to users ([#1276](https://github.com/facebook/docusaurus/pull/1276)) +- fix: relative path markdown linking on versioned docs ([#1281](https://github.com/facebook/docusaurus/pull/1281)) +- fix(codetabs): fix key warning ([#1284](https://github.com/facebook/docusaurus/pull/1284)) ## [1.7.2] - 2019-1-28 @@ -213,10 +213,10 @@ Minor fixes and improvements to some of the features introduced in 1.7.0. ### Fixed/Changed -- fix: horizontal overflow in collapsible sidebar ([#1205](https://github.com/facebook/Docusaurus/pull/1205)) -- fix: docs asset links should follow specified docsUrl ([#1204](https://github.com/facebook/Docusaurus/pull/1204)) -- fix: make search bar taller on widescreen ([#1210](https://github.com/facebook/Docusaurus/pull/1210)) -- fix: change sidebar chevron icon to use svg ([#1211](https://github.com/facebook/Docusaurus/pull/1211)) +- fix: horizontal overflow in collapsible sidebar ([#1205](https://github.com/facebook/docusaurus/pull/1205)) +- fix: docs asset links should follow specified docsUrl ([#1204](https://github.com/facebook/docusaurus/pull/1204)) +- fix: make search bar taller on widescreen ([#1210](https://github.com/facebook/docusaurus/pull/1210)) +- fix: change sidebar chevron icon to use svg ([#1211](https://github.com/facebook/docusaurus/pull/1211)) ## [1.7.1] - 2019-1-24 @@ -226,7 +226,7 @@ Minor fixes and improvements to some of the features introduced in 1.7.0. ### Fixed/Changed -- fix: revert image-min back to dependencies ([#1201](https://github.com/facebook/Docusaurus/pull/1201)) +- fix: revert image-min back to dependencies ([#1201](https://github.com/facebook/docusaurus/pull/1201)) ## [1.7.0] - 2019-1-23 @@ -255,22 +255,22 @@ Thank you to the following contributors who helped with this release: ### Fixed/Changed -- fix: edit url should support versioned subdirectories ([#1154](https://github.com/facebook/Docusaurus/pull/1154)) -- fix: gap on mobile devices when scrolling ([#1157](https://github.com/facebook/Docusaurus/pull/1157)) -- chore: update imagemin and its dependencies ([#1162](https://github.com/facebook/Docusaurus/pull/1162)) -- fix: pass docusaurus-publish cli args to build command ([#1185](https://github.com/facebook/Docusaurus/pull/1185)) -- fix: missing default value for grid block content objects ([#1186](https://github.com/facebook/Docusaurus/pull/1186)) -- fix: add margin-bottom: 0 to blog post author ([#1193](https://github.com/facebook/Docusaurus/pull/1193)) -- fix: wrong padding for single row mobile nav ([#1191](https://github.com/facebook/Docusaurus/pull/1191)) +- fix: edit url should support versioned subdirectories ([#1154](https://github.com/facebook/docusaurus/pull/1154)) +- fix: gap on mobile devices when scrolling ([#1157](https://github.com/facebook/docusaurus/pull/1157)) +- chore: update imagemin and its dependencies ([#1162](https://github.com/facebook/docusaurus/pull/1162)) +- fix: pass docusaurus-publish cli args to build command ([#1185](https://github.com/facebook/docusaurus/pull/1185)) +- fix: missing default value for grid block content objects ([#1186](https://github.com/facebook/docusaurus/pull/1186)) +- fix: add margin-bottom: 0 to blog post author ([#1193](https://github.com/facebook/docusaurus/pull/1193)) +- fix: wrong padding for single row mobile nav ([#1191](https://github.com/facebook/docusaurus/pull/1191)) ### Added -- feat: collapsible categories ([#1128](https://github.com/facebook/Docusaurus/pull/1128)) -- feat: code block tab ([#1063](https://github.com/facebook/Docusaurus/pull/1063)) +- feat: collapsible categories ([#1128](https://github.com/facebook/docusaurus/pull/1128)) +- feat: code block tab ([#1063](https://github.com/facebook/docusaurus/pull/1063)) ## [1.6.2] - 2018-12-7 -Hotfix for 1.6.1. We overlooked a critical bug caused by hardcoded path on PR [#1143](https://github.com/facebook/Docusaurus/pull/1143). Please upgrade to 1.6.2, we are going to npm deprecate 1.6.1. +Hotfix for 1.6.1. We overlooked a critical bug caused by hardcoded path on PR [#1143](https://github.com/facebook/docusaurus/pull/1143). Please upgrade to 1.6.2, we are going to npm deprecate 1.6.1. ## [1.6.1] - 2018-12-7 @@ -287,13 +287,13 @@ Thank you to the following contributors who helped with this release: ### Fixed/Changed -- Fix docusaurus-version compilation error for subdirectory ([cb1395](https://github.com/facebook/Docusaurus/commit/cb1395ee29364866767e3e6e701d4e1575dad4cc)) -- Fix relative path markdown linking ([#1138](https://github.com/facebook/Docusaurus/pull/1138)) -- Fix static files in `blog/assets` not working ([#1143](https://github.com/facebook/Docusaurus/pull/1143)) +- Fix docusaurus-version compilation error for subdirectory ([cb1395](https://github.com/facebook/docusaurus/commit/cb1395ee29364866767e3e6e701d4e1575dad4cc)) +- Fix relative path markdown linking ([#1138](https://github.com/facebook/docusaurus/pull/1138)) +- Fix static files in `blog/assets` not working ([#1143](https://github.com/facebook/docusaurus/pull/1143)) ### Added -- Allow custom commit message for publish-gh-pages ([#1136](https://github.com/facebook/Docusaurus/pull/1136)) +- Allow custom commit message for publish-gh-pages ([#1136](https://github.com/facebook/docusaurus/pull/1136)) ## [1.6.0] - 2018-12-1 @@ -320,23 +320,23 @@ Thank you to the following contributors who helped with this release: ### Fixed/Changed -- Live reload not working on second try ([#1103](https://github.com/facebook/Docusaurus/pull/1103)) -- Fix missing TOC on i18n pages ([#1119](https://github.com/facebook/Docusaurus/pull/1119)) -- Fix docusaurus-version not working for subcategory in sidebar ([#1124](https://github.com/facebook/Docusaurus/pull/1124)) -- Fix docusaurus-version to allow duplicate id in different subdirectory ([#1125](https://github.com/facebook/Docusaurus/pull/1125)) +- Live reload not working on second try ([#1103](https://github.com/facebook/docusaurus/pull/1103)) +- Fix missing TOC on i18n pages ([#1119](https://github.com/facebook/docusaurus/pull/1119)) +- Fix docusaurus-version not working for subcategory in sidebar ([#1124](https://github.com/facebook/docusaurus/pull/1124)) +- Fix docusaurus-version to allow duplicate id in different subdirectory ([#1125](https://github.com/facebook/docusaurus/pull/1125)) ## Docs -- Add guide on setting custom docs path ([#1098](https://github.com/facebook/Docusaurus/pull/1098)) -- Document that `website` folder can be renamed ([#1106](https://github.com/facebook/Docusaurus/pull/1106)) -- Specify markdown flavor ([#1118](https://github.com/facebook/Docusaurus/pull/1118)) +- Add guide on setting custom docs path ([#1098](https://github.com/facebook/docusaurus/pull/1098)) +- Document that `website` folder can be renamed ([#1106](https://github.com/facebook/docusaurus/pull/1106)) +- Specify markdown flavor ([#1118](https://github.com/facebook/docusaurus/pull/1118)) ### Added -- Allow modifying/removing `docs` route in generated url ([#914](https://github.com/facebook/Docusaurus/pull/914)) -- Use `sidebar_label` in addition to `title` for prev/next button ([#1122](https://github.com/facebook/Docusaurus/pull/1122)) -- Warn the users if any unresolved markdown links ([#1116](https://github.com/facebook/Docusaurus/pull/1116)) -- Customizable search placeholder ([#1126](https://github.com/facebook/Docusaurus/pull/1126)) +- Allow modifying/removing `docs` route in generated url ([#914](https://github.com/facebook/docusaurus/pull/914)) +- Use `sidebar_label` in addition to `title` for prev/next button ([#1122](https://github.com/facebook/docusaurus/pull/1122)) +- Warn the users if any unresolved markdown links ([#1116](https://github.com/facebook/docusaurus/pull/1116)) +- Customizable search placeholder ([#1126](https://github.com/facebook/docusaurus/pull/1126)) ## [1.5.1] - 2018-11-03 @@ -370,17 +370,17 @@ Thank you to the following contributors who helped with this release: ### Fixed/Changed -- Throw error when forgot to pass in GIT_USER ([#1035](https://github.com/facebook/Docusaurus/pull/1035)) -- Exclude file movements for last updated time ([#1023](https://github.com/facebook/Docusaurus/pull/1023)) -- Update support for Web App Manifest ([#1046](https://github.com/facebook/Docusaurus/pull/1046)) -- Render proper HTML instead of raw markdown in og:description ([#1054](https://github.com/facebook/Docusaurus/pull/1054)) +- Throw error when forgot to pass in GIT_USER ([#1035](https://github.com/facebook/docusaurus/pull/1035)) +- Exclude file movements for last updated time ([#1023](https://github.com/facebook/docusaurus/pull/1023)) +- Update support for Web App Manifest ([#1046](https://github.com/facebook/docusaurus/pull/1046)) +- Render proper HTML instead of raw markdown in og:description ([#1054](https://github.com/facebook/docusaurus/pull/1054)) ### Added -- New feature of displaying the last contributor to each document ([#980](https://github.com/facebook/Docusaurus/pull/980)) -- Document how to add "Copy" button to code blocks ([#1047](https://github.com/facebook/Docusaurus/pull/1047)) -- Support reference-style linking in documents ([#1048](https://github.com/facebook/Docusaurus/pull/1048)) -- Add caption to user page links ([#1075](https://github.com/facebook/Docusaurus/pull/1075)) +- New feature of displaying the last contributor to each document ([#980](https://github.com/facebook/docusaurus/pull/980)) +- Document how to add "Copy" button to code blocks ([#1047](https://github.com/facebook/docusaurus/pull/1047)) +- Support reference-style linking in documents ([#1048](https://github.com/facebook/docusaurus/pull/1048)) +- Add caption to user page links ([#1075](https://github.com/facebook/docusaurus/pull/1075)) ### Removed @@ -408,21 +408,21 @@ Thank you to the following contributors who helped with this release: ### Fixed/Changed -- Use dark mode color scheme for footer like button ([#959](https://github.com/facebook/Docusaurus/pull/959)) -- Fix highlightjs custom highlighting function ([#1016](https://github.com/facebook/Docusaurus/pull/1016)) +- Use dark mode color scheme for footer like button ([#959](https://github.com/facebook/docusaurus/pull/959)) +- Fix highlightjs custom highlighting function ([#1016](https://github.com/facebook/docusaurus/pull/1016)) ### Added -- Live reload port fallback if port is used ([#899](https://github.com/facebook/Docusaurus/pull/899)) -- Added option for client to include their own remarkable config ([#974](https://github.com/facebook/Docusaurus/pull/974)) -- Enabled subcategories in sidebar ([#892](https://github.com/facebook/Docusaurus/pull/892)) ([#1026](https://github.com/facebook/Docusaurus/pull/1026)) -- Add keyboard shortcut to focus on search box ([#1028](https://github.com/facebook/Docusaurus/pull/1028)) +- Live reload port fallback if port is used ([#899](https://github.com/facebook/docusaurus/pull/899)) +- Added option for client to include their own remarkable config ([#974](https://github.com/facebook/docusaurus/pull/974)) +- Enabled subcategories in sidebar ([#892](https://github.com/facebook/docusaurus/pull/892)) ([#1026](https://github.com/facebook/docusaurus/pull/1026)) +- Add keyboard shortcut to focus on search box ([#1028](https://github.com/facebook/docusaurus/pull/1028)) ### Chore and Maintenance -- Upgrade to babel 7 for v1 ([#995](https://github.com/facebook/Docusaurus/pull/995)) -- Fix typo in Getting Started docs ([#1013](https://github.com/facebook/Docusaurus/pull/1013)) -- Reorganized siteConfig ([#1027](https://github.com/facebook/Docusaurus/pull/1027)) +- Upgrade to babel 7 for v1 ([#995](https://github.com/facebook/docusaurus/pull/995)) +- Fix typo in Getting Started docs ([#1013](https://github.com/facebook/docusaurus/pull/1013)) +- Reorganized siteConfig ([#1027](https://github.com/facebook/docusaurus/pull/1027)) ## [1.4.0] - 2018-09-11 @@ -446,28 +446,28 @@ Thank you to the following contributors who helped with this release: ### Fixed/Changed -- Fix nested `static` in `static` folder breaks build ([#953](https://github.com/facebook/Docusaurus/pull/953)) -- Fix `cleanUrl` transformation unintentionally removing extension ([#923](https://github.com/facebook/Docusaurus/pull/923)) -- Fix conflicting strings in translations ([#917](https://github.com/facebook/Docusaurus/pull/917)) -- Header navigation now links to `blog/`, not `blog` ([#936](https://github.com/facebook/Docusaurus/pull/936)) -- Fix button wrapping behavior on mobile ([#921](https://github.com/facebook/Docusaurus/pull/921)) -- Fix wrong header navigation linking to a doc without translation ([f1daddb](https://github.com/facebook/Docusaurus/commit/f1daddb5f9a2965b45045ad9ef8f7a4494b71e30)) -- Fixed navigation so that it takes full width on a docs ([#935](https://github.com/facebook/Docusaurus/pull/935)) +- Fix nested `static` in `static` folder breaks build ([#953](https://github.com/facebook/docusaurus/pull/953)) +- Fix `cleanUrl` transformation unintentionally removing extension ([#923](https://github.com/facebook/docusaurus/pull/923)) +- Fix conflicting strings in translations ([#917](https://github.com/facebook/docusaurus/pull/917)) +- Header navigation now links to `blog/`, not `blog` ([#936](https://github.com/facebook/docusaurus/pull/936)) +- Fix button wrapping behavior on mobile ([#921](https://github.com/facebook/docusaurus/pull/921)) +- Fix wrong header navigation linking to a doc without translation ([f1daddb](https://github.com/facebook/docusaurus/commit/f1daddb5f9a2965b45045ad9ef8f7a4494b71e30)) +- Fixed navigation so that it takes full width on a docs ([#935](https://github.com/facebook/docusaurus/pull/935)) ### Added -- Allow user to add `last updated time` info on doc ([#913](https://github.com/facebook/Docusaurus/pull/913)) -- Support for user's own Web App Manifest in siteConfig ([#934](https://github.com/facebook/Docusaurus/pull/934)) -- Add docker file & documentation ([#936](https://github.com/facebook/Docusaurus/pull/936)) -- New docusaurus project has a better starting README ([#930](https://github.com/facebook/Docusaurus/pull/930)) -- Enable passing object to script and link ([#937](https://github.com/facebook/Docusaurus/pull/937)) +- Allow user to add `last updated time` info on doc ([#913](https://github.com/facebook/docusaurus/pull/913)) +- Support for user's own Web App Manifest in siteConfig ([#934](https://github.com/facebook/docusaurus/pull/934)) +- Add docker file & documentation ([#936](https://github.com/facebook/docusaurus/pull/936)) +- New docusaurus project has a better starting README ([#930](https://github.com/facebook/docusaurus/pull/930)) +- Enable passing object to script and link ([#937](https://github.com/facebook/docusaurus/pull/937)) ### Chore and Maintenance -- New template for `Documentation` issue ([39b7793](https://github.com/facebook/Docusaurus/commit/39b77935c41f400a0f1478c5163db6b8acb6f47c)) -- Add new blog post about upcoming Docusaurus 2 ([#952](https://github.com/facebook/Docusaurus/pull/952)) -- Fix broken sponsor images in README ([#951](https://github.com/facebook/Docusaurus/pull/951)) -- Fix wrong user image URL ([89f49b0](https://github.com/facebook/Docusaurus/commit/89f49b02c8f1595b0e386ce778ed1271ec9f30c6)) +- New template for `Documentation` issue ([39b7793](https://github.com/facebook/docusaurus/commit/39b77935c41f400a0f1478c5163db6b8acb6f47c)) +- Add new blog post about upcoming Docusaurus 2 ([#952](https://github.com/facebook/docusaurus/pull/952)) +- Fix broken sponsor images in README ([#951](https://github.com/facebook/docusaurus/pull/951)) +- Fix wrong user image URL ([89f49b0](https://github.com/facebook/docusaurus/commit/89f49b02c8f1595b0e386ce778ed1271ec9f30c6)) ## [1.3.3] - 2018-08-22 @@ -497,42 +497,42 @@ Thank you to the following contributors who helped with this release: **Added** -- Add autoprefixing to CSS pipeline [\#867](https://github.com/facebook/Docusaurus/pull/867) -- Support `text` language for code block style without any highlighting [\#875](https://github.com/facebook/Docusaurus/pull/875) +- Add autoprefixing to CSS pipeline [\#867](https://github.com/facebook/docusaurus/pull/867) +- Support `text` language for code block style without any highlighting [\#875](https://github.com/facebook/docusaurus/pull/875) **Fixed/Changed** -- Fix wrong CSS language prefix for fenced blocks [\#842](https://github.com/facebook/Docusaurus/pull/842) [\#870](https://github.com/facebook/Docusaurus/pull/870) -- Fix phrase emphasis not italicized [\#850](https://github.com/facebook/Docusaurus/pull/850) -- Don't replace static assets linking in fenced code blocks [\#864](https://github.com/facebook/Docusaurus/pull/864) -- Blogpost summary for blog feed is now properly truncated [\#880](https://github.com/facebook/Docusaurus/pull/880) -- Fix failure to copy static image if image compression fail [\#887](https://github.com/facebook/Docusaurus/pull/887) -- Fix: correct docs linking for custom `defaultVersionShown` [\#894](https://github.com/facebook/Docusaurus/pull/894) -- Fix incorrect sitemap url for non default baseUrl [\#902](https://github.com/facebook/Docusaurus/pull/902) -- Stricter `css/main.css` routing on development server [\#904](https://github.com/facebook/Docusaurus/pull/904) -- Fix console error when onPageNav !== 'separate' [\#909](https://github.com/facebook/Docusaurus/pull/909) +- Fix wrong CSS language prefix for fenced blocks [\#842](https://github.com/facebook/docusaurus/pull/842) [\#870](https://github.com/facebook/docusaurus/pull/870) +- Fix phrase emphasis not italicized [\#850](https://github.com/facebook/docusaurus/pull/850) +- Don't replace static assets linking in fenced code blocks [\#864](https://github.com/facebook/docusaurus/pull/864) +- Blogpost summary for blog feed is now properly truncated [\#880](https://github.com/facebook/docusaurus/pull/880) +- Fix failure to copy static image if image compression fail [\#887](https://github.com/facebook/docusaurus/pull/887) +- Fix: correct docs linking for custom `defaultVersionShown` [\#894](https://github.com/facebook/docusaurus/pull/894) +- Fix incorrect sitemap url for non default baseUrl [\#902](https://github.com/facebook/docusaurus/pull/902) +- Stricter `css/main.css` routing on development server [\#904](https://github.com/facebook/docusaurus/pull/904) +- Fix console error when onPageNav !== 'separate' [\#909](https://github.com/facebook/docusaurus/pull/909) **Docs** -- Add documentation regarding usage of nested docs/ subdirectory [\#860](https://github.com/facebook/Docusaurus/pull/860) -- Improve baseUrl documentation with an example [\#863](https://github.com/facebook/Docusaurus/pull/863) -- Fix Table of contents documentation typo [\#873](https://github.com/facebook/Docusaurus/pull/873) -- Update installation doc [\#888](https://github.com/facebook/Docusaurus/pull/888) [\#900](https://github.com/facebook/Docusaurus/pull/900) -- Update guides-translations.md for CircleCI 2.0 [92f95d](https://github.com/facebook/Docusaurus/commit/92f95df934ab4034c49d66cd82ad5dbbcdee508d) +- Add documentation regarding usage of nested docs/ subdirectory [\#860](https://github.com/facebook/docusaurus/pull/860) +- Improve baseUrl documentation with an example [\#863](https://github.com/facebook/docusaurus/pull/863) +- Fix Table of contents documentation typo [\#873](https://github.com/facebook/docusaurus/pull/873) +- Update installation doc [\#888](https://github.com/facebook/docusaurus/pull/888) [\#900](https://github.com/facebook/docusaurus/pull/900) +- Update guides-translations.md for CircleCI 2.0 [92f95d](https://github.com/facebook/docusaurus/commit/92f95df934ab4034c49d66cd82ad5dbbcdee508d) **Chore and Maintenance** -- Add ESLint [\#836](https://github.com/facebook/Docusaurus/pull/836) [\#837](https://github.com/facebook/Docusaurus/pull/837) [\#841](https://github.com/facebook/Docusaurus/pull/841) [\#846](https://github.com/facebook/Docusaurus/pull/846) -- Refactor & add more tests for Docusaurus [\#839](https://github.com/facebook/Docusaurus/pull/839) [\#847](https://github.com/facebook/Docusaurus/pull/847) [\#854](https://github.com/facebook/Docusaurus/pull/854) [\#856](https://github.com/facebook/Docusaurus/pull/856) -- Docusaurus own search will now search the docs in the correct language & version [\#859](https://github.com/facebook/Docusaurus/pull/859) -- Improve readme [\#866](https://github.com/facebook/Docusaurus/pull/866) -- Add prerelease script for Docusaurus [\#876](https://github.com/facebook/Docusaurus/pull/876) -- Remove unused files [\#881](https://github.com/facebook/Docusaurus/pull/881) -- Update code of conduct [3c1363d](https://github.com/facebook/Docusaurus/commit/3c1363da1bd445029d7034b0575f69a7077321c3) -- Update jest to v23 [\#885](https://github.com/facebook/Docusaurus/pull/885) -- Activating Open Collective [\#883](https://github.com/facebook/Docusaurus/pull/883) -- Fix Jest tests that fail on Windows [\#896](https://github.com/facebook/Docusaurus/pull/896) -- Rename Sonar to Flipper [\#905](https://github.com/facebook/Docusaurus/pull/905) +- Add ESLint [\#836](https://github.com/facebook/docusaurus/pull/836) [\#837](https://github.com/facebook/docusaurus/pull/837) [\#841](https://github.com/facebook/docusaurus/pull/841) [\#846](https://github.com/facebook/docusaurus/pull/846) +- Refactor & add more tests for Docusaurus [\#839](https://github.com/facebook/docusaurus/pull/839) [\#847](https://github.com/facebook/docusaurus/pull/847) [\#854](https://github.com/facebook/docusaurus/pull/854) [\#856](https://github.com/facebook/docusaurus/pull/856) +- Docusaurus own search will now search the docs in the correct language & version [\#859](https://github.com/facebook/docusaurus/pull/859) +- Improve readme [\#866](https://github.com/facebook/docusaurus/pull/866) +- Add prerelease script for Docusaurus [\#876](https://github.com/facebook/docusaurus/pull/876) +- Remove unused files [\#881](https://github.com/facebook/docusaurus/pull/881) +- Update code of conduct [3c1363d](https://github.com/facebook/docusaurus/commit/3c1363da1bd445029d7034b0575f69a7077321c3) +- Update jest to v23 [\#885](https://github.com/facebook/docusaurus/pull/885) +- Activating Open Collective [\#883](https://github.com/facebook/docusaurus/pull/883) +- Fix Jest tests that fail on Windows [\#896](https://github.com/facebook/docusaurus/pull/896) +- Rename Sonar to Flipper [\#905](https://github.com/facebook/docusaurus/pull/905) ## [1.3.2] - 2018-07-06 @@ -566,14 +566,14 @@ Thank you to the following contributors who helped with this release: ### Fixed/Changed -- Algolia will search using the [correct version](https://github.com/facebook/Docusaurus/commit/9ff5328c88706d2025fd14c274c14d17712fa048) instead of always using the current. -- Directory tree printing during initialization will now [exclude `vendor`](https://github.com/facebook/Docusaurus/commit/5a8e9a9ff11a74e4913c5d1f272aa8fc4c67e9c3), a common third-party directory for PHP projects. -- Fix a bug in the [routing](https://github.com/facebook/Docusaurus/commit/66b2033546a6ad20146d5f81b115d6f080b98e89) for docs and blogs. -- Sidebar scrollbar will [only appear](https://github.com/facebook/Docusaurus/commit/e4b9b9861b0374790b19f3f84f51ee34f8710f68) when it is longer than the height of the page. -- Prevent the page from [scrolling to top](https://github.com/facebook/Docusaurus/commit/76870c6a3780323d364da9b9c52502ab4c979378) when clicking the languages button. -- Fix [incorrect sitemap URLs](https://github.com/facebook/Docusaurus/commit/418c840ad4524cb286ec04842ffa5d474feed1d2). -- Fix a bug where [promise errors get swallowed](https://github.com/facebook/Docusaurus/commit/f598e2583f73cc5e77b994f9ace027012852cd49), causing CIs to think that the command was successful when it isn't. -- Fix some [newly discovered issues](https://github.com/facebook/Docusaurus/commit/0b10b193a83dc8ea792e84ffae2a082b895689cb) with the CSS revamp introduced in 1.3.0. +- Algolia will search using the [correct version](https://github.com/facebook/docusaurus/commit/9ff5328c88706d2025fd14c274c14d17712fa048) instead of always using the current. +- Directory tree printing during initialization will now [exclude `vendor`](https://github.com/facebook/docusaurus/commit/5a8e9a9ff11a74e4913c5d1f272aa8fc4c67e9c3), a common third-party directory for PHP projects. +- Fix a bug in the [routing](https://github.com/facebook/docusaurus/commit/66b2033546a6ad20146d5f81b115d6f080b98e89) for docs and blogs. +- Sidebar scrollbar will [only appear](https://github.com/facebook/docusaurus/commit/e4b9b9861b0374790b19f3f84f51ee34f8710f68) when it is longer than the height of the page. +- Prevent the page from [scrolling to top](https://github.com/facebook/docusaurus/commit/76870c6a3780323d364da9b9c52502ab4c979378) when clicking the languages button. +- Fix [incorrect sitemap URLs](https://github.com/facebook/docusaurus/commit/418c840ad4524cb286ec04842ffa5d474feed1d2). +- Fix a bug where [promise errors get swallowed](https://github.com/facebook/docusaurus/commit/f598e2583f73cc5e77b994f9ace027012852cd49), causing CIs to think that the command was successful when it isn't. +- Fix some [newly discovered issues](https://github.com/facebook/docusaurus/commit/0b10b193a83dc8ea792e84ffae2a082b895689cb) with the CSS revamp introduced in 1.3.0. ## [1.3.0] - 2018-06-20 @@ -599,8 +599,8 @@ Thank you to the following contributors who helped with this release: ### Fixed/Changed -- The search input will now search the docs in the [correct language](https://github.com/facebook/Docusaurus/commit/df429262429e449e78745423ff2c9ab6c6fd1d5c). -- Algolia will be able to scrap emulti-language and/or versioned sites better with the introduction of [special meta tags](https://github.com/facebook/Docusaurus/commit/0eb6612b58a6ee93d5de715f87201eb9fabc82c2). +- The search input will now search the docs in the [correct language](https://github.com/facebook/docusaurus/commit/df429262429e449e78745423ff2c9ab6c6fd1d5c). +- Algolia will be able to scrap emulti-language and/or versioned sites better with the introduction of [special meta tags](https://github.com/facebook/docusaurus/commit/0eb6612b58a6ee93d5de715f87201eb9fabc82c2). ### Added @@ -634,22 +634,22 @@ Thank you to the following contributors who helped with this release: ### Breaking changes -- This may not affect many users, but if you modified the `en.json` to add your own custom translation strings, we [changed](https://github.com/facebook/Docusaurus/commit/608e2c85a21cd17d9f45496a479ec82f5620a48a) how this is handled, and you will need to [follow the instructions here](https://docusaurus.io/docs/en/translation#custom-translation-strings) to modify your setup. +- This may not affect many users, but if you modified the `en.json` to add your own custom translation strings, we [changed](https://github.com/facebook/docusaurus/commit/608e2c85a21cd17d9f45496a479ec82f5620a48a) how this is handled, and you will need to [follow the instructions here](https://docusaurus.io/docs/en/translation#custom-translation-strings) to modify your setup. ### Added -- Option to [disable](https://github.com/facebook/Docusaurus/commit/62a2c7c1a599ccaf04a86e9ca2ec0fbca5220f5c) live reload during development. -- Configuration options for [changing](https://github.com/facebook/Docusaurus/commit/58fba70dead064e8c6910e07d3523a548258022f) the title of the blog sidebar info. -- Better support and [documentation](https://docusaurus.io/docs/en/publishing#using-github-pages) for [cross-repo publishing](https://github.com/facebook/Docusaurus/commit/fd9a3ffb6deca84b41dc5a3b43b0db1ca4f3143e). +- Option to [disable](https://github.com/facebook/docusaurus/commit/62a2c7c1a599ccaf04a86e9ca2ec0fbca5220f5c) live reload during development. +- Configuration options for [changing](https://github.com/facebook/docusaurus/commit/58fba70dead064e8c6910e07d3523a548258022f) the title of the blog sidebar info. +- Better support and [documentation](https://docusaurus.io/docs/en/publishing#using-github-pages) for [cross-repo publishing](https://github.com/facebook/docusaurus/commit/fd9a3ffb6deca84b41dc5a3b43b0db1ca4f3143e). ### Fixed/Changed -- 1.2.0 introduced a bug where you could not update documentation metadata without deleting `en.json`. This has been [fixed](https://github.com/facebook/Docusaurus/commit/608e2c85a21cd17d9f45496a479ec82f5620a48a) as part of the custom translation string breaking change. -- Absolute URLs are now [used](https://github.com/facebook/Docusaurus/commit/0f01eace8be1be273a63089a14d1e3ea2d2cae57) instead of relative URLs for documentation linking to avoid trailing slash issues. +- 1.2.0 introduced a bug where you could not update documentation metadata without deleting `en.json`. This has been [fixed](https://github.com/facebook/docusaurus/commit/608e2c85a21cd17d9f45496a479ec82f5620a48a) as part of the custom translation string breaking change. +- Absolute URLs are now [used](https://github.com/facebook/docusaurus/commit/0f01eace8be1be273a63089a14d1e3ea2d2cae57) instead of relative URLs for documentation linking to avoid trailing slash issues. - If you have had trouble updating Docusaurus, it may have been your [Babel cache](https://docusaurus.io/docs/en/installation#updating-your-docusaurus-version). -- No more errors if heading anchors are [empty](https://github.com/facebook/Docusaurus/commit/371fdda4a8c82b5f29dd5c2dd9f04c8ef28dd025). -- Fixed bug when [renaming version](https://github.com/facebook/Docusaurus/commit/a2b076bdcaf7099e595f2f106b38dd0cabeee1ef) where `sidebars.json` were not getting updated. -- Table of contents are now [hidden](https://github.com/facebook/Docusaurus/commit/7bef1b96dc8de8c42795b0983195f66a7ae78c27) when `onPageNav` is not separate. +- No more errors if heading anchors are [empty](https://github.com/facebook/docusaurus/commit/371fdda4a8c82b5f29dd5c2dd9f04c8ef28dd025). +- Fixed bug when [renaming version](https://github.com/facebook/docusaurus/commit/a2b076bdcaf7099e595f2f106b38dd0cabeee1ef) where `sidebars.json` were not getting updated. +- Table of contents are now [hidden](https://github.com/facebook/docusaurus/commit/7bef1b96dc8de8c42795b0983195f66a7ae78c27) when `onPageNav` is not separate. ### Removed @@ -685,29 +685,29 @@ None that we know of. Please let us know if you find any as this is a big releas ### Added -- Sub-directories are now [supported](https://github.com/facebook/Docusaurus/commit/d04b3ca87bb371dd47e6b69a863306ee5f2b1840) for documentation. This was one of most [requested features](https://github.com/facebook/Docusaurus/pull/705). -- You can now use [Prism for syntax highlighting](https://github.com/facebook/Docusaurus/commit/c8bc00a3a78f6db8f9a9e22aaaf63f56a00cc2ac), in addition to Highlight.js. [Documentation](https://docusaurus.io/docs/en/doc-markdown#using-prism-as-additional-syntax-highlighter) -- URLs can now be ["clean"](https://github.com/facebook/Docusaurus/commit/31f0c27f81ac9d22f8fdd29f5265e60b5b038773) - no `.html` extension. -- Scroll to top button [option](https://github.com/facebook/Docusaurus/commit/aee255219bedc97b55048cdb4703742cbb7c247e) for your documentation pages. -- Can now [set title](https://github.com/facebook/Docusaurus/commit/72f4f369394a9ccdcd721c4f2fa0ee2913ad98dd) for custom pages. [Documentation](https://docusaurus.io/docs/en/api-pages#titles-for-pages) -- On page [navigation](https://github.com/facebook/Docusaurus/commit/49c27b733bf62506acff3c55f92143dc0ef3ed86) for blog posts. +- Sub-directories are now [supported](https://github.com/facebook/docusaurus/commit/d04b3ca87bb371dd47e6b69a863306ee5f2b1840) for documentation. This was one of most [requested features](https://github.com/facebook/docusaurus/pull/705). +- You can now use [Prism for syntax highlighting](https://github.com/facebook/docusaurus/commit/c8bc00a3a78f6db8f9a9e22aaaf63f56a00cc2ac), in addition to Highlight.js. [Documentation](https://docusaurus.io/docs/en/doc-markdown#using-prism-as-additional-syntax-highlighter) +- URLs can now be ["clean"](https://github.com/facebook/docusaurus/commit/31f0c27f81ac9d22f8fdd29f5265e60b5b038773) - no `.html` extension. +- Scroll to top button [option](https://github.com/facebook/docusaurus/commit/aee255219bedc97b55048cdb4703742cbb7c247e) for your documentation pages. +- Can now [set title](https://github.com/facebook/docusaurus/commit/72f4f369394a9ccdcd721c4f2fa0ee2913ad98dd) for custom pages. [Documentation](https://docusaurus.io/docs/en/api-pages#titles-for-pages) +- On page [navigation](https://github.com/facebook/docusaurus/commit/49c27b733bf62506acff3c55f92143dc0ef3ed86) for blog posts. - Travis CI [publishing](https://docusaurus.io/docs/en/publishing#using-travis-ci) guide. -- Can now publish to [GitHub Enterprise](https://github.com/facebook/Docusaurus/commit/2bd9a148c160a0f0de9ab991c66393c629469c37). +- Can now publish to [GitHub Enterprise](https://github.com/facebook/docusaurus/commit/2bd9a148c160a0f0de9ab991c66393c629469c37). ### Fixed/Changed -- For better SEO, we now [support](https://github.com/facebook/Docusaurus/commit/c47af6be4b4436f5d9c325b896027e4db3a2d331) `meta:description`. -- Existing translation files are now [loaded](https://github.com/facebook/Docusaurus/commit/49a5263d62ea58ef1aa4e952e5ed6ec44e4a0b28) correctly. -- URLs properly [resolve](https://github.com/facebook/Docusaurus/commit/ff93ba985397804741d4f1e31cfb5219e998cec1) no matter which language you are currently viewing. -- Atom and RSS feed links are [fixed](https://github.com/facebook/Docusaurus/commit/8e58d2e90373e0b2d5373ff875e052f430370a69) for `xxx.github.io` sites. -- Version pages [link](https://github.com/facebook/Docusaurus/commit/c000aca61f935eb94999e9c46077d106cca22275) to the correct language, depending on the current language. -- Do not [start server](https://github.com/facebook/Docusaurus/commit/d28b864a59fabeea45add8c090a13de7d0530de5) if `versions.js` is missing and versioning is enabled. -- [Fail](https://github.com/facebook/Docusaurus/commit/93b2ebb53b49f4c2ba84dcb9b7c98f58dc05ad46) properly when current branch is the same as the deployment one. -- Assets not found bug [fixed](https://github.com/facebook/Docusaurus/commit/b00e9d14e211e42851ede645ecc1e325120c4e3e) in Windows. -- OnPageNav now [works](https://github.com/facebook/Docusaurus/commit/3ff24c7926f06e10bf33eba7d1c86f18087e793a) on mobile devices. -- [Remove](https://github.com/facebook/Docusaurus/commit/b3d59f8a0f7aee606dde0eb7fea9d9d613f34087) extra padding in code blocks. -- Better [gitignore](https://github.com/facebook/Docusaurus/commit/767cd88d8655ddf81c1975b7850401dacf07908a) for `docusaurus-init` -- Documentation fixes: [1](https://github.com/facebook/Docusaurus/commit/52729446261f61fa091d2f4909e9435abb0af645)[2](https://github.com/facebook/Docusaurus/commit/6244bb1aa452c5b98c3f768c0a311cf7f52cb5a8)[3](https://github.com/facebook/Docusaurus/commit/e5ff417cd19a4d9c353c2a054a42cf75d5df9228). +- For better SEO, we now [support](https://github.com/facebook/docusaurus/commit/c47af6be4b4436f5d9c325b896027e4db3a2d331) `meta:description`. +- Existing translation files are now [loaded](https://github.com/facebook/docusaurus/commit/49a5263d62ea58ef1aa4e952e5ed6ec44e4a0b28) correctly. +- URLs properly [resolve](https://github.com/facebook/docusaurus/commit/ff93ba985397804741d4f1e31cfb5219e998cec1) no matter which language you are currently viewing. +- Atom and RSS feed links are [fixed](https://github.com/facebook/docusaurus/commit/8e58d2e90373e0b2d5373ff875e052f430370a69) for `xxx.github.io` sites. +- Version pages [link](https://github.com/facebook/docusaurus/commit/c000aca61f935eb94999e9c46077d106cca22275) to the correct language, depending on the current language. +- Do not [start server](https://github.com/facebook/docusaurus/commit/d28b864a59fabeea45add8c090a13de7d0530de5) if `versions.js` is missing and versioning is enabled. +- [Fail](https://github.com/facebook/docusaurus/commit/93b2ebb53b49f4c2ba84dcb9b7c98f58dc05ad46) properly when current branch is the same as the deployment one. +- Assets not found bug [fixed](https://github.com/facebook/docusaurus/commit/b00e9d14e211e42851ede645ecc1e325120c4e3e) in Windows. +- OnPageNav now [works](https://github.com/facebook/docusaurus/commit/3ff24c7926f06e10bf33eba7d1c86f18087e793a) on mobile devices. +- [Remove](https://github.com/facebook/docusaurus/commit/b3d59f8a0f7aee606dde0eb7fea9d9d613f34087) extra padding in code blocks. +- Better [gitignore](https://github.com/facebook/docusaurus/commit/767cd88d8655ddf81c1975b7850401dacf07908a) for `docusaurus-init` +- Documentation fixes: [1](https://github.com/facebook/docusaurus/commit/52729446261f61fa091d2f4909e9435abb0af645)[2](https://github.com/facebook/docusaurus/commit/6244bb1aa452c5b98c3f768c0a311cf7f52cb5a8)[3](https://github.com/facebook/docusaurus/commit/e5ff417cd19a4d9c353c2a054a42cf75d5df9228). ### Removed @@ -728,9 +728,9 @@ Thank you to the following contributors who helped with this release: ### Fixed/Changed -- If you already have a tab with the Docusaurus website open, restarting the server will [not open a new browser tab](https://github.com/facebook/Docusaurus/commit/407636a4d92b23fe59c31bbc58a0e3416d91f01f). -- Updated [directory tree display](https://github.com/facebook/Docusaurus/commit/454e3d359f786069f83a5bfe2687e304f1f0547f) for a newly-generated site. -- [Don't watch `node_modules`](https://github.com/facebook/Docusaurus/commit/b5fd7bae738ac14d702e80bd3764fee94e0a8e93) in dev server mode. +- If you already have a tab with the Docusaurus website open, restarting the server will [not open a new browser tab](https://github.com/facebook/docusaurus/commit/407636a4d92b23fe59c31bbc58a0e3416d91f01f). +- Updated [directory tree display](https://github.com/facebook/docusaurus/commit/454e3d359f786069f83a5bfe2687e304f1f0547f) for a newly-generated site. +- [Don't watch `node_modules`](https://github.com/facebook/docusaurus/commit/b5fd7bae738ac14d702e80bd3764fee94e0a8e93) in dev server mode. ## [1.1.3] - 2018-05-23 @@ -747,7 +747,7 @@ Thank you to the following contributors who helped with this release: ### Fixed/Changed -- `onPageNav` now [shows](https://github.com/facebook/Docusaurus/commit/2c74d937607fcd84677be5d6990ca2a3b4ba8d7a) in Safari. +- `onPageNav` now [shows](https://github.com/facebook/docusaurus/commit/2c74d937607fcd84677be5d6990ca2a3b4ba8d7a) in Safari. ## [1.1.2] - 2018-05-21 @@ -759,15 +759,15 @@ HOTFIX release. Dependency bug found. ### Fixed/Changed -- `opn` needs to be [installed](https://github.com/facebook/Docusaurus/commit/923356e312687cae107db2ec36aaf52f7f03028a), not just in dev dependencies. +- `opn` needs to be [installed](https://github.com/facebook/docusaurus/commit/923356e312687cae107db2ec36aaf52f7f03028a), not just in dev dependencies. ## [1.1.0] - 2018-05-20 This is our first major point release. There are three primary reasons for this: -- One of our most requested issues has been implemented - [Live Reload](https://github.com/facebook/Docusaurus/commit/f9a09072e35e274cf4c13b67d228ece3b7722d47). -- We [migrated](https://github.com/facebook/Docusaurus/commit/25cf8bb786abf835e4275e2a9975b33bd5fb2b18) to React 16 support (which wasn't as difficult as initially thought :) ) -- The blog now allows for [Facebook-based comments](https://github.com/facebook/Docusaurus/commit/aae106c018667a3787726f7744ce14ccb2b68ef1). +- One of our most requested issues has been implemented - [Live Reload](https://github.com/facebook/docusaurus/commit/f9a09072e35e274cf4c13b67d228ece3b7722d47). +- We [migrated](https://github.com/facebook/docusaurus/commit/25cf8bb786abf835e4275e2a9975b33bd5fb2b18) to React 16 support (which wasn't as difficult as initially thought :) ) +- The blog now allows for [Facebook-based comments](https://github.com/facebook/docusaurus/commit/aae106c018667a3787726f7744ce14ccb2b68ef1). There are a lot of other fixes and enhancements as well. Also, we have five new [users](https://docusaurus.io/en/users.html) of Docusaurus within this release as well. Thank you to [WarriorJS](https://warrior.js.org/), [Bemuse](https://bemuse.ninja/project/), [Pyre-Check](https://pyre-check.org/), [Draft.js](https://draftjs.org/) and [CaptainDuckDuck](https://captainduckduck.com/) for using Docusaurus. @@ -788,25 +788,25 @@ Thank you to the following contributors who helped with this release: ### Breaking Changes -- For blog posts, [`authorImage` is now `authorImageURL`](https://github.com/facebook/Docusaurus/commit/873a2427f91314fe9f8590cc782c01570f264c6d). +- For blog posts, [`authorImage` is now `authorImageURL`](https://github.com/facebook/docusaurus/commit/873a2427f91314fe9f8590cc782c01570f264c6d). ### Added -- [Live Reload](https://github.com/facebook/Docusaurus/commit/f9a09072e35e274cf4c13b67d228ece3b7722d47) allows you to make changes to your documentation without having to manually refresh your site. -- Running `yarn start` or `npm start` automatically [opens a browser](https://github.com/facebook/Docusaurus/commit/1a6f2fc51c1e1e9fa0e21fe5026a11681435aef3) to the correct `localhost` page. -- There is now a build option, `--skip-image-compression`, to [compress your images](https://github.com/facebook/Docusaurus/commit/ab6bab9f8d02c3cb402947ea5fd1c9d619478b54). -- You can now add Twitter and Facebook social buttons to the [footer](https://github.com/facebook/Docusaurus/commit/f8521c2fe1469c549d5f363517d21117358f8862). -- The blog now allows for [Facebook-based comments](https://github.com/facebook/Docusaurus/commit/aae106c018667a3787726f7744ce14ccb2b68ef1). -- A [warning](https://github.com/facebook/Docusaurus/commit/436a3d04d213360b71fc6edc45983b192def0f0b) is now shown if you use versioning without a `version.js` file. +- [Live Reload](https://github.com/facebook/docusaurus/commit/f9a09072e35e274cf4c13b67d228ece3b7722d47) allows you to make changes to your documentation without having to manually refresh your site. +- Running `yarn start` or `npm start` automatically [opens a browser](https://github.com/facebook/docusaurus/commit/1a6f2fc51c1e1e9fa0e21fe5026a11681435aef3) to the correct `localhost` page. +- There is now a build option, `--skip-image-compression`, to [compress your images](https://github.com/facebook/docusaurus/commit/ab6bab9f8d02c3cb402947ea5fd1c9d619478b54). +- You can now add Twitter and Facebook social buttons to the [footer](https://github.com/facebook/docusaurus/commit/f8521c2fe1469c549d5f363517d21117358f8862). +- The blog now allows for [Facebook-based comments](https://github.com/facebook/docusaurus/commit/aae106c018667a3787726f7744ce14ccb2b68ef1). +- A [warning](https://github.com/facebook/docusaurus/commit/436a3d04d213360b71fc6edc45983b192def0f0b) is now shown if you use versioning without a `version.js` file. ### Fixed/Changed - Various UI fixes -- Directory tree [printed](https://github.com/facebook/Docusaurus/commit/1796764b1cc56f9c2e46e937a7aa2ffd417b267c) during `docusaurus-init`. +- Directory tree [printed](https://github.com/facebook/docusaurus/commit/1796764b1cc56f9c2e46e937a7aa2ffd417b267c) during `docusaurus-init`. ### Removed -- [`authorImage`](https://github.com/facebook/Docusaurus/commit/873a2427f91314fe9f8590cc782c01570f264c6d) +- [`authorImage`](https://github.com/facebook/docusaurus/commit/873a2427f91314fe9f8590cc782c01570f264c6d) ## [1.0.15] - 2018-05-06 @@ -836,16 +836,16 @@ N/A ### Added -- Our Google Analytics support now [allows](https://github.com/facebook/Docusaurus/commit/976ae770b530636d1e4805ef285af52aa30a51c1) the use of `gtag` via the new [`gaGtag` site configuration option](https://docusaurus.io/docs/en/site-config.html#optional-fields). -- Anchor links are now [unique](https://github.com/facebook/Docusaurus/commit/9c98142fea416492efebf5a462fc0724551732f6) per document. -- You can now configure what version is shown by [default](https://github.com/facebook/Docusaurus/commit/dbc597bfd76879fed60869122397ce6c5a86bf81) via the [`defaultVersionShown` site configuraton option](https://docusaurus.io/docs/en/site-config.html#optional-fields). +- Our Google Analytics support now [allows](https://github.com/facebook/docusaurus/commit/976ae770b530636d1e4805ef285af52aa30a51c1) the use of `gtag` via the new [`gaGtag` site configuration option](https://docusaurus.io/docs/en/site-config.html#optional-fields). +- Anchor links are now [unique](https://github.com/facebook/docusaurus/commit/9c98142fea416492efebf5a462fc0724551732f6) per document. +- You can now configure what version is shown by [default](https://github.com/facebook/docusaurus/commit/dbc597bfd76879fed60869122397ce6c5a86bf81) via the [`defaultVersionShown` site configuraton option](https://docusaurus.io/docs/en/site-config.html#optional-fields). ### Fixed/Changed -- We do not [ignore](https://github.com/facebook/Docusaurus/commit/df6f6df333c9e3df42aa13c5db44b749eeb0abb9) the `custom_edit_url` metadata option in a doc any longer. -- UX/UI improvements: [table](https://github.com/facebook/Docusaurus/commit/3a246068874916914b9af3107d6061817b55176b), [code block](https://github.com/facebook/Docusaurus/commit/327d04436240c9f1cd31c50f999384556df5ac16), [sidebar](https://github.com/facebook/Docusaurus/commit/812f2be6e32d5328cb80cccfa1f05e3176b31235), [header anchors](https://github.com/facebook/Docusaurus/commit/be54c8f03536f7ad58adf8f7111c617446debbfa). -- Sitemap is now [generated](https://github.com/facebook/Docusaurus/commit/6c9c7e5de57fbf4c5f9dedd35817296b3e262596) if a blog post exists. -- IE fixes: [navigation](https://github.com/facebook/Docusaurus/commit/6d77403dc1b5fb2027ee3d1adc6374708a4cb3ee), [font rendering](https://github.com/facebook/Docusaurus/commit/17dd6d9c8e7093b60c81291623dad37d0700850d), etc. +- We do not [ignore](https://github.com/facebook/docusaurus/commit/df6f6df333c9e3df42aa13c5db44b749eeb0abb9) the `custom_edit_url` metadata option in a doc any longer. +- UX/UI improvements: [table](https://github.com/facebook/docusaurus/commit/3a246068874916914b9af3107d6061817b55176b), [code block](https://github.com/facebook/docusaurus/commit/327d04436240c9f1cd31c50f999384556df5ac16), [sidebar](https://github.com/facebook/docusaurus/commit/812f2be6e32d5328cb80cccfa1f05e3176b31235), [header anchors](https://github.com/facebook/docusaurus/commit/be54c8f03536f7ad58adf8f7111c617446debbfa). +- Sitemap is now [generated](https://github.com/facebook/docusaurus/commit/6c9c7e5de57fbf4c5f9dedd35817296b3e262596) if a blog post exists. +- IE fixes: [navigation](https://github.com/facebook/docusaurus/commit/6d77403dc1b5fb2027ee3d1adc6374708a4cb3ee), [font rendering](https://github.com/facebook/docusaurus/commit/17dd6d9c8e7093b60c81291623dad37d0700850d), etc. ### Removed @@ -872,7 +872,7 @@ N/A ### Fixed/Changed -- Blog metadata now [refreshed](https://github.com/facebook/Docusaurus/commit/d3fd347d21d3480e656cf4590917633f91254c5f) on changes to blog posts. +- Blog metadata now [refreshed](https://github.com/facebook/docusaurus/commit/d3fd347d21d3480e656cf4590917633f91254c5f) on changes to blog posts. ### Removed @@ -893,12 +893,12 @@ N/A ### Added -- Support for [custom highlight theme URL](https://github.com/facebook/Docusaurus/commit/aa32ff4a558269a2ac02f265489804ab83cc0145) via the `themeURL` site config option. +- Support for [custom highlight theme URL](https://github.com/facebook/docusaurus/commit/aa32ff4a558269a2ac02f265489804ab83cc0145) via the `themeURL` site config option. ### Fixed/Changed -- [Do not warn](https://github.com/facebook/Docusaurus/commit/c400636fb6a790ac39cb731ed3fe2f0cd22313eb) when using `layout` in the docs metadata header. -- [Restore](https://github.com/facebook/Docusaurus/commit/1d4e334a86cabb9581a3ba5305a2019a7bbb540d) the ability to use the --port command line argument +- [Do not warn](https://github.com/facebook/docusaurus/commit/c400636fb6a790ac39cb731ed3fe2f0cd22313eb) when using `layout` in the docs metadata header. +- [Restore](https://github.com/facebook/docusaurus/commit/1d4e334a86cabb9581a3ba5305a2019a7bbb540d) the ability to use the --port command line argument ### Removed @@ -924,18 +924,18 @@ Thank you to the following contributors who helped with this release: ### Breaking changes -- While not officially breaking, `authorImage` will be [deprecated](https://github.com/facebook/Docusaurus/pull/577) for [`authorImageURL`](https://github.com/facebook/Docusaurus/commit/57cddb4d0897e7d9a62305c6b2b8a04e824e0941) in blog posts. +- While not officially breaking, `authorImage` will be [deprecated](https://github.com/facebook/docusaurus/pull/577) for [`authorImageURL`](https://github.com/facebook/docusaurus/commit/57cddb4d0897e7d9a62305c6b2b8a04e824e0941) in blog posts. ### Added -- [`twitterImage`](https://github.com/facebook/Docusaurus/commit/e738bbd99e80596f7280c2a131600600c083fc68) has been added to site configuration options for use in Twitter cards. -- Support for [non-latin characters](https://github.com/facebook/Docusaurus/commit/1642c078a723487d922b80f6d112c989b98e8bd3) have been added in heading anchors. -- [``](https://github.com/facebook/Docusaurus/commit/946e2cef907a37290bfdf831dedc072de596f927) has been added to all HTML pages. -- `cssnano` is used to [minify](https://github.com/facebook/Docusaurus/commit/159b80df942ba4d7c422ecb6d4b57aa34fd7b5e3) the main CSS file. +- [`twitterImage`](https://github.com/facebook/docusaurus/commit/e738bbd99e80596f7280c2a131600600c083fc68) has been added to site configuration options for use in Twitter cards. +- Support for [non-latin characters](https://github.com/facebook/docusaurus/commit/1642c078a723487d922b80f6d112c989b98e8bd3) have been added in heading anchors. +- [``](https://github.com/facebook/docusaurus/commit/946e2cef907a37290bfdf831dedc072de596f927) has been added to all HTML pages. +- `cssnano` is used to [minify](https://github.com/facebook/docusaurus/commit/159b80df942ba4d7c422ecb6d4b57aa34fd7b5e3) the main CSS file. ### Fixed/Changed -- [Search bar width in mobile navigation](https://github.com/facebook/Docusaurus/commit/ba024a25c7cf37cdaecafb8d805a49505f461785). +- [Search bar width in mobile navigation](https://github.com/facebook/docusaurus/commit/ba024a25c7cf37cdaecafb8d805a49505f461785). ### Removed @@ -960,14 +960,14 @@ N/A ### Added -- [Dynamic port switching](https://github.com/facebook/Docusaurus/commit/bbbe311004aa0b2e61f1678099c02cb9a136d418) (e.g., if the default is busy) when running the local server. -- [Warnings](https://github.com/facebook/Docusaurus/commit/ad5b8b92b4a89bd197404d56d9a049db3aca5490) if you add documentation header metadata that is not supported. -- The ability to [hide the documentation title](https://github.com/facebook/Docusaurus/commit/6dd6ead19f8f58c8494798da8d95070b9cf40808) for any of your docs with a new metadata option called `hide_title`. +- [Dynamic port switching](https://github.com/facebook/docusaurus/commit/bbbe311004aa0b2e61f1678099c02cb9a136d418) (e.g., if the default is busy) when running the local server. +- [Warnings](https://github.com/facebook/docusaurus/commit/ad5b8b92b4a89bd197404d56d9a049db3aca5490) if you add documentation header metadata that is not supported. +- The ability to [hide the documentation title](https://github.com/facebook/docusaurus/commit/6dd6ead19f8f58c8494798da8d95070b9cf40808) for any of your docs with a new metadata option called `hide_title`. ### Fixed/Changed -- If you have translations enabled, the language drop down in the header navigation bar is now [fixed](https://github.com/facebook/Docusaurus/commit/0e3f3e30134d603e85a8024fdaa1a728a33b1452) to show the current language. -- More [accessibility fixes](https://github.com/facebook/Docusaurus/commit/80ece69a1069d92ceac4a07d990ae3fb8b2c8b51) to support a11y. +- If you have translations enabled, the language drop down in the header navigation bar is now [fixed](https://github.com/facebook/docusaurus/commit/0e3f3e30134d603e85a8024fdaa1a728a33b1452) to show the current language. +- More [accessibility fixes](https://github.com/facebook/docusaurus/commit/80ece69a1069d92ceac4a07d990ae3fb8b2c8b51) to support a11y. ### Removed @@ -983,16 +983,16 @@ N/A ### Added -- [Added Facebook Pixel ID as a configuration option](https://github.com/facebook/Docusaurus/commit/508090377eb14f27db5ccb87c5fbe70ab79dc62d), thanks @pestevez. +- [Added Facebook Pixel ID as a configuration option](https://github.com/facebook/docusaurus/commit/508090377eb14f27db5ccb87c5fbe70ab79dc62d), thanks @pestevez. - Better documentation on installation requirements, CircleCI, updating Docusaurus and API. Thanks espcially to @yangshun for a lot of documentation cleanup and additions. ### Fixed/Changed -- [Fixed .gitignore placement when running the examples script or `docusaurus-init`](https://github.com/facebook/Docusaurus/commit/fc051acde53e7dd981d5aeb0cea498209b1da11c) -- On page navigation fixes, including its [scroll height](https://github.com/facebook/Docusaurus/commit/56bae1d70ca6e0467b4f43fcc2b3adf72a5296db), [better table of contents](https://github.com/facebook/Docusaurus/commit/c437f7be37827f4f8c199577f4367ad0e56562c7), and other [fixes](https://github.com/facebook/Docusaurus/commit/1a674885aeff1a3c9523d16a72a34e4ba0ce8019), thanks @microbouji. -- [Cleaned up example pages](https://github.com/facebook/Docusaurus/commit/37c699e8bdcad6889fadf52253c0901dc029b507), thanks @Happy-Ferret. -- [Better alignment of the sitemap in the footer](https://github.com/facebook/Docusaurus/commit/a7acc7d794240b28da52f90cac487f6b803dc7a3), thanks @ryzokuken. -- Accessibility fixes around [images](https://github.com/facebook/Docusaurus/commit/c2cd169b64d1bd9513831976bd5db436d6cda498) and [links](https://github.com/facebook/Docusaurus/commit/e19b9ac56e227c40209cec774b5b74a539819153), thanks @amyrlam and @yangshun. +- [Fixed .gitignore placement when running the examples script or `docusaurus-init`](https://github.com/facebook/docusaurus/commit/fc051acde53e7dd981d5aeb0cea498209b1da11c) +- On page navigation fixes, including its [scroll height](https://github.com/facebook/docusaurus/commit/56bae1d70ca6e0467b4f43fcc2b3adf72a5296db), [better table of contents](https://github.com/facebook/docusaurus/commit/c437f7be37827f4f8c199577f4367ad0e56562c7), and other [fixes](https://github.com/facebook/docusaurus/commit/1a674885aeff1a3c9523d16a72a34e4ba0ce8019), thanks @microbouji. +- [Cleaned up example pages](https://github.com/facebook/docusaurus/commit/37c699e8bdcad6889fadf52253c0901dc029b507), thanks @Happy-Ferret. +- [Better alignment of the sitemap in the footer](https://github.com/facebook/docusaurus/commit/a7acc7d794240b28da52f90cac487f6b803dc7a3), thanks @ryzokuken. +- Accessibility fixes around [images](https://github.com/facebook/docusaurus/commit/c2cd169b64d1bd9513831976bd5db436d6cda498) and [links](https://github.com/facebook/docusaurus/commit/e19b9ac56e227c40209cec774b5b74a539819153), thanks @amyrlam and @yangshun. ### Removed @@ -1002,7 +1002,7 @@ N/A **This is a hotfix release** -A [bug](https://github.com/facebook/Docusaurus/pull/501) was found in the [using `path` functions commit](https://github.com/facebook/Docusaurus/commit/cbdab2ba1112e8949683d23ce20034aa17d9013d) by @sunnylqm. Total commits in this release is 4, including the release itself. +A [bug](https://github.com/facebook/docusaurus/pull/501) was found in the [using `path` functions commit](https://github.com/facebook/docusaurus/commit/cbdab2ba1112e8949683d23ce20034aa17d9013d) by @sunnylqm. Total commits in this release is 4, including the release itself. ### Breaking Changes @@ -1014,7 +1014,7 @@ N/A ### Fixed/Changed -- [Fix wrong versioned_docs file path](https://github.com/facebook/Docusaurus/pull/501/commits/324facde46e13749423d72f14e300a8dbf0a76cb), thanks @sunnylqm. +- [Fix wrong versioned_docs file path](https://github.com/facebook/docusaurus/pull/501/commits/324facde46e13749423d72f14e300a8dbf0a76cb), thanks @sunnylqm. ### Removed @@ -1022,7 +1022,7 @@ N/A ## [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. +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 @@ -1030,20 +1030,20 @@ 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. +- [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 CircleCI 1.0 publishing documentation with CircleCI 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. +- [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 @@ -1061,13 +1061,13 @@ N/A ### Added -- [A scrollbar to the header links on mobile](https://github.com/facebook/Docusaurus/commit/0dad6d562f78e9d1c9d8c70946755accd73a6a63), thanks @maaz93. +- [A scrollbar to the header links on mobile](https://github.com/facebook/docusaurus/commit/0dad6d562f78e9d1c9d8c70946755accd73a6a63), thanks @maaz93. ### Fixed/Changed -- [Allow new docs to be added for new versions](https://github.com/facebook/Docusaurus/commit/1388e1379512ddfd4d5bfbecaac2a598dd85151c) -- [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. +- [Allow new docs to be added for new versions](https://github.com/facebook/docusaurus/commit/1388e1379512ddfd4d5bfbecaac2a598dd85151c) +- [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 @@ -1083,11 +1083,11 @@ N/A ### Added -- 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) +- 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/) -- Docs section about referencing site documents ([#394](https://github.com/facebook/Docusaurus/commit/1d967a941cfc7256588ce8b88291d7f3c86c1983) ) +- 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) - [Alphabetized site config options](https://docusaurus.io/docs/en/site-config.html) in docs (thanks @haraldur12) - Moved [verifying installation](https://docusaurus.io/docs/en/installation.html#verifying-installation) section to the install docs (@thanks @gedeagas) @@ -1095,14 +1095,14 @@ N/A ### Fixed/Changed -- Blog feeds now show HTML, not markdown ([#407](https://github.com/facebook/Docusaurus/commit/2d7274f6fe052615d0e0fe4d1b75f9cfc5f88cbb), thanks @tom-auger) -- Chinese translation infra ([#377](https://github.com/facebook/Docusaurus/commit/00270c26a729a9b23e1e4055868ae7146c2d81d8), thanks @chenglou) -- Margin for right-aligned images ([#398](https://github.com/facebook/Docusaurus/commit/4c2558e8bd538ea6f49867e18c1bbd9489e7ba2c), thanks @rickhanlonii) -- Correct HTTP status code sent on redirects ([#408](https://github.com/facebook/Docusaurus/commit/c81609d393e9e1fe2b63b69028b0624091a3e440)) -- Non-English versioned docs metadata parsed correctly ([#412](https://github.com/facebook/Docusaurus/commit/43e80fcea735788a78d8c48e35df4ea1b6cd8b00), thanks @sunnylqm) -- Provide Algolia information about the latest and current version ([#418](https://github.com/facebook/Docusaurus/commit/61c5d2d8e01ace967157120727e3b3fcab541b17)) -- Remove key errors when running local server ([#425](https://github.com/facebook/Docusaurus/commit/c6a9848a17b7ac27f43a58c6cecacf905fab0cbc), thanks @hshoff) -- Links fixed in blog Atom feed ([#421](https://github.com/facebook/Docusaurus/commit/c99cdefd3a314e53cc23ff65eeaa6837cb49d034), thanks @hramos) +- Blog feeds now show HTML, not markdown ([#407](https://github.com/facebook/docusaurus/commit/2d7274f6fe052615d0e0fe4d1b75f9cfc5f88cbb), thanks @tom-auger) +- Chinese translation infra ([#377](https://github.com/facebook/docusaurus/commit/00270c26a729a9b23e1e4055868ae7146c2d81d8), thanks @chenglou) +- Margin for right-aligned images ([#398](https://github.com/facebook/docusaurus/commit/4c2558e8bd538ea6f49867e18c1bbd9489e7ba2c), thanks @rickhanlonii) +- Correct HTTP status code sent on redirects ([#408](https://github.com/facebook/docusaurus/commit/c81609d393e9e1fe2b63b69028b0624091a3e440)) +- Non-English versioned docs metadata parsed correctly ([#412](https://github.com/facebook/docusaurus/commit/43e80fcea735788a78d8c48e35df4ea1b6cd8b00), thanks @sunnylqm) +- Provide Algolia information about the latest and current version ([#418](https://github.com/facebook/docusaurus/commit/61c5d2d8e01ace967157120727e3b3fcab541b17)) +- Remove key errors when running local server ([#425](https://github.com/facebook/docusaurus/commit/c6a9848a17b7ac27f43a58c6cecacf905fab0cbc), thanks @hshoff) +- Links fixed in blog Atom feed ([#421](https://github.com/facebook/docusaurus/commit/c99cdefd3a314e53cc23ff65eeaa6837cb49d034), thanks @hramos) ### Removed @@ -1122,9 +1122,9 @@ N/A ### Fixed/Changed -- Docusaurus builds on Windows ([PR #381](https://github.com/facebook/Docusaurus/pull/381), thanks @qcz). -- Fixed publishing for user/org GitHub sites (as opposed to project sites) ([PR #384](https://github.com/facebook/Docusaurus/pull/384)). -- Clarification and updates on the publishing and API documentation ([PR #372](https://github.com/facebook/Docusaurus/pull/372)). +- Docusaurus builds on Windows ([PR #381](https://github.com/facebook/docusaurus/pull/381), thanks @qcz). +- Fixed publishing for user/org GitHub sites (as opposed to project sites) ([PR #384](https://github.com/facebook/docusaurus/pull/384)). +- Clarification and updates on the publishing and API documentation ([PR #372](https://github.com/facebook/docusaurus/pull/372)). ### Removed @@ -1136,7 +1136,7 @@ This is generally a bug fix release, with some code refactoring. Total commits i ### Breaking Changes -- **_Most users may not run into this problem, but we think it can technically be a breaking change_**. PR #322 (original PR #316) and friends changes the way we check for the existence of translations and versioning. Part of that is that we allow for the possibility of an empty language prop, instead of defaulting everything to English. When running 1.0.4, check to make sure your `index.js` works as expected. See [this comment](https://github.com/facebook/Docusaurus/pull/322#issuecomment-352914064) and those below for discussion on this. There is still a bit more work to be done (refactoring and maybe adding a `defaultLang` config option) to make this as clean as possible. +- **_Most users may not run into this problem, but we think it can technically be a breaking change_**. PR #322 (original PR #316) and friends changes the way we check for the existence of translations and versioning. Part of that is that we allow for the possibility of an empty language prop, instead of defaulting everything to English. When running 1.0.4, check to make sure your `index.js` works as expected. See [this comment](https://github.com/facebook/docusaurus/pull/322#issuecomment-352914064) and those below for discussion on this. There is still a bit more work to be done (refactoring and maybe adding a `defaultLang` config option) to make this as clean as possible. ### Added @@ -1168,46 +1168,46 @@ N/A - Blog - Documentation -[unreleased]: https://github.com/facebook/Docusaurus/compare/v1.13.0...HEAD -[1.13.0]: https://github.com/facebook/Docusaurus/compare/v1.12.0...v1.13.0 -[1.12.0]: https://github.com/facebook/Docusaurus/compare/v1.11.1...v1.12.0 -[1.11.1]: https://github.com/facebook/Docusaurus/compare/v1.11.0...v1.11.1 -[1.11.0]: https://github.com/facebook/Docusaurus/compare/v1.10.0...v1.11.0 -[1.10.0]: https://github.com/facebook/Docusaurus/compare/v1.9.0...v1.10.0 -[1.9.0]: https://github.com/facebook/Docusaurus/compare/v1.8.1...v1.9.0 -[1.8.1]: https://github.com/facebook/Docusaurus/compare/v1.8.0...v1.8.1 -[1.8.0]: https://github.com/facebook/Docusaurus/compare/v1.7.3...v1.8.0 -[1.7.3]: https://github.com/facebook/Docusaurus/compare/v1.7.2...v1.7.3 -[1.7.2]: https://github.com/facebook/Docusaurus/compare/v1.7.1...v1.7.2 -[1.7.1]: https://github.com/facebook/Docusaurus/compare/v1.7.0...v1.7.1 -[1.7.0]: https://github.com/facebook/Docusaurus/compare/v1.6.2...v1.7.0 -[1.6.2]: https://github.com/facebook/Docusaurus/compare/v1.6.1...v1.6.2 -[1.6.1]: https://github.com/facebook/Docusaurus/compare/v1.6.0...v1.6.1 -[1.6.0]: https://github.com/facebook/Docusaurus/compare/v1.5.1...v1.6.0 -[1.5.1]: https://github.com/facebook/Docusaurus/compare/v1.4.0...v1.5.1 -[1.5.0]: https://github.com/facebook/Docusaurus/compare/v1.4.0...v1.5.0 -[1.4.0]: https://github.com/facebook/Docusaurus/compare/v1.3.3...v1.4.0 -[1.3.3]: https://github.com/facebook/Docusaurus/compare/v1.3.2...v1.3.3 -[1.3.2]: https://github.com/facebook/Docusaurus/compare/v1.3.1...v1.3.2 -[1.3.1]: https://github.com/facebook/Docusaurus/compare/v1.3.0...v1.3.1 -[1.3.0]: https://github.com/facebook/Docusaurus/compare/v1.2.1...v1.3.0 -[1.2.1]: https://github.com/facebook/Docusaurus/compare/v1.2.0...v1.2.1 -[1.2.0]: https://github.com/facebook/Docusaurus/compare/v1.1.5...v1.2.0 -[1.1.5]: https://github.com/facebook/Docusaurus/compare/v1.1.4...v1.1.5 -[1.1.4]: https://github.com/facebook/Docusaurus/compare/v1.1.3...v1.1.4 -[1.1.3]: https://github.com/facebook/Docusaurus/compare/v1.1.2...v1.1.3 -[1.1.2]: https://github.com/facebook/Docusaurus/compare/v1.1.1...v1.1.2 -[1.1.1]: https://github.com/facebook/Docusaurus/compare/v1.1.0...v1.1.1 -[1.1.0]: https://github.com/facebook/Docusaurus/compare/v1.0.15...v1.1.0 -[1.0.14]: https://github.com/facebook/Docusaurus/compare/v1.0.14...v1.0.15 -[1.0.14]: https://github.com/facebook/Docusaurus/compare/v1.0.13...v1.0.14 -[1.0.13]: https://github.com/facebook/Docusaurus/compare/v1.0.12...v1.0.13 -[1.0.12]: https://github.com/facebook/Docusaurus/compare/v1.0.11...v1.0.12 -[1.0.11]: https://github.com/facebook/Docusaurus/compare/v1.0.10...v1.0.11 -[1.0.10]: https://github.com/facebook/Docusaurus/compare/v1.0.9...v1.0.10 -[1.0.9]: https://github.com/facebook/Docusaurus/compare/v1.0.8...v1.0.9 -[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 -[1.0.4]: https://github.com/facebook/Docusaurus/compare/v1.0.3...v1.0.4 +[unreleased]: https://github.com/facebook/docusaurus/compare/v1.13.0...HEAD +[1.13.0]: https://github.com/facebook/docusaurus/compare/v1.12.0...v1.13.0 +[1.12.0]: https://github.com/facebook/docusaurus/compare/v1.11.1...v1.12.0 +[1.11.1]: https://github.com/facebook/docusaurus/compare/v1.11.0...v1.11.1 +[1.11.0]: https://github.com/facebook/docusaurus/compare/v1.10.0...v1.11.0 +[1.10.0]: https://github.com/facebook/docusaurus/compare/v1.9.0...v1.10.0 +[1.9.0]: https://github.com/facebook/docusaurus/compare/v1.8.1...v1.9.0 +[1.8.1]: https://github.com/facebook/docusaurus/compare/v1.8.0...v1.8.1 +[1.8.0]: https://github.com/facebook/docusaurus/compare/v1.7.3...v1.8.0 +[1.7.3]: https://github.com/facebook/docusaurus/compare/v1.7.2...v1.7.3 +[1.7.2]: https://github.com/facebook/docusaurus/compare/v1.7.1...v1.7.2 +[1.7.1]: https://github.com/facebook/docusaurus/compare/v1.7.0...v1.7.1 +[1.7.0]: https://github.com/facebook/docusaurus/compare/v1.6.2...v1.7.0 +[1.6.2]: https://github.com/facebook/docusaurus/compare/v1.6.1...v1.6.2 +[1.6.1]: https://github.com/facebook/docusaurus/compare/v1.6.0...v1.6.1 +[1.6.0]: https://github.com/facebook/docusaurus/compare/v1.5.1...v1.6.0 +[1.5.1]: https://github.com/facebook/docusaurus/compare/v1.4.0...v1.5.1 +[1.5.0]: https://github.com/facebook/docusaurus/compare/v1.4.0...v1.5.0 +[1.4.0]: https://github.com/facebook/docusaurus/compare/v1.3.3...v1.4.0 +[1.3.3]: https://github.com/facebook/docusaurus/compare/v1.3.2...v1.3.3 +[1.3.2]: https://github.com/facebook/docusaurus/compare/v1.3.1...v1.3.2 +[1.3.1]: https://github.com/facebook/docusaurus/compare/v1.3.0...v1.3.1 +[1.3.0]: https://github.com/facebook/docusaurus/compare/v1.2.1...v1.3.0 +[1.2.1]: https://github.com/facebook/docusaurus/compare/v1.2.0...v1.2.1 +[1.2.0]: https://github.com/facebook/docusaurus/compare/v1.1.5...v1.2.0 +[1.1.5]: https://github.com/facebook/docusaurus/compare/v1.1.4...v1.1.5 +[1.1.4]: https://github.com/facebook/docusaurus/compare/v1.1.3...v1.1.4 +[1.1.3]: https://github.com/facebook/docusaurus/compare/v1.1.2...v1.1.3 +[1.1.2]: https://github.com/facebook/docusaurus/compare/v1.1.1...v1.1.2 +[1.1.1]: https://github.com/facebook/docusaurus/compare/v1.1.0...v1.1.1 +[1.1.0]: https://github.com/facebook/docusaurus/compare/v1.0.15...v1.1.0 +[1.0.14]: https://github.com/facebook/docusaurus/compare/v1.0.14...v1.0.15 +[1.0.14]: https://github.com/facebook/docusaurus/compare/v1.0.13...v1.0.14 +[1.0.13]: https://github.com/facebook/docusaurus/compare/v1.0.12...v1.0.13 +[1.0.12]: https://github.com/facebook/docusaurus/compare/v1.0.11...v1.0.12 +[1.0.11]: https://github.com/facebook/docusaurus/compare/v1.0.10...v1.0.11 +[1.0.10]: https://github.com/facebook/docusaurus/compare/v1.0.9...v1.0.10 +[1.0.9]: https://github.com/facebook/docusaurus/compare/v1.0.8...v1.0.9 +[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 +[1.0.4]: https://github.com/facebook/docusaurus/compare/v1.0.3...v1.0.4 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f612d4768c..71dbde47aa 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -67,7 +67,7 @@ We use [GitHub Issues](https://github.com/facebook/docusaurus/issues) for our pu If you have questions about using Docusaurus, contact the Docusaurus Twitter account at [@docusaurus](https://twitter.com/docusaurus), and we will do our best to answer your questions. -You can also file issues as [feature requests or enhancements](https://github.com/facebook/Docusaurus/labels/feature%20request). If you see anything you'd like to be implemented, create an issue with [feature template](https://raw.githubusercontent.com/facebook/docusaurus/master/.github/ISSUE_TEMPLATE/feature.md) +You can also file issues as [feature requests or enhancements](https://github.com/facebook/docusaurus/labels/feature%20request). If you see anything you'd like to be implemented, create an issue with [feature template](https://raw.githubusercontent.com/facebook/docusaurus/master/.github/ISSUE_TEMPLATE/feature.md) ## Reporting New Issues @@ -117,7 +117,7 @@ Please make sure the following is done when submitting a pull request: 1. Fork [the repository](https://github.com/facebook/docusaurus) and create your branch from `master`. 1. Add the copyright notice to the top of any code new files you've added. -1. Describe your [**test plan**](#test-plan) in your pull request description. Make sure to [test your changes](https://github.com/facebook/Docusaurus/blob/master/admin/testing-changes-on-Docusaurus-itself.md)! +1. Describe your [**test plan**](#test-plan) in your pull request description. Make sure to [test your changes](https://github.com/facebook/docusaurus/blob/master/admin/testing-changes-on-Docusaurus-itself.md)! 1. Make sure your code lints (`yarn prettier && yarn lint`). 1. Make sure your Jest tests pass (`yarn test`). 1. If you haven't already, [sign the CLA](https://code.facebook.com/cla). diff --git a/README.md b/README.md index 751c59130d..39e7b2a101 100644 --- a/README.md +++ b/README.md @@ -39,11 +39,11 @@ Facebook has adopted a Code of Conduct that we expect project participants to ad ### Contributing Guide -Read our [contributing guide](https://github.com/facebook/Docusaurus/blob/master/CONTRIBUTING.md) to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes to Docusaurus. +Read our [contributing guide](https://github.com/facebook/docusaurus/blob/master/CONTRIBUTING.md) to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes to Docusaurus. ### Beginner Friendly Bugs -To help you get your feet wet and get you familiar with our contribution process, we have a list of [beginner friendly bugs](https://github.com/facebook/Docusaurus/labels/good%20first%20issue) that contain bugs which are fairly easy to fix. This is a great place to get started. +To help you get your feet wet and get you familiar with our contribution process, we have a list of [beginner friendly bugs](https://github.com/facebook/docusaurus/labels/good%20first%20issue) that contain bugs which are fairly easy to fix. This is a great place to get started. ## Contact @@ -57,7 +57,7 @@ We have a few channels for contact: ## Contributors -This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)]. +This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)]. ## Backers diff --git a/admin/prerelease.md b/admin/prerelease.md index 8c596fc3e5..4e84e349a3 100644 --- a/admin/prerelease.md +++ b/admin/prerelease.md @@ -4,14 +4,14 @@ # Steps -1. Ensure that `origin` remote is your Docusaurus fork and `upstream` is Docusaurus original repository. +1. Ensure that `origin` remote is your Docusaurus fork and `upstream` is Docusaurus original repository. ```bash $ git remote -v origin https://github.com/endiliey/Docusaurus.git (fetch) origin https://github.com/endiliey/Docusaurus.git (push) -upstream https://github.com/facebook/Docusaurus.git (fetch) -upstream https://github.com/facebook/Docusaurus.git (push) +upstream https://github.com/facebook/docusaurus.git (fetch) +upstream https://github.com/facebook/docusaurus.git (push) ``` 2. Pull latest changes from Docusaurus repository. diff --git a/admin/publish.md b/admin/publish.md index b0b7b5df77..aafe06bdbe 100644 --- a/admin/publish.md +++ b/admin/publish.md @@ -11,13 +11,13 @@ If you are not currently logged into npm locally: ## Publish -1. Bump version number in [`package.json`](https://github.com/facebook/Docusaurus/blob/master/package.json). -1. Update the [changelog](https://github.com/facebook/Docusaurus/blob/master/CHANGELOG.md), including at the reference links at the bottom. +1. Bump version number in [`package.json`](https://github.com/facebook/docusaurus/blob/master/package.json). +1. Update the [changelog](https://github.com/facebook/docusaurus/blob/master/CHANGELOG.md), including at the reference links at the bottom. 1. Do this always, but particularly important if there were any `package.json` changes in this release: 1. If there is no `node_modules` directory in you local Docusaurus version, run `yarn install` and `npm install`. 1. Run `yarn upgrade` to update `yarn.lock` and `npm update` to update `package-lock.json`. 1. From the `website-1.x` directory, run `npm run docusaurus-version x.x.x`, where x.x.x is the same version number you updated to in `package.json`. -1. Test your PR locally on a project that was created via [these instructions](https://github.com/facebook/Docusaurus/blob/master/admin/local-third-party-project-testing.md). +1. Test your PR locally on a project that was created via [these instructions](https://github.com/facebook/docusaurus/blob/master/admin/local-third-party-project-testing.md). 1. Submit your PR 1. When your PR is merged, rebase to get the PR commit locally. 1. Run `npm publish` @@ -32,7 +32,7 @@ The version number should generally increase by some factor than the current one "version": "1.0.0-alpha.41", "repository": { "type": "git", - "url": "https://github.com/facebook/Docusaurus.git" + "url": "https://github.com/facebook/docusaurus.git" } ... } diff --git a/docs/api-doc-markdown.md b/docs/api-doc-markdown.md index 7003a70235..5e363f7ddd 100644 --- a/docs/api-doc-markdown.md +++ b/docs/api-doc-markdown.md @@ -50,7 +50,7 @@ For example: --- id: doc-markdown title: Markdown Features -custom_edit_url: https://github.com/facebook/Docusaurus/edit/master/docs/api-doc-markdown.md +custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md --- ``` diff --git a/docs/getting-started-installation.md b/docs/getting-started-installation.md index b1d548668a..b03536ed42 100644 --- a/docs/getting-started-installation.md +++ b/docs/getting-started-installation.md @@ -98,7 +98,7 @@ info Color legend : "" : Minor Update backward-compatible features "" : Patch Update backward-compatible bug fixes Package Current Wanted Latest Package Type URL -docusaurus 1.0.9 1.2.0 1.2.0 devDependencies https://github.com/facebook/Docusaurus#readme +docusaurus 1.0.9 1.2.0 1.2.0 devDependencies https://github.com/facebook/docusaurus#readme โœจ Done in 0.41s. ``` diff --git a/docs/getting-started-publishing.md b/docs/getting-started-publishing.md index 571f83508a..90ee88864f 100644 --- a/docs/getting-started-publishing.md +++ b/docs/getting-started-publishing.md @@ -21,7 +21,7 @@ At this point, you can grab all of the files inside the `website/build` director > For example, both Apache and Nginx serve content from `/var/www/html` by default. That said, choosing a web server or provider is outside the scope of Docusaurus. -> When serving the site from your own web server, ensure the web server is serving the asset files with the proper HTTP headers. CSS files should be served with the `content-type` header of `text/css`. In the case of Nginx, this would mean setting `include /etc/nginx/mime.types;` in your `nginx.conf` file. See [this issue](https://github.com/facebook/Docusaurus/issues/602) for more info. +> When serving the site from your own web server, ensure the web server is serving the asset files with the proper HTTP headers. CSS files should be served with the `content-type` header of `text/css`. In the case of Nginx, this would mean setting `include /etc/nginx/mime.types;` in your `nginx.conf` file. See [this issue](https://github.com/facebook/docusaurus/issues/602) for more info. ### Hosting on a Service: diff --git a/docs/guides-navigation.md b/docs/guides-navigation.md index e0bdefd1d2..28f75240d7 100644 --- a/docs/guides-navigation.md +++ b/docs/guides-navigation.md @@ -202,7 +202,7 @@ Custom links can be added to the site navigation bar with the following entry in { headerLinks: [ ... - { href: 'https://github.com/facebook/Docusaurus', label: 'GitHub' }, + { href: 'https://github.com/facebook/docusaurus', label: 'GitHub' }, ... ], ... diff --git a/packages/docusaurus-1.x/README.md b/packages/docusaurus-1.x/README.md index a2a3849c7d..a0f64bedee 100644 --- a/packages/docusaurus-1.x/README.md +++ b/packages/docusaurus-1.x/README.md @@ -7,7 +7,7 @@ npm version - CircleCI Status + CircleCI Status PRs Welcome Chat code style: prettier @@ -39,11 +39,11 @@ Facebook has adopted a Code of Conduct that we expect project participants to ad ### Contributing Guide -Read our [contributing guide](https://github.com/facebook/Docusaurus/blob/master/CONTRIBUTING.md) to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes to Docusaurus. +Read our [contributing guide](https://github.com/facebook/docusaurus/blob/master/CONTRIBUTING.md) to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes to Docusaurus. ### Beginner Friendly Bugs -To help you get your feet wet and get you familiar with our contribution process, we have a list of [beginner friendly bugs](https://github.com/facebook/Docusaurus/labels/good%20first%20issue) that contain bugs which are fairly easy to fix. This is a great place to get started. +To help you get your feet wet and get you familiar with our contribution process, we have a list of [beginner friendly bugs](https://github.com/facebook/docusaurus/labels/good%20first%20issue) that contain bugs which are fairly easy to fix. This is a great place to get started. ## Contact @@ -57,7 +57,7 @@ We have a few channels for contact: ## Contributors -This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)]. +This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)]. ## Backers diff --git a/packages/docusaurus-1.x/examples/basics/README.md b/packages/docusaurus-1.x/examples/basics/README.md index f3da77ff34..7391779aba 100644 --- a/packages/docusaurus-1.x/examples/basics/README.md +++ b/packages/docusaurus-1.x/examples/basics/README.md @@ -160,7 +160,7 @@ For more information about blog posts, click [here](https://docusaurus.io/docs/e /* you can add custom pages */ { page: 'help', label: 'Help' }, /* you can add external links */ - { href: 'https://github.com/facebook/Docusaurus', label: 'GitHub' }, + { href: 'https://github.com/facebook/docusaurus', label: 'GitHub' }, ... ], ... diff --git a/packages/docusaurus-1.x/lib/server/__tests__/__fixtures__/2018-08-17-docusaurus.md b/packages/docusaurus-1.x/lib/server/__tests__/__fixtures__/2018-08-17-docusaurus.md index 3f6f4416e4..c63f1a771d 100644 --- a/packages/docusaurus-1.x/lib/server/__tests__/__fixtures__/2018-08-17-docusaurus.md +++ b/packages/docusaurus-1.x/lib/server/__tests__/__fixtures__/2018-08-17-docusaurus.md @@ -8,4 +8,4 @@ authorTwitter: endiliey ![Docusaurus](/img/slash-introducing.png) -We are very happy to introduce [Docusaurus](https://github.com/facebook/Docusaurus) to help you manage one or many open source websites. \ No newline at end of file +We are very happy to introduce [Docusaurus](https://github.com/facebook/docusaurus) to help you manage one or many open source websites. \ No newline at end of file diff --git a/packages/docusaurus-1.x/lib/server/__tests__/__snapshots__/blog.test.js.snap b/packages/docusaurus-1.x/lib/server/__tests__/__snapshots__/blog.test.js.snap index d7f553c410..e57ff36221 100644 --- a/packages/docusaurus-1.x/lib/server/__tests__/__snapshots__/blog.test.js.snap +++ b/packages/docusaurus-1.x/lib/server/__tests__/__snapshots__/blog.test.js.snap @@ -9,7 +9,7 @@ Object { "content": " ![Docusaurus](/img/slash-introducing.png) -We are very happy to introduce [Docusaurus](https://github.com/facebook/Docusaurus) to help you manage one or many open source websites.", +We are very happy to introduce [Docusaurus](https://github.com/facebook/docusaurus) to help you manage one or many open source websites.", "id": "Docusaurus", "path": "2018/08/17/docusaurus.html", "title": "Docusaurus", diff --git a/packages/docusaurus-1.x/package.json b/packages/docusaurus-1.x/package.json index b7b9733d91..26e6aca533 100644 --- a/packages/docusaurus-1.x/package.json +++ b/packages/docusaurus-1.x/package.json @@ -11,7 +11,7 @@ ], "repository": { "type": "git", - "url": "https://github.com/facebook/Docusaurus.git" + "url": "https://github.com/facebook/docusaurus.git" }, "scripts": { "start": "cd ../../website-1.x && yarn start" diff --git a/packages/docusaurus/package.json b/packages/docusaurus/package.json index ff5112a0ae..c4870b5b5d 100644 --- a/packages/docusaurus/package.json +++ b/packages/docusaurus/package.json @@ -17,7 +17,7 @@ ], "repository": { "type": "git", - "url": "https://github.com/facebook/Docusaurus.git" + "url": "https://github.com/facebook/docusaurus.git" }, "bin": { "docusaurus": "bin/docusaurus.js" @@ -26,7 +26,7 @@ "tsc": "tsc && node copyUntypedFiles.js" }, "bugs": { - "url": "https://github.com/facebook/Docusaurus/issues" + "url": "https://github.com/facebook/docusaurus/issues" }, "devDependencies": { "@docusaurus/types": "^2.0.0-alpha.26" diff --git a/website-1.x/blog/2017-12-14-introducing-docusaurus.md b/website-1.x/blog/2017-12-14-introducing-docusaurus.md index 67f2a954b2..c642d26fee 100644 --- a/website-1.x/blog/2017-12-14-introducing-docusaurus.md +++ b/website-1.x/blog/2017-12-14-introducing-docusaurus.md @@ -8,7 +8,7 @@ authorTwitter: JoelMarcey ![Introducing Slash](/img/slash-introducing.svg) -We are very happy to introduce [Docusaurus](https://github.com/facebook/Docusaurus) to help you manage one or many open source websites. +We are very happy to introduce [Docusaurus](https://github.com/facebook/docusaurus) to help you manage one or many open source websites. We created [Docusaurus](https://docusaurus.io) for the following reasons: @@ -73,7 +73,7 @@ With the exception of node_modules and package.json, all the directories and fil ## How does Docusaurus work? -Docusaurus is written primarily in JavaScript and [React](https://facebook.github.io/react), replacing Jekyll which we used in the old template. We use [Remarkable](https://github.com/jonschlinkert/remarkable) for our markdown rendering and [highlight.js](https://highlightjs.org/) for our code block syntax highlighting. The core of Docusaurus' functionality is in the [lib directory](https://github.com/facebookexperimental/Docusaurus/tree/master/lib) of the [Docusaurus repo](https://github.com/facebook/Docusaurus/). The general structure looks like: +Docusaurus is written primarily in JavaScript and [React](https://facebook.github.io/react), replacing Jekyll which we used in the old template. We use [Remarkable](https://github.com/jonschlinkert/remarkable) for our markdown rendering and [highlight.js](https://highlightjs.org/) for our code block syntax highlighting. The core of Docusaurus' functionality is in the [lib directory](https://github.com/facebookexperimental/Docusaurus/tree/master/lib) of the [Docusaurus repo](https://github.com/facebook/docusaurus/). The general structure looks like: ```bash root-of-Docusaurus @@ -131,7 +131,7 @@ build ![Docusaurus](/img/docusaurus.svg) -We welcome your [contributions](https://github.com/facebook/Docusaurus/blob/master/CONTRIBUTING.md) to Docusaurus, whether you want to use it for your own site, you want to [contribute](https://github.com/facebook/Docusaurus/blob/master/CONTRIBUTING.md) to the Docusaurus core or just have questions. Follow us on [GitHub](https://github.com/facebook/Docusaurus) and [Twitter](https://twitter.com/docusaurus). +We welcome your [contributions](https://github.com/facebook/docusaurus/blob/master/CONTRIBUTING.md) to Docusaurus, whether you want to use it for your own site, you want to [contribute](https://github.com/facebook/docusaurus/blob/master/CONTRIBUTING.md) to the Docusaurus core or just have questions. Follow us on [GitHub](https://github.com/facebook/docusaurus) and [Twitter](https://twitter.com/docusaurus). ## Acknowledgements @@ -154,5 +154,5 @@ Without their dedication to creating or migrating their websites over to the pla - [Read our documentation](https://docusaurus.io) - [Follow our Twitter feed](https://twitter.com/docusaurus) -- [Follow us on GitHub](https://github.com/facebook/Docusaurus) +- [Follow us on GitHub](https://github.com/facebook/docusaurus) - [About Slash, the Docusaurus mascot](https://docusaurus.io/about-slash.html) diff --git a/website-1.x/blog/2018-09-11-Towards-Docusaurus-2.md b/website-1.x/blog/2018-09-11-Towards-Docusaurus-2.md index fde13e18d4..1c53219e2e 100644 --- a/website-1.x/blog/2018-09-11-Towards-Docusaurus-2.md +++ b/website-1.x/blog/2018-09-11-Towards-Docusaurus-2.md @@ -16,9 +16,9 @@ There is a saying that the very best software is constantly evolving, and the ve ## Introduction -It all started with this [RFC issue](https://github.com/facebook/Docusaurus/issues/789) opened by [Yangshun](https://github.com/yangshun) towards the end of June 2018. +It all started with this [RFC issue](https://github.com/facebook/docusaurus/issues/789) opened by [Yangshun](https://github.com/yangshun) towards the end of June 2018. -

[RFC] Docusaurus v2 ยท Issue #789 ยท facebook/Docusaurus

These are some of the problems I'm seeing in Docusaurus now and also how we can address them in v2. A number of the ideas here were inspired by VuePress and other static site generators. In the current static site generators ecosystem, t...

+

[RFC] Docusaurus v2 ยท Issue #789 ยท facebook/docusaurus

These are some of the problems I'm seeing in Docusaurus now and also how we can address them in v2. A number of the ideas here were inspired by VuePress and other static site generators. In the current static site generators ecosystem, t...

Most of the suggested improvements are mentioned in the issue; I will provide details on some of issues in Docusaurus 1 and how we are going to address them in Docusaurus 2. @@ -61,7 +61,7 @@ However, if there are no changes to `hello.md` when cutting v2.0.0, Docusaurus w This can be very confusing for users; if they want to edit the v2.0.0 docs, they have to edit `versioned_docs/version-1.0.0/hello.md` or manually add `versioned_docs/version-2.0.0/hello.md`. This could potentially lead to unwanted bugs. Here is a [real scenario in Jest](https://github.com/facebook/jest/pull/6758#issuecomment-408274413). -In addition, this adds complexity within the codebase as we require a mechanism for version fallbacks. And during build time, Docusaurus has to replace the linking to the correct version. This is also the cause of a bug where [renaming docs breaks links in old versions](https://github.com/facebook/Docusaurus/issues/845). +In addition, this adds complexity within the codebase as we require a mechanism for version fallbacks. And during build time, Docusaurus has to replace the linking to the correct version. This is also the cause of a bug where [renaming docs breaks links in old versions](https://github.com/facebook/docusaurus/issues/845). For Docusaurus 2, **every time we cut a new version, we will instead take a snapshot of all the docs**. We will not require the content of a document to have changed. This is a space complexity trade-off for a better developer and user experience. We will use more space for better separation of concerns and guaranteed correctness. @@ -117,7 +117,7 @@ As of now, we do not have an exact date planned for the release. I personally es One thing that I would like to share is that while Docusaurus is part of [Facebook Open Source](https://opensource.fb.com/) and most of the team are Facebook employees, the maintenance and development work is mostly done outside of normal working hours. I am currently a final year undergraduate student at [NTU Singapore](https://twitter.com/NTUsg), so I had to juggle between doing my coursework, my final year project and maintaining/developing Docusaurus. However, that does not mean that we do not want to make Docusaurus better. In fact, **we want to make it as awesome as possible**. -For now, the actual Docusaurus 2 work is still hosted in a private repository. In the near future, we will move them into the [public repository](https://github.com/facebook/Docusaurus). When that time arrives, I encourage everyone to look into it and hopefully contribute in some way. Before then, please stay tuned ๐Ÿ˜‰! +For now, the actual Docusaurus 2 work is still hosted in a private repository. In the near future, we will move them into the [public repository](https://github.com/facebook/docusaurus). When that time arrives, I encourage everyone to look into it and hopefully contribute in some way. Before then, please stay tuned ๐Ÿ˜‰! ## Final Thoughts @@ -131,4 +131,4 @@ If you are using Docusaurus, you are part of our community; keep letting us know > If you are sponsoring our work on [Open Collective](https://opencollective.com/Docusaurus), we'll personally offer you a helping hand for maintenance and upgrading of Docusaurus website. -Lastly, if you haven't done so already, click the **star** and **watch** button on [GitHub](https://github.com/facebook/Docusaurus), and follow us on [Twitter](https://twitter.com/docusaurus). +Lastly, if you haven't done so already, click the **star** and **watch** button on [GitHub](https://github.com/facebook/docusaurus), and follow us on [Twitter](https://twitter.com/docusaurus). diff --git a/website-1.x/pages/en/help.js b/website-1.x/pages/en/help.js index beb1188bc2..5cadbd1706 100644 --- a/website-1.x/pages/en/help.js +++ b/website-1.x/pages/en/help.js @@ -37,7 +37,7 @@ class Help extends React.Component { { title: GitHub, content: - 'At our [GitHub repo](https://github.com/facebook/docusaurus) Browse and submit [issues](https://github.com/facebook/Docusaurus/issues) or [pull requests](https://github.com/facebook/Docusaurus/pulls) for bugs you find or any new features you may want implemented. Be sure to also check out our [contributing information](https://github.com/facebook/Docusaurus/blob/master/CONTRIBUTING.md).', + 'At our [GitHub repo](https://github.com/facebook/docusaurus) Browse and submit [issues](https://github.com/facebook/docusaurus/issues) or [pull requests](https://github.com/facebook/docusaurus/pulls) for bugs you find or any new features you may want implemented. Be sure to also check out our [contributing information](https://github.com/facebook/docusaurus/blob/master/CONTRIBUTING.md).', }, ]; diff --git a/website-1.x/pages/en/index.js b/website-1.x/pages/en/index.js index 9b8c6ca3ae..ed4cf5577b 100644 --- a/website-1.x/pages/en/index.js +++ b/website-1.x/pages/en/index.js @@ -63,7 +63,7 @@ class Index extends React.Component {
We're working on{' '} - + Docusaurus 2 , contribute to its roadmap by suggesting features or giving diff --git a/website-1.x/versioned_docs/version-1.10.x/api-doc-markdown.md b/website-1.x/versioned_docs/version-1.10.x/api-doc-markdown.md index 3933a54a52..5e30e27576 100644 --- a/website-1.x/versioned_docs/version-1.10.x/api-doc-markdown.md +++ b/website-1.x/versioned_docs/version-1.10.x/api-doc-markdown.md @@ -51,7 +51,7 @@ For example: --- id: doc-markdown title: Markdown Features -custom_edit_url: https://github.com/facebook/Docusaurus/edit/master/docs/api-doc-markdown.md +custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md --- ``` diff --git a/website-1.x/versioned_docs/version-1.10.x/getting-started-publishing.md b/website-1.x/versioned_docs/version-1.10.x/getting-started-publishing.md index e88b911744..ddcede42ec 100644 --- a/website-1.x/versioned_docs/version-1.10.x/getting-started-publishing.md +++ b/website-1.x/versioned_docs/version-1.10.x/getting-started-publishing.md @@ -22,7 +22,7 @@ At this point, you can grab all of the files inside the `website/build` director > For example, both Apache and Nginx serve content from `/var/www/html` by default. That said, choosing a web server or provider is outside the scope of Docusaurus. -> When serving the site from your own web server, ensure the web server is serving the asset files with the proper HTTP headers. CSS files should be served with the `content-type` header of `text/css`. In the case of Nginx, this would mean setting `include /etc/nginx/mime.types;` in your `nginx.conf` file. See [this issue](https://github.com/facebook/Docusaurus/issues/602) for more info. +> When serving the site from your own web server, ensure the web server is serving the asset files with the proper HTTP headers. CSS files should be served with the `content-type` header of `text/css`. In the case of Nginx, this would mean setting `include /etc/nginx/mime.types;` in your `nginx.conf` file. See [this issue](https://github.com/facebook/docusaurus/issues/602) for more info. ### Hosting on a Service: diff --git a/website-1.x/versioned_docs/version-1.10.x/guides-navigation.md b/website-1.x/versioned_docs/version-1.10.x/guides-navigation.md index a76b75bc62..f98f62572f 100644 --- a/website-1.x/versioned_docs/version-1.10.x/guides-navigation.md +++ b/website-1.x/versioned_docs/version-1.10.x/guides-navigation.md @@ -203,7 +203,7 @@ Custom links can be added to the site navigation bar with the following entry in { headerLinks: [ ... - { href: 'https://github.com/facebook/Docusaurus', label: 'GitHub' }, + { href: 'https://github.com/facebook/docusaurus', label: 'GitHub' }, ... ], ... diff --git a/website-1.x/versioned_docs/version-1.12.0/api-doc-markdown.md b/website-1.x/versioned_docs/version-1.12.0/api-doc-markdown.md index 619fbb5911..ca3fbf479d 100644 --- a/website-1.x/versioned_docs/version-1.12.0/api-doc-markdown.md +++ b/website-1.x/versioned_docs/version-1.12.0/api-doc-markdown.md @@ -51,7 +51,7 @@ For example: --- id: doc-markdown title: Markdown Features -custom_edit_url: https://github.com/facebook/Docusaurus/edit/master/docs/api-doc-markdown.md +custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md --- ``` diff --git a/website-1.x/versioned_docs/version-1.12.0/getting-started-publishing.md b/website-1.x/versioned_docs/version-1.12.0/getting-started-publishing.md index 18cd7853f2..33e65ba5ba 100644 --- a/website-1.x/versioned_docs/version-1.12.0/getting-started-publishing.md +++ b/website-1.x/versioned_docs/version-1.12.0/getting-started-publishing.md @@ -22,7 +22,7 @@ At this point, you can grab all of the files inside the `website/build` director > For example, both Apache and Nginx serve content from `/var/www/html` by default. That said, choosing a web server or provider is outside the scope of Docusaurus. -> When serving the site from your own web server, ensure the web server is serving the asset files with the proper HTTP headers. CSS files should be served with the `content-type` header of `text/css`. In the case of Nginx, this would mean setting `include /etc/nginx/mime.types;` in your `nginx.conf` file. See [this issue](https://github.com/facebook/Docusaurus/issues/602) for more info. +> When serving the site from your own web server, ensure the web server is serving the asset files with the proper HTTP headers. CSS files should be served with the `content-type` header of `text/css`. In the case of Nginx, this would mean setting `include /etc/nginx/mime.types;` in your `nginx.conf` file. See [this issue](https://github.com/facebook/docusaurus/issues/602) for more info. ### Hosting on a Service: diff --git a/website-1.x/versioned_docs/version-1.9.x/api-doc-markdown.md b/website-1.x/versioned_docs/version-1.9.x/api-doc-markdown.md index a7b1496545..fdc7605c2f 100644 --- a/website-1.x/versioned_docs/version-1.9.x/api-doc-markdown.md +++ b/website-1.x/versioned_docs/version-1.9.x/api-doc-markdown.md @@ -51,7 +51,7 @@ For example: --- id: doc-markdown title: Markdown Features -custom_edit_url: https://github.com/facebook/Docusaurus/edit/master/docs/api-doc-markdown.md +custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md --- ``` diff --git a/website-1.x/versioned_docs/version-1.9.x/getting-started-installation.md b/website-1.x/versioned_docs/version-1.9.x/getting-started-installation.md index 5774df9c71..64cefdcfcd 100644 --- a/website-1.x/versioned_docs/version-1.9.x/getting-started-installation.md +++ b/website-1.x/versioned_docs/version-1.9.x/getting-started-installation.md @@ -99,7 +99,7 @@ info Color legend : "" : Minor Update backward-compatible features "" : Patch Update backward-compatible bug fixes Package Current Wanted Latest Package Type URL -docusaurus 1.0.9 1.2.0 1.2.0 devDependencies https://github.com/facebook/Docusaurus#readme +docusaurus 1.0.9 1.2.0 1.2.0 devDependencies https://github.com/facebook/docusaurus#readme โœจ Done in 0.41s. ``` diff --git a/website-1.x/versioned_docs/version-1.9.x/getting-started-publishing.md b/website-1.x/versioned_docs/version-1.9.x/getting-started-publishing.md index 6780f26f08..55113b7a4a 100644 --- a/website-1.x/versioned_docs/version-1.9.x/getting-started-publishing.md +++ b/website-1.x/versioned_docs/version-1.9.x/getting-started-publishing.md @@ -22,7 +22,7 @@ At this point, you can grab all of the files inside the `website/build` director > For example, both Apache and nginx serve content from `/var/www/html` by default. That said, choosing a web server or provider is outside the scope of Docusaurus. -> When serving the site from your own web server, ensure the web server is serving the asset files with the proper HTTP headers. CSS files should be served with the `content-type` header of `text/css`. In the case of nginx, this would mean setting `include /etc/nginx/mime.types;` in your `nginx.conf` file. See [this issue](https://github.com/facebook/Docusaurus/issues/602) for more info. +> When serving the site from your own web server, ensure the web server is serving the asset files with the proper HTTP headers. CSS files should be served with the `content-type` header of `text/css`. In the case of nginx, this would mean setting `include /etc/nginx/mime.types;` in your `nginx.conf` file. See [this issue](https://github.com/facebook/docusaurus/issues/602) for more info. ### Hosting on a Service: diff --git a/website-1.x/versioned_docs/version-1.9.x/guides-navigation.md b/website-1.x/versioned_docs/version-1.9.x/guides-navigation.md index e7fe7c9c15..c22886704b 100644 --- a/website-1.x/versioned_docs/version-1.9.x/guides-navigation.md +++ b/website-1.x/versioned_docs/version-1.9.x/guides-navigation.md @@ -203,7 +203,7 @@ Custom links can be added to the site navigation bar with the following entry in { headerLinks: [ ... - { href: 'https://github.com/facebook/Docusaurus', label: 'GitHub' }, + { href: 'https://github.com/facebook/docusaurus', label: 'GitHub' }, ... ], ... diff --git a/website/docs/contributing.md b/website/docs/contributing.md index 8e158e3642..86a93873fc 100644 --- a/website/docs/contributing.md +++ b/website/docs/contributing.md @@ -48,7 +48,7 @@ We use [GitHub Issues](https://github.com/facebook/docusaurus/issues) for our pu If you have questions about using Docusaurus, contact the Docusaurus Twitter account at [@docusaurus](https://twitter.com/docusaurus), and we will do our best to answer your questions. -You can also file issues as [feature requests or enhancements](https://github.com/facebook/Docusaurus/labels/feature%20request). If you see anything you'd like to be implemented, create an issue with [feature template](https://raw.githubusercontent.com/facebook/docusaurus/master/.github/ISSUE_TEMPLATE/feature.md) +You can also file issues as [feature requests or enhancements](https://github.com/facebook/docusaurus/labels/feature%20request). If you see anything you'd like to be implemented, create an issue with [feature template](https://raw.githubusercontent.com/facebook/docusaurus/master/.github/ISSUE_TEMPLATE/feature.md) ### Reporting security bugs @@ -138,7 +138,7 @@ Please make sure the following is done when submitting a pull request: 1. Fork [the repository](https://github.com/facebook/docusaurus) and create your branch from `master`. 2. Add the copyright notice to the top of any code new files you've added. -3. Describe your [**test plan**](#test-plan) in your pull request description. Make sure to [test your changes](https://github.com/facebook/Docusaurus/blob/master/admin/testing-changes-on-Docusaurus-itself.md)! +3. Describe your [**test plan**](#test-plan) in your pull request description. Make sure to [test your changes](https://github.com/facebook/docusaurus/blob/master/admin/testing-changes-on-Docusaurus-itself.md)! 4. Make sure your code lints (`yarn prettier && yarn lint`). 5. Make sure your Jest tests pass (`yarn test`). 6. If you haven't already, [sign the CLA](https://code.facebook.com/cla). diff --git a/website/src/pages/index.js b/website/src/pages/index.js index 0d9d038b82..6a16bb0c7e 100644 --- a/website/src/pages/index.js +++ b/website/src/pages/index.js @@ -105,7 +105,7 @@ function Home() {
We're working on{' '} - + Docusaurus 2 , contribute to its roadmap by suggesting features or giving{' '}