docusaurus/CHANGELOG.md

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

• Dynamic port switching (e.g., if the default is busy) when running the local server.
• Warnings if you add documentation header metadata that is not supported.
• The ability to hide the documentation title 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 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

• Added Facebook Pixel ID as a configuration option, 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
• On page navigation fixes, including its scroll height, better table of contents, and other fixes, thanks @microbouji.
• Cleaned up example pages, thanks @Happy-Ferret.
• Better alignment of the sitemap in the footer, thanks @ryzokuken.
• Accessibility fixes around images and links, thanks @amyrlam and @yangshun.

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

• Docs for the secondary, on-page navigation option.

Fixed/Changed

• Fix wrong versioned_docs file path, thanks @sunnylqm.

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

• Add separate, on-page navigation sidebar option so that you can see links to local page topics, thanks @microbouji.
• You can now use a custom appId for your Algolia search, thanks @atroncy.
• The header navigation now shows the active link clearly, thanks @microbouji.
• Replace Circle CI 1.0 publishing documentation with Circle CI 2.0, thanks @ashleytqy.

Fixed/Changed

• Use path functions in order to fix building on Windows
• latestVersion was fixed when running the local server, thanks @sunnylqm.
• Environment variables take precedent over config options when publishing, thanks @juanpicado.
• i18n support fixed for the home page link in the header and the sidebar navigation, thank @cheercroaker.
• Document an existing feature that has already existed, ogImage, thanks @miralemd.
• siteConfig.users is now optional, thanks @aimeerpierce.
• id used instead of name in anchors, bringing us more HTML 5 compliant, thanks @ronami.

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

• A scrollbar to the header links on mobile, thanks @maaz93.

Fixed/Changed

• Allow new docs to be added for new versions
• Relax restriction on versioned doc ids with dashes
• Broken link in the site config docs, thanks @justinmusgrove.

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

• Option to control number of blog posts in sidebar (#432, thanks @ericnakagawa)
• font-family is now a configurable parameter (#294, thanks @cowlingj)
• Configurable edit URL link, per doc (#443, thanks @Glavin001)
• New Docusaurus users: Vuls, react-native-ios-kit and Verdaccio
• Docs section about referencing site documents (#394 )
• Clarified docs on publishing to a user/org page
• Alphabetized site config options in docs (thanks @haraldur12)
• Moved verifying installation section to the install docs (@thanks @gedeagas)
• Discord added as a help and communication option

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