Skip to content

Latest commit

 

History

History
1224 lines (851 loc) · 60.9 KB

CHANGELOG.md

File metadata and controls

1224 lines (851 loc) · 60.9 KB
Raw

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

Unreleased

1.14.0 - 2019-10-20

Added

  • feat: allow specifying meta desc in front matter (#1859)

Docs

  • docs: document docker is optional (#1848)

1.13.0 - 2019-09-15

Fixed

  • fix: content aligning breaks at IE11 (#1684)
  • fix: footer links margin (#1781)
  • feat: strip html from TOC (#1762)

Docs

  • docs: document what should be in .gitignore (#1709)
  • docs: change separateCSS to separateCss (#1735)
  • docs: fix documented type for the cleanUrl option (#1775)
  • docs: improve tutorial

1.12.0 - 2019-07-20

Changes

Added

  • feat: add "unlisted" front matter option for blog posts (#1396)
  • feat: use primary color for highlighted items in table of contents (#1628)

Chores

  • Upgrade a lot of dependencies to fix security vulnerabilities (#1668)

Fixed

  • fix: remove the Container component from the docsNavContainer (#1599)
  • fix: require babel dependencies directly (#1575)
  • fix: replace apostrophe with empty string in header slugification (#1618)
  • fix: wrong bootstrapped footer social links (#1647)
  • fix: PostCSS warning on build command (#1664)
  • fix: dont render html for meta description (#1672)

Docs

  • docs: fix reference to publishing steps (#1613)
  • docs: minor grammar fix in blog guide (#1614)
  • docs: Fix Rendering of <AUTOGENERATED_TABLE_OF_CONTENTS> Tag on API - Markdown Features Page (#1617)
  • docs: add Render hosting guide (#1615)

1.11.1 - 2019-06-08

A bunch of dependency upgrades to resolve security issues.

1.11.0 - 2019-05-30

We added a new feature of highlighting the table of contents on the right side as you scroll the docs pages. A few bugs affecting local development were also fixed. More notably, the blog's left sidebar will not hide the post titles when docsSideNavCollapsible is turned on. This is a bugfix/backward-incompatible change depending on how you view it, but probably nobody wanted that collapsing behavior on the blog sidebar.

We also welcome @wgao19 to the core team! She'll be helping us with Docusaurus 2 work leveraging on her experience writing documentation and CSS!

Changes

  • fix: reload siteConfig.js automatically when locally served page is refreshed (#1509)
  • fix: don't collapse the blog navigation even if collapsible is true (#1519)
  • fix: enable live reloading title of doc (#1507)
  • feat: highlight nav item in onPageNav ToC (#1524)

1.10.0 - 2019-05-21

This version mainly include many bug fixes and a new feature to use different host other than localhost through CLI flag.

Other than that, we also made some significant progress on Docusaurus 2 development. In the near future, we'll be rolling out the alpha version publicly to maximize community participation and feedback. Please stay tuned 😉

Thank you to following contributors:

  • @endiliey
  • @yangshun
  • @zachbadgett
  • @yangshun
  • @endiliey
  • @shakcho
  • @Hongarc
  • @qiu8310
  • @jamesgeorge007
  • @Alireza
  • @TurekBot
  • @wgao19
  • @palmer-cl

Main Changes

1.9.0 - 2019-4-29

In preparation of F8 where @yangshun will be holding a classroom session on building a Docusaurus site, we've added a tutorial to teach people how to create a versioned Docusaurus site.

We also revamped the docusaurus-init script such that the theme colors are random and you partnered with unDraw to generate illustrations that match your theme color! Check it out!

The sidebar icon on mobile screens have been changed to a more conventional hamburger style icon which is more intuitive. If you customized that part, check if your site's layout broke because of it.

Lastly, welcome Pulsar, Mockit and React Testing Library as users!

Thank you to the following contributors:

  • @endiliey
  • @yangshun
  • @Alan-Cha
  • @ntucker
  • @wilsonmar
  • @NishealJ
  • @Hongarc

Fixed/Added

  • docs: consistent badge style (#1371)
  • fix: prism syntax highlight .tsx properly (#1391)
  • feat: add tutorial (#1381)
  • feat: change icon for navToggle (#1394)
  • fix: blog docs example as object property (#1403)
  • docs: docs-examples-from-docusaurus is now installed as doc (#1406)
  • fix: upgrade underscore.string to 3.3.5 (#1404)

1.8.1 - 2019-4-15

We accidentally published 2.0.0-alpha.5 as latest on npm. Please do not use that and instead use the 1.x version.

1.8.0 - 2019-3-30

This version mainly include bug fixes and a new feature to skip the next release documents when versioning is enabled.

Thank you to the following contributors:

  • @yangshun
  • @endiliey
  • @vikrantsinghthakur
  • @parthpp

Fixed/Added

  • feat: Add --skip-next-release option to yarn build (#1292)
  • fix: handle case insensitive table of contents token (#1288)
  • fix: anchors links for underscore character (#1309)
  • fix: autogenerated versions.js should not be confusing (#1314)

Internal

  • Change Docusaurus landing page (#1290)
  • We restructured our repository as a monorepo (#1297)
  • We folded docusaurus versions (e.g: 1.1.0, 1.1.1, 1.1.2 -> 1.1.x) (#1313)
  • optimize docusaurus continuous integration (#1308)

1.7.3 - 2019-3-19

This version mainly includes bug fixes found in 1.7.0 that improves stability.

Thank you to the following contributors who helped with this release:

  • @zpao
  • @jeromesimeon
  • @yangshun
  • @bartanthonissen
  • @YoshinoriN
  • @marvinchin
  • @sinchange
  • @githubsaturn
  • @fiennyangeln
  • @ahtee
  • @endiliey
  • @ael-mas
  • @natemago
  • @co16353sidak
  • @CPSTL
  • @alexkrolick

Fixed/Changed

  • Update code.facebook.com links to appropriate new destination (#1224)
  • docs: showcase user accord-project (#1225)
  • fix: change mainContainer padding to align with sidebars
  • docs: mention about CNAME option in publishing docs (#1227)
  • docs: add ScanTrust to users (#1228)
  • chore: upgrade husky to 1.3.1 (#1229)
  • Remove more references to code.facebook.com (#1231)
  • fix: use clean url for og:url when cleanUrl is true (#1242)
  • fix: hovering algolia logo break its background color (#1240)
  • docs: update CaptainDuckDuck to CapRover (#1244)
  • chore: rename siteConfig.js to docusaurus.config.js (#1245)
  • fix: make referenced links work with code block tabs (#1249)
  • docs: showcase user Scalafmt (#1250)
  • fix: wrong sidebar_label and title on versioned_docs (#1265)
  • docs: update api-pages.md to document about overriding default styles (#1266)
  • fix: upgrade jest to remove security vulnerability (#1276)
  • docs: showcase user Microkubes (#1274)
  • docs: showcase user Twirp (#1275)
  • docs: add Polymath to users (#1276)
  • fix: relative path markdown linking on versioned docs (#1281)
  • fix(codetabs): fix key warning (#1284)

1.7.2 - 2019-1-28

Minor fixes and improvements to some of the features introduced in 1.7.0.

Fixed/Changed

  • fix: horizontal overflow in collapsible sidebar (#1205)
  • fix: docs asset links should follow specified docsUrl (#1204)
  • fix: make search bar taller on widescreen (#1210)
  • fix: change sidebar chevron icon to use svg (#1211)

1.7.1 - 2019-1-24

HOTFIX

imagemin got pushed down into developer dependencies, breaking the build. This fixes that.

Fixed/Changed

  • fix: revert image-min back to dependencies (#1201)

1.7.0 - 2019-1-23

It's the first release of the year! We've fixed a number of layout bugs and shipped a few significant new features such as:

  • Collapsible sidebar - Especially useful for pages with long list of items.
  • Language-specific Code Tabs - Great for documentations that target multiple languages.

We also welcome a ton of new users: Node Serialport, TypeGraphQL, React Native Sensors, FBT, KaTeX, Redux, and React Leaflet.

Thank you to the following contributors who helped with this release:

  • @teimurjan
  • @ahmadalfy
  • @mikeattara
  • @19majkel94
  • @jrwats
  • @haoqiang
  • @zkochan
  • @marvinchin
  • @YifanM
  • @SimenB
  • @zakariaharti
  • @tsmrachel
  • @fiennyangeln

Fixed/Changed

  • fix: edit url should support versioned subdirectories (#1154)
  • fix: gap on mobile devices when scrolling (#1157)
  • chore: update imagemin and its dependencies (#1162)
  • fix: pass docusaurus-publish cli args to build command (#1185)
  • fix: missing default value for grid block content objects (#1186)
  • fix: add margin-bottom: 0 to blog post author (#1193)
  • fix: wrong padding for single row mobile nav (#1191)

Added

  • feat: collapsible categories (#1128)
  • feat: code block tab (#1063)

1.6.2 - 2018-12-7

Hotfix for 1.6.1. We overlooked a critical bug caused by hardcoded path on PR #1143. Please upgrade to 1.6.2, we are going to npm deprecate 1.6.1.

1.6.1 - 2018-12-7

This version mainly includes bug fixes found in 1.6.0 that improves stability.

Thank you to the following contributors who helped with this release:

  • @endiliey
  • @jakebolam
  • @JoelMarcey
  • @morleym
  • @thecodechef
  • @tsmrachel

Fixed/Changed

  • Fix docusaurus-version compilation error for subdirectory (cb1395)
  • Fix relative path markdown linking (#1138)
  • Fix static files in blog/assets not working (#1143)

Added

  • Allow custom commit message for publish-gh-pages (#1136)

1.6.0 - 2018-12-1

This releases includes few bug fixes and features. One notable feature allows user to change/remove docs prefix from the generated docusaurus URL.

Welcome to our newest users, React-Slate, Hemera, React-Redux, Spectrum, TorchCraftAI, and Haul.

Thank you to the following contributors who helped with this release:

  • @yangshun
  • @endiliey
  • @JoelMarcey
  • @andrewShillito
  • @kahkhang
  • @domcorvasce
  • @ellereeeee
  • @maxaggedon
  • @gianlucadonato
  • @tsmrachel
  • @Shriram-Balaji
  • @noraj
  • @alexperez
  • @wgao19

Fixed/Changed

  • Live reload not working on second try (#1103)
  • Fix missing TOC on i18n pages (#1119)
  • Fix docusaurus-version not working for subcategory in sidebar (#1124)
  • Fix docusaurus-version to allow duplicate id in different subdirectory (#1125)

Docs

  • Add guide on setting custom docs path (#1098)
  • Document that website folder can be renamed (#1106)
  • Specify markdown flavor (#1118)

Added

  • Allow modifying/removing docs route in generated url (#914)
  • Use sidebar_label in addition to title for prev/next button (#1122)
  • Warn the users if any unresolved markdown links (#1116)
  • Customizable search placeholder (#1126)

1.5.1 - 2018-11-03

A release where we had many external contributors! Very excited to see the community being involved in the project.

Welcome to our newest users, Create React App, Stackery, Vasern, Noderize, React 360 and Formik.

Thank you to the following contributors who helped with this release:

  • @yangshun
  • @endiliey
  • @JoelMarcey
  • @tanhauhau
  • @fiennyangeln
  • @vikr01
  • @alexdriedger
  • @hobofan
  • @bildungsroman
  • @tirthbodawala
  • @M4rk9696
  • @sinodko
  • @aenuros
  • @SleepWalker
  • @pdyx2828
  • @phated
  • @huguestennier
  • @gtoprak
  • @Rajekevin
  • @sunitasen
  • @shahednasser

Fixed/Changed

  • Throw error when forgot to pass in GIT_USER (#1035)
  • Exclude file movements for last updated time (#1023)
  • Update support for Web App Manifest (#1046)
  • Render proper HTML instead of raw markdown in og:description (#1054)

Added

  • New feature of displaying the last contributor to each document (#980)
  • Document how to add "Copy" button to code blocks (#1047)
  • Support reference-style linking in documents (#1048)
  • Add caption to user page links (#1075)

Removed

1.5.0 - 2018-10-13

This version introduces a big improvement to the sidebar, where you can now have subcategories.

Welcome to our newest user, Skip.

Thank you to the following contributors who helped with this release:

  • @endiliey
  • @yangshun
  • @JoelMarcey
  • @tom-auger
  • @muuvmuuv
  • @DABH
  • @Atul9
  • @fiennyangeln
  • @amyrlam
  • @ersul4ik
  • @WillBrock
  • @third774
  • @tanhauhau

Fixed/Changed

  • Use dark mode color scheme for footer like button (#959)
  • Fix highlightjs custom highlighting function (#1016)

Added

  • Live reload port fallback if port is used (#899)
  • Added option for client to include their own remarkable config (#974)
  • Enabled subcategories in sidebar (#892) (#1026)
  • Add keyboard shortcut to focus on search box (#1028)

Chore and Maintenance

  • Upgrade to babel 7 for v1 (#995)
  • Fix typo in Getting Started docs (#1013)
  • Reorganized siteConfig (#1027)

1.4.0 - 2018-09-11

Welcome to our newest users, FuseBox and Bowler.

Thank you to the following contributors who helped with this release:

  • @endiliey
  • @joelmarcey
  • @yangshun
  • @ericnakagawa
  • @notlmn
  • @nchanged
  • @sbansal3096
  • @notjaril
  • @tirthbodawala
  • @wszgxa
  • @EthanMarrs
  • @fiennyangeln
  • @ashwini0529

Fixed/Changed

  • Fix nested static in static folder breaks build (#953)
  • Fix cleanUrl transformation unintentionally removing extension (#923)
  • Fix conflicting strings in translations (#917)
  • Header navigation now links to blog/, not blog (#936)
  • Fix button wrapping behavior on mobile (#921)
  • Fix wrong header navigation linking to a doc without translation (f1daddb)
  • Fixed navigation so that it takes full width on a docs (#935)

Added

  • Allow user to add last updated time info on doc (#913)
  • Support for user's own Web App Manifest in siteConfig (#934)
  • Add docker file & documentation (#936)
  • New docusaurus project has a better starting README (#930)
  • Enable passing object to script and link (#937)

Chore and Maintenance

  • New template for Documentation issue (39b7793)
  • Add new blog post about upcoming Docusaurus 2 (#952)
  • Fix broken sponsor images in README (#951)
  • Fix wrong user image URL (89f49b0)

1.3.3 - 2018-08-22

Welcome to our newest users, atalaya, Reaction Commerce, Plus (ThinkSNS+) and nteract.

Thank you to the following contributors who helped with this release:

  • @endiliey
  • @joelmarcey
  • @yangshun
  • @apuravchauhan
  • @dballance
  • @helloworld
  • @jreese
  • @machikoyasuda
  • @medz
  • @mikalai-silivonik
  • @miralemd
  • @monkeywithacupcake
  • @parano
  • @patapizza
  • @shaform
  • @steevehook
  • @theletterf
  • @tom-auger
  • @willingc

Added

  • Add autoprefixing to CSS pipeline #867
  • Support text language for code block style without any highlighting #875

Fixed/Changed

  • Fix wrong CSS language prefix for fenced blocks #842 #870
  • Fix phrase emphasis not italicized #850
  • Don't replace static assets linking in fenced code blocks #864
  • Blogpost summary for blog feed is now properly truncated #880
  • Fix failure to copy static image if image compression fail #887
  • Fix: correct docs linking for custom defaultVersionShown #894
  • Fix incorrect sitemap url for non default baseUrl #902
  • Stricter css/main.css routing on development server #904
  • Fix console error when onPageNav !== 'separate' #909

Docs

  • Add documentation regarding usage of nested docs/ subdirectory #860
  • Improve baseUrl documentation with an example #863
  • Fix Table of contents documentation typo #873
  • Update installation doc #888 #900
  • Update guides-translations.md for CircleCI 2.0 92f95d

Chore and Maintenance

  • Add ESLint #836 #837 #841 #846
  • Refactor & add more tests for Docusaurus #839 #847 #854 #856
  • Docusaurus own search will now search the docs in the correct language & version #859
  • Improve readme #866
  • Add prerelease script for Docusaurus #876
  • Remove unused files #881
  • Update code of conduct 3c1363d
  • Update jest to v23 #885
  • Activating Open Collective #883
  • Fix Jest tests that fail on Windows #896
  • Rename Sonar to Flipper #905

1.3.2 - 2018-07-06

This version mainly includes bug fixes found in 1.3.1 that improves stability and UX improvements.

Welcome to our newest user, single-spa, a framework that allows you to use multiple front end frameworks in one SPA.

Thank you to the following contributors who helped with this release:

  • @endiliey
  • @chenglou

Fixed/Changed

  • Fix wrong sitemap for alternate URLs (#828)
  • Publish-gh-pages should display the correct commit that triggers it (#829)
  • Fix missing Facebook like buttons in blog posts (#821)
  • Open browser with the correct baseUrl during development (#819)
  • Fix Edit button alignment in Docs (#819)

1.3.1 - 2018-06-30

This version mainly includes bug fixes found in 1.3.0 that improves stability.

Thank you to the following contributors who helped with this release:

  • @endiliey
  • @yangshun
  • @RhysBower
  • @ngyikp

Fixed/Changed

1.3.0 - 2018-06-20

1.3.0 introduces a brief clean up of our CSS, overall site typography and some improvements to Algolia search.

Welcome to our newest user, ml5, a really cool machine library in JavaScript.

Thank you to the following contributors who helped with this release:

  • @endiliey
  • @JoelMarcey
  • @yangshun

Breaking changes

  • Since we made some CSS changes, there's a good chance it might not be compatible with your custom CSS if you have any. We recommend that you audit each page of the site for any UI issues caused by this change. We'll try to minimize such backward-incompatible CSS changes in future.
  • Other UI changes include:
    • Left sidebar is sticky by default on supported browsers. We saw many of our users write custom CSS for that behavior and decided to incorporate it in the core.
    • Footer is now a darker shade of black for better contrast.
    • Background color of site changed to #fff.
    • Headers are now black (from $primaryColor) and have bolder font weight.
    • Blockquotes are changed to yellow (from pink).

Fixed/Changed

  • The search input will now search the docs in the correct language.
  • Algolia will be able to scrap emulti-language and/or versioned sites better with the introduction of special meta tags.

Added

N/A

Removed

N/A

1.2.1 - 2018-06-17

Fixes from existing issues and those found in the 1.2.0 release. Fixes include being able to modify the metadata of a doc without resorting to deleting en.json, using absolute URLs instead of relative for docs links, and more. We also added a few new things as well.

Welcome to our newest users, Babel, Sonar, Metro, StreamPipes, and rest-hapi.

Thank you to the following contributors who helped with this release:

  • @endiliey
  • @yangshun
  • @Kelltimo
  • @ayshiff
  • @rupeshparab
  • @gustavohenke
  • @maxogden
  • @jonathaningram
  • @dominikriemer
  • @anru
  • @Rendez
  • @Thai56
  • @JKHeadley

Breaking changes

  • This may not affect many users, but if you modified the en.json to add your own custom translation strings, we changed how this is handled, and you will need to follow the instructions here to modify your setup.

Added

Fixed/Changed

  • 1.2.0 introduced a bug where you could not update documentation metadata without deleting en.json. This has been fixed as part of the custom translation string breaking change.
  • Absolute URLs are now used 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.
  • No more errors if heading anchors are empty.
  • Fixed bug when renaming version where sidebars.json were not getting updated.
  • Table of contents are now hidden when onPageNav is not separate.

Removed

N/A

1.2.0 - 2018-06-10

A major point release. This release adds highly requested features, including extension-less URLs, nested directories for docs and adding a second option (Prism) for syntax highlighting.

Welcome to our newest users, pnpm and Anssr Data.

A special thank you to @endiliey who has come in and did awesome work for Docusaurus. @endiliey is now an official maintainer of the Docusaurus repo because of his efforts.

Thank you to the following contributors who helped with this release:

  • @endiliey
  • @yangshun
  • @gimdongwoo
  • @balloob
  • @zkochan
  • @gustavohenke
  • @ranolf
  • @Themandunord
  • @ericnakagawa
  • @vacarsu
  • @SleepWalker
  • @brenopolanski
  • @skratchdot

Breaking changes

None that we know of. Please let us know if you find any as this is a big release and we may have missed something.

Added

Fixed/Changed

  • For better SEO, we now support meta:description.
  • Existing translation files are now loaded correctly.
  • URLs properly resolve no matter which language you are currently viewing.
  • Atom and RSS feed links are fixed for xxx.github.io sites.
  • Version pages link to the correct language, depending on the current language.
  • Do not start server if versions.js is missing and versioning is enabled.
  • Fail properly when current branch is the same as the deployment one.
  • Assets not found bug fixed in Windows.
  • OnPageNav now works on mobile devices.
  • Remove extra padding in code blocks.
  • Better gitignore for docusaurus-init
  • Documentation fixes: 123.

Removed

N/A

1.1.5 - 2018-05-26

Hotfix. A package in devDependencies needed to be moved to dependencies.

1.1.4 - 2018-05-25

Yet another hotfix release. We found an issue with the way we did LiveReload - we were watching the node_modules directory and that caused some users to encounter errors. We stopped watching node_modules directory in gaze.

Thank you to the following contributors who helped with this release:

  • @artiebits
  • @yangshun

Fixed/Changed

1.1.3 - 2018-05-23

npm had an issue where some packages were not being published. This should hopefully be resolved now; publishing a new version just in case.

Also, welcome TextLint and Open Power Quality as new users.

Thank you to the following contributors who helped with this release:

  • @azu
  • @philipmjohnson
  • @violabg
  • @sebelga

Fixed/Changed

  • onPageNav now shows in Safari.

1.1.2 - 2018-05-21

Another HOTFIX release. One of our third-party dependencies, tree-node-cli didn't support Node 10+. The package has been fixed and we have updated to use the new version of that package.

1.1.1 - 2018-05-21

HOTFIX release. Dependency bug found.

Fixed/Changed

  • opn needs to be installed, 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:

There are a lot of other fixes and enhancements as well. Also, we have five new users of Docusaurus within this release as well. Thank you to WarriorJS, Bemuse, Pyre-Check, Draft.js and CaptainDuckDuck for using Docusaurus.

There are also various documentation fixes as well.

We think this is a good release.

Thank you to the following contributors who helped with this release:

  • @yangshun
  • @amyrlam
  • @gedeagas
  • @ahmadalfy
  • @endiliey
  • @zpao
  • @NoamELB
  • @sujono91

Breaking Changes

Added

  • Live Reload 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 to the correct localhost page.
  • There is now a build option, --skip-image-compression, to compress your images.
  • You can now add Twitter and Facebook social buttons to the footer.
  • The blog now allows for Facebook-based comments.
  • A warning is now shown if you use versioning without a version.js file.

Fixed/Changed

  • Various UI fixes
  • Directory tree printed during docusaurus-init.

Removed

[1.0.15] - 2018-05-06

This release has a lot of commits, including bug fixes, documentation updates, as well as a bit of new functionality. A new blog post from @caabernathy about how easy it is to create a Docusaurus site, a lot of Windows fixes, the ability to specify the default version shown, and more.

Thank you to the following contributors who have helped with this release:

  • @yangshun
  • @amyrlam
  • @caabernathy
  • @szeck87
  • @dgracehmh
  • @balloob
  • @ramiel
  • @AmitHarlev
  • @pixelastic
  • @SoonaMata
  • @olistic
  • @SleepWalker
  • @Airse
  • @ahmadalfy
  • @zenflow

Breaking changes

N/A

Added

Fixed/Changed

Removed

N/A

1.0.14 - 2018-04-23

Small release mostly for documentation.

Thank you to the following contributors who have helped with this releae:

  • @yangshun
  • @ericnakagawa
  • @shikaan
  • @longility

Breaking changes

N/A

Added

N/A

Fixed/Changed

  • Blog metadata now refreshed on changes to blog posts.

Removed

N/A

1.0.13 - 2018-04-20

This is primarily a bug fix release.

Thank you to the following contributors who helped with this release:

  • @vjeux
  • @huang-x-h

Breaking changes

N/A

Added

Fixed/Changed

  • Do not warn when using layout in the docs metadata header.
  • Restore the ability to use the --port command line argument

Removed

N/A

1.0.12 - 2018-04-18

This is a general release with additions and documentation updates. We would also like to welcome React Native Elements as a user of Docusaurus.

https://docusaurus.io has turned on versioning. There are other documentation updates as well.

We turned on translations, but found a bug. So we turned it off until we fix it.

Thank you to the following contributors who helped with this release:

  • @yangshun
  • @amyrlam
  • @SleepWalker
  • @InternetExplorer7
  • @zkochan
  • @iRoachie
  • @limonte

Breaking changes

Added

Fixed/Changed

Removed

N/A

1.0.11 - 2018-04-12

This is a general release with additions and documentation updates (which are already live on docusaurus.io). We would also like to welcome BlueWhale as a new user of Docusaurus.

Thank you to the following contributors who helped with this release:

  • @amyrlam
  • @yangshun
  • @aadsm
  • @InternetExplorer7
  • @MisterTea
  • @SBrown2

Breaking changes

N/A

Added

Fixed/Changed

  • If you have translations enabled, the language drop down in the header navigation bar is now fixed to show the current language.
  • More accessibility fixes to support a11y.

Removed

N/A

1.0.10 - 2018-04-09

This is a general release with mostly bug fixes and documentation updates (which are already live on docusuarus.io).

Breaking Changes

N/A

Added

Fixed/Changed

Removed

N/A

1.0.9 - 2018-03-13

This is a hotfix release

A bug was found in the using path functions commit by @sunnylqm. Total commits in this release is 4, including the release itself.

Breaking Changes

N/A

Added

Fixed/Changed

Removed

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 with Windows that were occurring, particularly when building the docs, both locally and publishing, as well as addressing an issue for support for a secondary, on-page sidebar for local page navigation, which is now enabled for docusaurus.io. Total commits in this release is 27, including the release itself.

Breaking Changes

N/A

Added

Fixed/Changed

Removed

N/A

1.0.7 - 2018-02-17

This is a hotfix release

A couple of bugs were found in our versioning system that would make versioning unusable in some scenarios. Thank you to @iRoachie for finding these. This release also contains a better header link scroll on mobile. Total commits in this release is 6, including the release itself.

Breaking Changes

N/A

Added

Fixed/Changed

Removed

N/A

1.0.6 - 2018-02-12

This is a bigger release than normal as it has been a month since releases. It contains bug fixes, duplicate code removal, a few new features, and documentation updates. Total commits in this release is 38, including the release itself.

Breaking Changes

N/A

Added

Fixed/Changed

  • Blog feeds now show HTML, not markdown (#407, thanks @tom-auger)
  • Chinese translation infra (#377, thanks @chenglou)
  • Margin for right-aligned images (#398, thanks @rickhanlonii)
  • Correct HTTP status code sent on redirects (#408)
  • Non-English versioned docs metadata parsed correctly (#412, thanks @sunnylqm)
  • Provide Algolia information about the latest and current version (#418)
  • Remove key errors when running local server (#425, thanks @hshoff)
  • Links fixed in blog Atom feed (#421, thanks @hramos)

Removed

N/A

1.0.5 - 2018-01-09

This is a targeted bug fix release, with some documentation updates and Docusaurus repo housekeeping in between. Total commits in this release is 13, including the release itself.

Breaking Changes

N/A

Added

N/A

Fixed/Changed

  • Docusaurus builds on Windows (PR #381, thanks @qcz).
  • Fixed publishing for user/org GitHub sites (as opposed to project sites) (PR #384).
  • Clarification and updates on the publishing and API documentation (PR #372).

Removed

N/A

1.0.4 - 2017-12-27

This is generally a bug fix release, with some code refactoring. Total commits in this release is 58.

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 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

  • lang property added on html tag, if a language exists and is set (PR #295).
  • Added the wrapPagesHTML configuration option (PR #332).
  • Some adming docs on how to debug with VSCode (PR #335).
  • Added docs for the useEnglishURL configuration option.

Fixed/Changed

  • Links on landing page in docusaurus-init test site do not 404 any longer.
  • Refactoring how we check for translations and versioning (PRs #322/#316 and friends).
  • Refactored the example index.js page (PR #293).
  • Link errors, typos and grammatical errors in the docusuarus.io documentation.

Removed

N/A

[1.0.3] - 2017-12-13

Added

  • Docusaurus released to the public.
    • Initialization script
    • Versioning
    • Translations
    • Search
    • Blog
    • Documentation