Skip to content

Releases: facebook/docusaurus

v2.0.0-alpha.36

22 Nov 05:43
Compare
Choose a tag to compare

💥 Breaking Change

  • docusaurus-init, docusaurus-plugin-content-blog, docusaurus-theme-classic

🚀 New Feature

  • docusaurus-plugin-content-docs, docusaurus-theme-classic

🐛 Bug Fix

  • docusaurus
    • #2007 feat(v2): only create one css file to avoid code-split css loading problem (@endiliey)
  • docusaurus-theme-classic
    • #2005 fix(v2): adjust first-level heading offset (@lex111)

💅 Polish

  • docusaurus-theme-classic
    • #2013 refactor(v2): split out dark mode toggle so it is easily swizzle-able (@endiliey)
    • #2017 feat(v2): style right sidebar scrollbar when overflow (@endiliey)
    • #2003 refactor(v2): improve semantic markup of blog (@lex111)

🏠 Internal

  • docusaurus
    • #2024 test(v2): babel exclude transpilation logic to prevent regression (@endiliey)
    • #2014 feat(v2): add meta generator docusaurus (@endiliey)
  • docusaurus-mdx-loader, docusaurus-plugin-ideal-image
  • Other

📝 Documentation

Committers: 3

v1.14.2

22 Nov 05:30
Compare
Choose a tag to compare

🐛 Bug Fix

  • docusaurus-1.x
    • #2028 fix(v1): apply negative margin to docs heading only (@yangshun)

📝 Documentation

v1.14.1

21 Nov 05:46
Compare
Choose a tag to compare

🐛 Bug Fix

  • #2022 fix(v1): markdown content and toc should render the same (@endiliey)
  • #2020 fix(v1): docusaurus-start should work even if path contain 'pages' word (@endiliey)
  • #2019 fix(v1): consistent slug & hash-link generation (@endiliey)
  • #1869 fix(v1): fix page title render issue when referred by search result (@parvezakkas)
  • #1895 fix(v1): mobile safari search input misalignment in header (@sarneeh)
  • #1871 misc(v1): use primary color for hovered items in table of contents (@blitz137)

🏠 Internal

📝 Documentation

See CHANGELOG.md for more details.

v2.0.0-alpha.35

17 Nov 09:54
Compare
Choose a tag to compare

🚀 New Feature

  • docusaurus-theme-classic
    • #1965 feat(v2): add ability specify link in footer logo (@lex111)

🐛 Bug Fix

  • docusaurus-mdx-loader, docusaurus-theme-classic
    • #1992 fix(v2): static phrasing content should be rendered correctly in TOC (@endiliey)
  • docusaurus-theme-classic
    • #1999 fix(v2): remove hashbang when click on category (@lex111)
    • #1962 fix(v2): make not clickable post title on post item page (@lex111)
    • #1980 fix(v2): remove invalid label attribute of footer links (@lex111)
    • #1978 fix(v2): use regular div instead of main tag for wrapper layout page (@lex111)
    • #1975 fix(v2): move header inside article tag in doc page (@lex111)
    • #1974 fix(v2): remove invalid attributes of nav links (@lex111)
    • #1963 fix(v2): remove empty containers when no data in blog pages (@lex111)
    • #1966 fix(v2): remove duplicate meta tags (@lex111)
  • docusaurus-plugin-content-docs
    • #1994 fix(v2): throw error if first level item of a sidebar is not category (@endiliey)

💅 Polish

  • docusaurus-theme-search-algolia
  • docusaurus-theme-classic
    • #1991 fix(v2): remove accessible anchors via keyboard (@lex111)
    • #1987 refactor(v2): replace h1 tag with h2 in blog list pages (@lex111)
    • #1981 fix(v2): use tag time for showing last update of doc item (@lex111)
    • #1977 feat(v2): add aria-label to read more links for a11y (@lex111)
    • #1964 fix(v2): use tag time for showing post item date (@lex111)
  • docusaurus-plugin-content-docs
    • #1994 fix(v2): throw error if first level item of a sidebar is not category (@endiliey)
  • Other
    • #1986 fix(v2): remove obsolete iframe attributes (@lex111)
  • docusaurus-init
  • docusaurus-plugin-content-blog

📝 Documentation

🏠 Internal

  • Other
    • #2002 fix(v2): fix browser window menu icon on smaller screen (@lex111)
    • #1986 fix(v2): remove obsolete iframe attributes (@lex111)
  • docusaurus-init
  • docusaurus-1.x, docusaurus-init-1.x, docusaurus-init, docusaurus-plugin-content-docs, docusaurus-plugin-ideal-image, docusaurus-types, docusaurus

🏃‍♀️ Performance

  • docusaurus
    • #1979 perf(v2): reduce main bundle size by using es5 if possible (@endiliey)

Committers: 6

v2.0.0-alpha.34

11 Nov 14:38
Compare
Choose a tag to compare

🚀 New Feature

  • docusaurus-theme-classic
    • #1956 feat(v2): add ability hide dark mode toggle (@lex111)

💥 Breaking Change

  • docusaurus-plugin-content-docs
    • #1958 breaking(v2): editUrl should point to website instead of docsDir (@endiliey)

🐛 Bug Fix

  • docusaurus-theme-classic
    • #1959 fix(v2): useTOC hooks should not be called in each nested children (@endiliey)

💅 Polish

  • docusaurus-plugin-content-docs, docusaurus
    • #1957 refactor(v2): avoid synchronous/ blocking operation when possible (@endiliey)

📝 Documentation

🏠 Internal

  • docusaurus-1.x, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-theme-classic, docusaurus-theme-search-algolia, docusaurus-types, docusaurus-utils, docusaurus
  • Other

🏃‍♀️ Performance

  • docusaurus-plugin-content-docs, docusaurus-utils, docusaurus
    • #1951 perf(v2): skip runtime fileHash cache in prod & get timestamp asynchronously (@endiliey)
    • #1950 perf(v2): more efficient hot reload & consistent filegen (@endiliey)

Committers: 3

v2.0.0-alpha.33

08 Nov 06:47
Compare
Choose a tag to compare

Features

  • Table of contents is now highlighted depending on current active headings. (thanks to awesome @SantiagoGdaR) #1896
  • Official blog plugin can now generate feed for blog posts. (thanks to awesome @moozzyk) #1916
  • BREAKING prismTheme is renamed to theme as part new prism object in themeConfig field in your docusaurus.config.js. Eg:
     themeConfig: {
    -   prismTheme: require('prism-react-renderer/themes/dracula'),
    +   prism: {
    +     theme: require('prism-react-renderer/themes/dracula'),
    +   },
    },
  • Added new prism option defaultLanguage that is used if the language is not specified in code blocks.
    #1910

Fixes

  • Fix babel/env not picking the correct browserslist configuration during development. When running docusaurus start, process.env.NODE_ENV is now consistently set to development.
  • Ensure routes config generation to be more consistent in ordering. Nested routes should be placed last in routes.js. This will allow user to create src/pages/docs.js to create custom docs page for /docs or even src/pages/docs/super.js to create page for /docs/super/;
  • Fix watcher does not trigger reload on windows.
  • Fix build compilation error if exists only one code tab.
  • Add minor padding to docs container so that hash-link won't be cut off.

Others

  • Misc dependency upgrades.
  • Stability improvement (more tests) & refactoring on docs plugin to prevent regression.

Upgrading

// package.json
{
  dependencies: {
+    "@docusaurus/core": "^2.0.0-alpha.33",
+    "@docusaurus/preset-classic": "^2.0.0-alpha.33",
-    "@docusaurus/core": "^2.0.0-alpha.32",
-    "@docusaurus/preset-classic": "^2.0.0-alpha.32",
  }
}

v2.0.0-alpha.32

04 Nov 05:59
Compare
Choose a tag to compare

2.0.0-alpha.32

Features

  • Add <Redirect> component for easy client side redirect.
    Example Usage:
import React from 'react';
import {Redirect} from '@docusaurus/router';

function Home() {
  return <Redirect to="/docs/test" />;
}
  • Allow user to add custom HTML to footer items. #1905
  • Added code block line highlighting feature (thanks @lex111)! If you have previously swizzled the CodeBlock theme component, it is recommended to update your source code to have this feature.
    (#1860)

Bug Fixes

  • Fix @theme/Tabs component to be able to create tabs with only one item.
  • Fix MDX @theme/Heading component. If there is no id, it should not create anchor link.
  • Fixed a bug in which if themeConfig.algolia is not defined, the custom searchbar won't appear.
    If you've swizzled Algolia SearchBar component before, please update your source code otherwise CSS might break. See #1909 for reference.
- <Fragment>
+ <div className="navbar__search" key="search-box">
  • Slightly adjust search icon position to be more aligned on small width device. (#1893)
  • Fix algolia styling bug, previously search suggestion result is sometimes hidden. (#1915)
  • Changed the way we read the USE_SSH env variable during deployment to be the same as in v1.
  • Fix accessing docs/ or /docs/xxxx that does not match any existing doc page should return 404 (Not found) page, not blank page. (#1903)
  • Prioritize @docusaurus/core dependencies/ node_modules over user's node_modules. This fix a bug whereby if user has core-js@3 on its own node_modules but docusaurus depends on core-js@2, we previously encounter Module not found: core-js/modules/xxxx (because core-js@3 doesn't have that).
  • Fix a bug where docs plugin add /docs route even if docs folder is empty. We also improved docs plugin test coverage to 100% for stability before working on docs versioning. (#1912)

Performance Improvement

  • Reduce memory usage consumption. (#1900)
  • Significantly reduce main bundle size and initial HTML payload on production build. Generated files from webpack is also shorter in name. (#1898)
  • Simplify blog metadata. Previously, accessing /blog/post-xxx will request for next and prev blog post metadata too aside from target post metadata. We should only request target post metadata.
    (#1908)

Others

  • Convert sitemap plugin to TypeScript. (#1894)
  • Refactor dark mode toggle into a hook. (#1899)

v2.0.0-alpha.31

26 Oct 07:19
Compare
Choose a tag to compare
v2.0.0-alpha.31 Pre-release
Pre-release

2.0.0-alpha.31

  • Footer is now sticky/ pinned to the bottom of the viewport in desktop browsers.
  • Footer is now also displayed in docs page for consistency.
  • Remove empty doc sidebar container if sidebar for a particular doc page does not exist. Otherwise, it will cause an additional empty space.
  • Default PostCSS loader now only polyfills stage 3+ features (previously it was stage 2) like Create React App. Stage 2 CSS is considered relatively unstable and subject to change while Stage 3 features will likely become a standard.
  • Fix search bar focus bug. When you put the focus on search input, previously the focus will remain although we have clicked to other area outside of the search input.
  • New themeConfig option sidebarCollapsible. It is on by default. If explicitly set to false, all doc items in sidebar is expanded. Otherwise, it will still be a collapsible sidebar.
  • Disable adding hashes to the generated class names of CSS modules in dev mode. Generating unique identifiers takes some time, which can be saved since including paths to files in class names is enough to avoid collisions.
  • Fix showing sidebar category with empty items.
  • Update infima from 0.2.0-alpha.2 to 0.2.0-alpha.3
    • Fix pagination nav and right sidebar color contrast ratio
    • Fix sidebar arrow color in dark mode
    • Fix footer mobile issue
    • Increase sidebar width
    • etc

v2.0.0-alpha.30

22 Oct 05:31
Compare
Choose a tag to compare
v2.0.0-alpha.30 Pre-release
Pre-release

2.0.0-alpha.30

  • Fix babel transpilation include/exclude logic to be more efficient. This also fix a very weird bug TypeError: Cannot assign to read only property 'exports' of object '#<Object>' if your website path contains docusaurus word in it.(#1868)

If you are still encountering the error. Please check whether you use module.exports for your .js file instead of doing export (mixing CJS and ES). See webpack/webpack#4039 (comment) and webpack/webpack#4039 (comment) for more context.

v2.0.0-alpha.29

21 Oct 12:32
Compare
Choose a tag to compare
v2.0.0-alpha.29 Pre-release
Pre-release

2.0.0-alpha.29

HOTFIX for 2.0.0-alpha.28.

  • Fix missing core-js dependencies on @docusaurus/core.
  • Fix wrong @babel/env preset configuration that causes build compilation error.
  • Improved UI for webpack compilation progress bar.