Easy to maintain open source documentation websites.

Last update: Jan 2, 2023

Overview

Docusaurus

We are working hard on Docusaurus v2. If you are new to Docusaurus, try using the new version instead of v1. See the Docusaurus v2 website for more details.

Docusaurus v1 doc is available at v1.docusaurus.io

Introduction

Docusaurus is a project for building, deploying, and maintaining open source project websites easily.

Tip: use new.docusaurus.io to test Docusaurus immediately in CodeSandbox.

Simple to Start

Docusaurus is built in a way so that it can get running in as little time as possible. We've built Docusaurus to handle the website build process so you can focus on your project.

Localizable

Docusaurus ships with localization support via CrowdIn. Empower and grow your international community by translating your documentation.

Customizable

While Docusaurus ships with the key pages and sections you need to get started, including a home page, a docs section, a blog, and additional support pages, it is also customizable as well to ensure you have a site that is uniquely yours.

Installation

Use the initialization cli to create your site:

npx @docusaurus/init@latest init [name] [template]

Example:

npx @docusaurus/init@latest init my-website classic

Contributing

We've released Docusaurus because it helps us better scale and supports the many OSS projects at Facebook. We hope that other organizations can benefit from the project. We are thankful for any contributions from the community.

Code of Conduct

Facebook has adopted a Code of Conduct that we expect project participants to adhere to. Please read the full text so that you can understand what actions will and will not be tolerated.

Contributing guide

Read our contributing guide 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 that might contain smaller issues to tackle first. This is a great place to get started.

Contact

We have a few channels for contact:

Discord with two text channels:
- #docusaurus-users for those using Docusaurus.
- #docusaurus-dev for those wanting to contribute to the Docusaurus core.
@docusaurus on Twitter
GitHub Issues

Contributors

This project exists thanks to all the people who contribute. [Contribute].

Backers

Thank you to all our backers! 🙏 Become a backer

License

Docusaurus is MIT licensed.

The Docusaurus documentation (e.g., .md files in the /docs folder) is Creative Commons licensed.

Special thanks

BrowserStack supports us with free access for open source.

Rocket Validator helps us find HTML markup or accessibility issues.

Comments

😎 Get swag for migrating websites to Docusaurus 2!
Tip: This is a task that requires at least a few hours of commitment (can be more, depending on the website) and it targeted at people who want to learn more about Docusaurus and Open Source.

Docusaurus 2 has reached a mature alpha stage. We want to help some existing Docusaurus 1 sites migrate to Docusaurus 2. We've done this ourselves for Create React App (PR) and Flux (PR). But just the few of us isn't enough. We need your help.

We have shortlisted the following sites using Docusaurus 1 which we want to migrate to Docusaurus 2: https://docs.google.com/spreadsheets/d/18SWTklRJVvOTOQEStTo8LXBc78ZMFdbdwp2EEJK5q8g/edit?usp=sharing).

Instructions

You should be somewhat familiar with using Docusaurus before attempting the task. Otherwise, you can follow our Docusaurus 1 tutorial and Docusaurus 2 Getting Started

Comment below to get dibs on the website you're interested in helping to migrate. Make sure it's not already claimed

Find the GitHub repo to the website you want to claim

File an issue on the GitHub project with the following details

Issue Title: Migrate Website to Docusaurus 2 Alpha Issue Body: Hi there! The Docusaurus team is currently developing Docusaurus 2 and are almost done with an MVP that doesn't include translations and versioning features, which means there's feature parity with your website's current usage of Docusaurus. Docusaurus 2 brings about many improvements: - Client-side rendering with prerendering (site renders without JavaScript!) - More flexible appearance - Customizable layouts, CSS modules, etc - Embeddable interactive React components within markdown via MDX I will be helping you migrate and be the POC throughout the migration process. Let me know what you think! cc @yangshun @wgao19

If the project maintainer gives the green light, then go ahead and start the migration process

Pre-Migration

Navigate to every page of the website and see if there's anything special about the page (e.g. importing extra scripts)

Look at the docs files to do a sanity check that the user didn't add anything that Docusaurus 2 doesn't support (e.g. custom markdown syntax)

If there are any unsupported things, you can check back with us or ping us in the #docusaurus-1-to-2-migration Discord channel

Migration

Follow the v1 to v2 migration guide here

You should look at the website/siteConfig.js and address every field (either migrate it or remove it (but take note of it))

There will probably be syntax issues in their Markdown docs that is not compatible with with Docusaurus 2's MDX parser. Most of them should be easy to fix

v2 uses a different CSS framework and it is not necessary to make the landing page components look exactly like v1 (referring to the call-to-action button and the footer). Most importantly is contents, then the layout. Fine-grain differences in visual appearance of individual components is acceptable and probably intended

Do not swizzle the Footer just to add the logo on the left. The logo is intentionally removed in v2. Just configure the footer via the docusaurus.config.js's themeConfig.footer properties.

As long as you have the same contents you should be good

The following code could be helpful for migration of various pages

Index page - Flux (recommended), Docusaurus 2, Hermes,

Help/Support page - Docusaurus 2, Flux

For Docusaurus 2, we built a CSS framework called Infima. More guidance on styling can be found here

You might want to refer to our PRs for Create React App and Flux as examples of how a migration for a basic Docusaurus v1 site can be done

Post-Migration

Check the project's CI to update the path of the build directory (generated files are in build/ instead of build/{projectName} in v2)

Navigate to every page, checking for broken links and broken images

Check that the index page and doc page look fine on mobile

Make a PR.

At the minimum, you should include some screenshots

If possible, you can try to host the built website somewhere using hosting services like Now or GitHub pages. This step is important in giving project owners the confidence that the migration doesn't break anything. They can click around and try the shiny migrated Docusaurus 2 website

List down features that were removed (due to Docusaurus 2 not supporting or whatever other reasons there may be)

Tag @yangshun in the PR you create, and link it to this issue so we can better track the open migration PRs

PR gets approved and merged by project maintainer(s)

????

Profit!

Thank You!

We'll be sending Facebook Open Source stickers to contributors who successfully complete migrate a website. If you migrate 3 websites, we'll send you a Docusaurus plushie!

P.S. Hacktoberfest is going on now and you could get a fancy free t-shirt by submitting PRs!

For any questions regarding the migration, either comment below or ask in our #docusaurus-1-to-2-migration Discord channel (preferred).

I'll check in with you every once in a while on the progress. Note that it's totally ok to unclaim a website for any reason, we understand 😊

P.S. If there's a Docusaurus 1 website not listed here, it means we don't have the bandwidth to support the migration. You are free to initiate a migration issue on other projects but support from the Docusaurus core team will be limited as we prioritize supporting our own projects.
opened by yangshun 79
Support local search

Is this a bug report?

NO

Have you read the [Contributing Guidelines on issues]

YES

Environment

None

Steps to Reproduce

None

Expected Behavior

None

Actual Behavior

None

Reproducible Demo

None

Request new feature

I have a website in my intranet, it generated use gitbook. Now i perfer to use the excellent website generator, and deprecated gitbook. But the tool miss local search capability while migrate process. So we have possible to provide local search(like hexo next theme)?
feature

opened by yanzhiwei147 75
Sidebar categories linking to a doc or category index page

🚀 Feature

Category in docs are only container for subitems (topics). But some help system enable category to be introductory topic to subitems (ie containing text that introduce the subitems or refers to subitems ie see also links to subtopic1, sub..)

Have you read the Contributing Guidelines on issues?

Yes

Motivation

Interested to use the Docusaurus Help System but before investing in it wan't to know the roadmap

Pitch

It's pretty useful. If you can read the introductory topic, you sometimes don't have to click/navigate to subtopics. It'a a better system than having a first topic (~overview) refering to following topics in a same level appearance > introductory topic has to be a level upper the subtopics.. Example of documentation with introductory topics : https://www.gatsbyjs.org/docs/deploying-and-hosting/ https://www.innovasys.com/help/hs2019.1/authoringcontent.html https://markdownmonster.west-wind.com/docs/

Hope my explaination is not too hard to understand.. Thanks to the docusaurus team for their work

Regards, Xavier
feature

opened by XavierNV 62
feat(v2): Plugin for Offline/PWA support
Changes

Implements @docusaurus/plugin-pwa

Add popup for notifying users of updated website content

Adds @docusaurus/plugin-pwa to v2 website, adding offline/PWA support

Motivation

Implements offline support as requested in #458. Having offline support is beneficial for a dev that needs documentation to work on a project where internet is slow or inaccessible (i.e. airplanes, trains, etc.)

Have you read the Contributing Guidelines on pull requests?

Yes 😄

Test Plan

I've manually tested offline support in the browser and as an installed app. I also ran a lighthouse audit.

Loading Offline

Installing as a Chrome App

Open app in chrome://apps

Lighthouse Audit

Redirect HTTP to HTTPs is server dependent so it's checked off in the audit.

Update Popup

Related PRs
CLA Signed pr: new feature
opened by codemonkey800 61
🌟Help us feature more Docusaurus v1 users!
Tip: This is a beginner level Docusaurus task that requires almost no coding and is more targeted at newcomers to the project and Open Source.

📚 Documentation

We want to feature more Docusaurus users and we need your help!

Docusaurus has a users page where we showcase projects using Docusaurus. This has the benefits of giving projects recognition and also lets the community and new users reference the creative ways of using Docusaurus. For example, Babel implemented the "copy code" button which we copied into our code, Reason has a full-width doc page and Prettier has a playground.

Here's a list of projects that we want to feature, in no particular order.

[x] https://github.com/reduxjs/react-redux/ (@wgao19)

[x] https://github.com/jaredpalmer/formik (@shahednasser)

[x] https://github.com/node-serialport/node-serialport (@mikeattara)

[x] https://github.com/facebook/react-360 (@sunitasen)

[x] https://github.com/callstack/haul (@ellereeeee)

[x] https://github.com/19majkel94/type-graphql (@19majkel94)

[x] https://github.com/zamotany/react-slate (@andrewShillito)

[x] https://github.com/hemerajs/hemera (@alexperez)

[x] https://github.com/Cretezy/Noderize (@Rajekevin)

[x] https://github.com/react-native-sensors/react-native-sensors (@mikeattara)

[x] https://github.com/Khan/KaTeX (@haoqiang)

[x] https://github.com/PaulLeCam/react-leaflet (@zakariaharti)

[x] https://github.com/reduxjs/redux (@YifanM)

[x] https://github.com/scalameta/scalafmt (@ahtee)

[x] https://github.com/apache/pulsar (@NishealJ)

[x] https://github.com/boyney123/mockit (@NishealJ)

[x] https://testing-library.com/ (@hongarc)

[x] https://github.com/qiu8310/minapp (@qiu8310 + @NishealJ)

The process of adding users goes like this:

Comment below with the project you're interested in helping and make sure it's not already claimed.

Check if the project has a logo. If it doesn't have a logo, we could ask them to create one. If not, then we can't feature it as we don't have a way to feature projects without logos at the moment. Sorry about that.

Make an issue on the GitHub project, asking about featuring their project on Docusaurus (most people would be okay with that).

Get a reasonable-sized version of their logo (SVG preferred) and add it to website-1.x/static/img/users/<project-name-in-lower-snake-case>.{svg/png/jpg} not exceeding 512x512. Look into their website directory or project directory for the logo image file. Try to compress the logo first if possible using Photoshop or some online tools.

Modify website-1.x/data/users.js and add the project into the JS file, sorted alphabetically by caption:

{ caption: 'The Project Name', image: '/path/to/image', infoLink: 'www.example.com', // Website. Can be GitHub repo URL if website doesn't exist fbOpenSource: false, pinned: false, },

Run the Docusaurus website locally and see that the users page loads fine and shows the new user!

Run yarn lint and yarn prettier before submitting the PR.

Use the PR title - docs: showcase user <project name>.

In the PR summary, add a link to the PR where you've asked the project for permissions to include their logo

Submit your PR!

Have you read the Contributing Guidelines on issues?

Yes
help wanted good first issue difficulty: starter
opened by yangshun 61

TypeError when building project, after upgrading to v2.0.0-beta.19

Have you read the Contributing Guidelines on issues?

[X] I have read the Contributing Guidelines on issues.

Prerequisites

[X] I'm using the latest version of Docusaurus.
[X] I have tried the npm run clear or yarn clear command.
[X] I have tried rm -rf node_modules yarn.lock package-lock.json and re-installing packages.
[ ] I have tried creating a repro with https://new.docusaurus.io.
[X] I have read the console error message carefully (if applicable).

Description

While upgrading our project to from Docusaurus v2.0.0-beta.18 to v2.0.0-beta.19 we are now encountering an issue during the build.

Reproducible demo

No response

Steps to reproduce

Upgrade docusaurus using the command npm i @docusaurus/[email protected] @docusaurus/[email protected] @docusaurus/[email protected] from v2.0.0-beta-18
npm run build

Expected behavior

To have no problems building. The chalk_1.default.bold TypeError doesn't seem related to any breaking changes introduced in the beta-19 version and there are no existing related issues either.

Actual behavior

To upgrade, we ran npm i @docusaurus/[email protected] @docusaurus/[email protected] @docusaurus/[email protected].

Then when running npm run build we run into the below output:

TypeError: chalk_1.default.bold is not a function
TypeError: chalk_1.default.bold is not a function
TypeError: chalk_1.default.bold is not a function
TypeError: chalk_1.default.bold is not a function
TypeError: chalk_1.default.bold is not a function
TypeError: chalk_1.default.bold is not a function
TypeError: chalk_1.default.bold is not a function
... (many more times)
[WARNING] {"moduleIdentifier":"/Users/rebecca.tiessen/workspace/developer-docs/node_modules/@babel/core/lib/config/files/configuration.js","moduleName":"./node_modules/@babel/core/lib/config/files/configuration.js","loc":"163:150-157","message":"Critical dependency: require function is used in a way in which dependencies cannot be statically extracted","compilerPath":"server"}
[WARNING] {"moduleIdentifier":"/Users/rebecca.tiessen/workspace/developer-docs/node_modules/@babel/core/lib/config/files/import.js","moduleName":"./node_modules/@babel/core/lib/config/files/import.js","loc":"9:9-25","message":"Critical dependency: the request of a dependency is an expression","compilerPath":"server"}
[WARNING] {"moduleIdentifier":"/Users/rebecca.tiessen/workspace/developer-docs/node_modules/@babel/core/lib/config/files/module-types.js","moduleName":"./node_modules/@babel/core/lib/config/files/module-types.js","loc":"89:17-34","message":"Critical dependency: the request of a dependency is an expression","compilerPath":"server"}
[WARNING] {"moduleIdentifier":"/Users/rebecca.tiessen/workspace/developer-docs/node_modules/@babel/core/lib/config/files/plugins.js","moduleName":"./node_modules/@babel/core/lib/config/files/plugins.js","loc":"148:144-151","message":"Critical dependency: require function is used in a way in which dependencies cannot be statically extracted","compilerPath":"server"}
[WARNING] {"moduleIdentifier":"/Users/rebecca.tiessen/workspace/developer-docs/node_modules/@babel/helper-define-polyfill-provider/lib/node/dependencies.js","moduleName":"./node_modules/@babel/helper-define-polyfill-provider/lib/node/dependencies.js","loc":"32:13-20","message":"Critical dependency: require function is used in a way in which dependencies cannot be statically extracted","compilerPath":"server"}
[WARNING] {"moduleIdentifier":"/Users/rebecca.tiessen/workspace/developer-docs/node_modules/@babel/helper-define-polyfill-provider/lib/node/dependencies.js","moduleName":"./node_modules/@babel/helper-define-polyfill-provider/lib/node/dependencies.js","loc":"54:6-13","message":"Critical dependency: require function is used in a way in which dependencies cannot be statically extracted","compilerPath":"server"}
[WARNING] {"moduleIdentifier":"/Users/rebecca.tiessen/workspace/developer-docs/node_modules/@svgr/core/dist/index.js","moduleName":"./node_modules/@svgr/core/dist/index.js","loc":"159:33-52","message":"Critical dependency: the request of a dependency is an expression","compilerPath":"server"}
[WARNING] {"moduleIdentifier":"/Users/rebecca.tiessen/workspace/developer-docs/node_modules/browserslist/node.js","moduleName":"./node_modules/browserslist/node.js","loc":"171:18-76","message":"Critical dependency: the request of a dependency is an expression","compilerPath":"server"}
[WARNING] {"moduleIdentifier":"/Users/rebecca.tiessen/workspace/developer-docs/node_modules/browserslist/node.js","moduleName":"./node_modules/browserslist/node.js","loc":"171:26-33","message":"Critical dependency: require function is used in a way in which dependencies cannot be statically extracted","compilerPath":"server"}
[WARNING] {"moduleIdentifier":"/Users/rebecca.tiessen/workspace/developer-docs/node_modules/browserslist/node.js","moduleName":"./node_modules/browserslist/node.js","loc":"192:16-195:6","message":"Critical dependency: the request of a dependency is an expression","compilerPath":"server"}
[WARNING] {"moduleIdentifier":"/Users/rebecca.tiessen/workspace/developer-docs/node_modules/browserslist/node.js","moduleName":"./node_modules/browserslist/node.js","loc":"192:24-31","message":"Critical dependency: require function is used in a way in which dependencies cannot be statically extracted","compilerPath":"server"}
[WARNING] {"moduleIdentifier":"/Users/rebecca.tiessen/workspace/developer-docs/node_modules/import-fresh/index.js","moduleName":"./node_modules/import-fresh/index.js","loc":"32:31-48","message":"Critical dependency: the request of a dependency is an expression","compilerPath":"server"}
[WARNING] {"moduleIdentifier":"/Users/rebecca.tiessen/workspace/developer-docs/node_modules/svgo/lib/svgo-node.js","moduleName":"./node_modules/svgo/lib/svgo-node.js","loc":"22:13-32","message":"Critical dependency: the request of a dependency is an expression","compilerPath":"server"}
[WARNING] {"moduleIdentifier":"/Users/rebecca.tiessen/workspace/developer-docs/node_modules/svgo/lib/svgo-node.js","moduleName":"./node_modules/svgo/lib/svgo-node.js","loc":"27:42-75","message":"Critical dependency: the request of a dependency is an expression","compilerPath":"server"}
[WARNING] {"moduleIdentifier":"/Users/rebecca.tiessen/workspace/developer-docs/node_modules/svgo/lib/svgo-node.js","moduleName":"./node_modules/svgo/lib/svgo-node.js","loc":"32:17-36","message":"Critical dependency: the request of a dependency is an expression","compilerPath":"server"}
[WARNING] {"moduleIdentifier":"/Users/rebecca.tiessen/workspace/developer-docs/node_modules/url-loader/dist/index.js","moduleName":"./node_modules/url-loader/dist/index.js","loc":"120:19-42","message":"Critical dependency: the request of a dependency is an expression","compilerPath":"server"}
[ERROR] Unable to build website for locale en.
[ERROR] Error: Failed to compile with errors.
    at /Users/rebecca.tiessen/workspace/developer-docs/node_modules/@docusaurus/core/lib/webpack/utils.js:182:24
    at /Users/rebecca.tiessen/workspace/developer-docs/node_modules/webpack/lib/MultiCompiler.js:554:14
    at processQueueWorker (/Users/rebecca.tiessen/workspace/developer-docs/node_modules/webpack/lib/MultiCompiler.js:491:6)
    at processTicksAndRejections (node:internal/process/task_queues:78:11)

Screen Shot 2022-05-10 at 4 21 06 PM

Apologies for not creating a reproducible demo, if that's necessary to get this looked at then we can potentially schedule it into our work flow but we've spent a good amount of work time trying to debug this already. Thanks in advance if you're able to provide any insights!

Your environment

Public source code: n/a (not public)
Public site URL: https://developer.boldcommerce.com/default/
Docusaurus version used: 2.0.0-beta-18
Environment name and version (e.g. Chrome 89, Node.js 16.4): Node 16.3
Operating system and version (e.g. Ubuntu 20.04.2 LTS): macOS Monterey 12.3.1

Self-service

[ ] I'd be willing to fix this bug myself.

bug

opened by becca-tiessen 56

Docusaurus 2
Update 03/19/19

We have started a Roadmap/Feature requests page thanks to the awesome folks at Canny.io. Have a go at it on our WIP v2: https://v2.docusaurus.io/feedback/

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 JavaScript-based static site generators ecosystem, there are the following libraries:

https://vuepress.vuejs.org/

https://www.gatsbyjs.org

https://github.com/nozzle/react-static

https://github.com/phenomic/phenomic

https://docsify.js.org/

https://github.com/lord/slate

https://middlemanapp.com

https://github.com/jnordberg/wintersmith

https://github.com/jaredpalmer/razzle

https://github.com/pedronauck/docz

Useful libraries

https://github.com/c8r/x0

https://github.com/mdx-js/mdx

https://github.com/jonschlinkert/gray-matter

My proposal for D2 is that Docusaurus be responsible for documentation content, routing, translation and versioning, leaving layout and styling to the end user. Docusaurus would provide a default theme and a few common layouts that the user can use, or ignore if they want to build their layout from scratch. It's not a good idea for Docusaurus to maintain the entire layout and styling as these stuff are hard to make improvements without breaking existing users' code.

A Google Doc where we go into more details can be found here

D2 Design Principles

Easy to learn but most things are still achievable by users, even if it takes them more code and more time to write. No abstractions beat bad abstractions, and we don't want users to have to hack around the wrong abstractions. Mandatory talk: Minimal API Surface Area

Users won't feel overwhelmed when looking at the directory of a D2 project. It should look familiar to users familiar building web apps and websites and is easy to build on top of.

We should not lock-in our users to use our plugins or our CSS. Certain lower-level infra level stuff like React Loadable, React Router are fine, but not higher level ones, such as choice of Markdown engines, CSS frameworks, CSS methodology.

The separations of concerns between each layer of our stack should be clear - well-abstracted and modular.

D1 Problems and Proposed Solutions

Infra

Current Problems

Routing logic is separated and resides within both server and generation code, leading to duplicated logic and harder to ensure that code working in server mode also work in generation mode.

Routing is not declarative. Hard to understand what possible routes there are in Docusaurus.

Build pipeline is imperative and quite tangled.

Does not allow adding local vendor CSS and JS (https://github.com/facebook/Docusaurus/issues/534)

New features are mostly enabled via siteConfig - siteConfig will bloat over time and become unmaintainble.

Current architecture is a bit tangled and makes it hard to introduce plugins.

Many components relies on process.cwd() too much (mostly for siteConfig), making it very hard to test.

LiveReload does a full-page reload, and page reloads for changes of all files.

Suggested improvements

Use a module bundler like webpack (or Metro if possible, since it's also by Facebook).

Static pages can be generated using (https://github.com/markdalgleish/static-site-generator-webpack-plugin)

Assets should be fingerprinted (should be trivial with webpack)

Use webpack-dev-server during development which enables hot reloading - only reload the modules which changed.

Rearchitect architecture to introduce hooks into the development and build phase so that a plugin system is possible.

Keys casing are not consistent - camelCase in siteConfig and blog front matter but snake_case in docs front matter.

HTML/CSS

Current Problems

Raw CSS without any preprocessor. Hacky variable substitution approach using regexp.

Docusaurus controls much of the styles and layout, which makes it prone to breaking end users code who customize.

All CSS is compiled into one file.

HTML/CSS is self-written and doesn't follow CSS framework best practices. Typography is not great (margins and paddings are not consistent)/. Partially fixed in https://github.com/facebook/Docusaurus/pull/757.

Hard to do theming on top of current CSS structure. Limited to changing of colors and fonts.

Site layout is not customizable - EDIT: Just found out it is (https://github.com/facebook/Docusaurus/pull/128).

Docs/blog layout is not customizable.

No 404 page.

Suggested improvements

Layout and styling should be controlled by theme and user. Docusaurus should just provide the data (content, translation, versioning), props and a default theme. This is the approach taken by many static site generators as well, such as Jekyll, Gatsby and VuePress. VuePress allows ejecting of the default theme for further layout customization.

Follow CSS frameworks best practices - Use rem for units, allow specifying margin width, etc.

Allow user to select their own CSS preprocesser.

Allow setting styles and scripts for specific pages only. Use case - some sites like Babel, Prettier and Reason have playgrounds where they only want to load specific scripts and styles.

Make Docusaurus pages/components more customizable (https://github.com/facebook/Docusaurus/issues/249)

Add a 404 page.

JavaScript

Current Problems

JS code in pages is currently not being transpiled by Babel. We have to write ES5 in code that will be sent to browsers.

React is used as a templating engine for static content; we're not using any of its view library features. Interactivity has to be added through script tags and dangerouslySetInnerHTML.

Possible improvements

If the user adds interactivity to their React component/page, we should include React library on the page and hydrate the component after the page has been rendered.

API

Current Problems

CLI commands should be using docusaurus <command> (instead of docusaurus-command) which is more conventional (see Yarn and Git).

Docusaurus-provided components are required using a relative path which looks a bit odd and may break if we change the library's internal directory structure.

Possible improvements

Rework the CLI commands. Should be just a matter of renaming and shifting them into docusaurus core. This also solves the problem of having to publish docusaurus-init as a separate package.

Export docusaurus components on the main npm file itself. Add even more common components (we can consider creating pages as components as well).

Blog

Current Problems

NA

Possible improvements

Allow for commenting support (via a plugin and not siteConfig as how it is currently done)

Allow customizing of date.

Draft mode for posts

Tags, Categories

Markdown

Current Problems

Only reads YAML, does not support different kinds of front matter.

Unable to embed content from other Markdown files.

Possible improvements

Add reference style linking.

Add page tabbing (https://github.com/facebook/Docusaurus/issues/45), probably via a Remarkable plugin.

Allow importing markdowns in other markdowns.

Line highlighting within code blocks.

Support embedding React components in markdown.

Emoji support.

Check that internal page links and anchors work fine.

Support special block tags like in VuePress for tip/warning/danger markup.

Search

Current Problems

We're using Algolia as the only form of search now. Algolia search is a third-party service that requires internet and doesn't work behind VPN/offline.

Possible improvements

I really like Algolia search as it's useful and so simple to use. But we could also come up with alternative offline search mechanisms to get around the limitations mentioned above. At my previous company, I added offline search for a static site via Lunr.js. It works by looking through the markdown files and generated a static index of the content during build time. The searching and rendering of search results is purely done on the client side. It roughly works - https://engineering.grab.com/search.html?q=react

These are my two cents. Feel free to chime in (:
opened by yangshun 52

Minify failure when building docusaurus site in a yarn workspaces with another project

Edit from @slorber: TL.DR, try using this nohoist config

🐛 Bug Report

I have a Docusaurus-built site that shares a yarn.lock file with several other projects. Since bumping to Docusaurus to 2.0.0-alpha.64 from 2.0.0-alpha.63, I have been unable to docusaurus build. I get this error:

(undefined) TypeError: Cannot read property 'replace' of undefined
    at Object.options.minifyJS (main:18614:28)
    at Object.chars (main:19102:24)
    at main:48074:19
    at String.replace (<anonymous>)
    at new HTMLParser (main:48066:19)
    at minify (main:18888:3)
    at module.exports.exports.minify (main:19249:16)
    at serverEntry_render (main:87861:38)
Error: Failed to compile with errors.
    at /Users/treece/src/docusaurus-minify-troubles/node_modules/@docusaurus/core/lib/webpack/utils.js:164:24
    at finalCallback (/Users/treece/src/docusaurus-minify-troubles/node_modules/webpack/lib/MultiCompiler.js:254:12)
    at /Users/treece/src/docusaurus-minify-troubles/node_modules/webpack/lib/MultiCompiler.js:277:6
    at done (/Users/treece/src/docusaurus-minify-troubles/node_modules/neo-async/async.js:2931:13)
    at runCompilers (/Users/treece/src/docusaurus-minify-troubles/node_modules/webpack/lib/MultiCompiler.js:181:48)
    at /Users/treece/src/docusaurus-minify-troubles/node_modules/webpack/lib/MultiCompiler.js:188:7
    at /Users/treece/src/docusaurus-minify-troubles/node_modules/webpack/lib/MultiCompiler.js:270:7
    at finalCallback (/Users/treece/src/docusaurus-minify-troubles/node_modules/webpack/lib/Compiler.js:257:39)
    at /Users/treece/src/docusaurus-minify-troubles/node_modules/webpack/lib/Compiler.js:273:13
    at AsyncSeriesHook.eval [as callAsync] (eval at create (/Users/treece/src/docusaurus-minify-troubles/node_modules/tapable/lib/HookCodeFactory.js:33:10), <anonymous>:40:1)
    at AsyncSeriesHook.lazyCompileHook (/Users/treece/src/docusaurus-minify-troubles/node_modules/tapable/lib/Hook.js:154:20)
    at onCompiled (/Users/treece/src/docusaurus-minify-troubles/node_modules/webpack/lib/Compiler.js:271:21)
    at /Users/treece/src/docusaurus-minify-troubles/node_modules/webpack/lib/Compiler.js:681:15
    at AsyncSeriesHook.eval [as callAsync] (eval at create (/Users/treece/src/docusaurus-minify-troubles/node_modules/tapable/lib/HookCodeFactory.js:33:10), <anonymous>:4:1)
    at AsyncSeriesHook.lazyCompileHook (/Users/treece/src/docusaurus-minify-troubles/node_modules/tapable/lib/Hook.js:154:20)
    at /Users/treece/src/docusaurus-minify-troubles/node_modules/webpack/lib/Compiler.js:678:31
error Command failed with exit code 1.
info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.

Have you read the Contributing Guidelines on issues?

Yes

To Reproduce

I've created a minimal repro repo, https://github.com/taylorreece/docusaurus-minify-troubles, with a new Docusaurus project created with npx @docusaurus/init@next init docs classic. I did not touch the docusaurus project otherwise. The other project in this repo, aptly named "other-project" has a package.json file with a series of dependencies. These two projects share a yarn.lock.

git clone [email protected]:taylorreece/docusaurus-minify-troubles.git
cd docusaurus-minify-troubles
yarn install
cd docs/
yarn build

If you remove other-project and then yarn install and yarn build, the Docusaurus site builds fine.

Expected behavior

I'd expect it to build.

Actual Behavior

I get the stack trace listed above

Your Environment

MacOS Node v12.16.2 Yarn v1.22.4

bug external

opened by taylorreece 46

feat(v2): introduce DocSearch v3 search
Motivation

This PR integrates the new version of DocSearch, that better reflects what we think documentation search should be.

Closes #2808 Closes #2754

Have you read the Contributing Guidelines on pull requests?

Yes.

Test Plan

Try the new search experience by clicking on the search button, or hitting ⌘ + K (or Ctrl + K): https://deploy-preview-2815--docusaurus-2.netlify.app.

Hello Docusaurus team! The DocSearch folks at @algolia have been working on a brand new DocSearch frontend the past months: DocSearch 3.

Context

Reducing users' efforts to get them started integrating your product is key to adoption. We created DocSearch in 2015 as a community effort to solve this problem.

We've had time to try different approaches since then and would like to propose you a new documentation search experience.

Features

This new DocSearch version offers a brand new user experience with two main UI components: a search button and a search modal. This new pattern allows more search features than the previous dropdown.

User experience (UX)

Modal search

We replaced the dropdown list for a modal. A modal makes the search experience more immersive, allows to support more search-related features (see below) and integrates better on mobile.

We offer a search button that opens the modal, as well a the Cmd + K keyboard shortcut.

Search button

Search modal

Mobile experience

DocSearch 3 was thought with mobile in mind. We've come as closed as we could to a native mobile experience:

Full-screen view.

Close virtual keyboard on scroll. Native search patterns blur the input when you start scrolling to give users more space to discover the results displayed behind the keyboard. DocSearch supports this feature out of the box.

Back to previous scroll position.

Selection search.

Recent searches

Users often need to jump back to content that they just previously searched. It can be quite annoying to type again what you just typed. We introduced recent searches:

Favorite searches

When you're learning a new framework or a new concept, you often need to come back multiple times to the same content. Users can now build their own start screen by adding searches to their favorites:

Selection search

What if you didn't have to type a query to search for content? A pattern that we believe would prove itself useful is Selection Search. This allows users to find more content related to your selection via DocSearch.

Select content, hit the search button (or click it on desktop):

Search suggestions

Getting to a no results screen without indication can be frustrating. We now display search suggestions to jump back on main topics.

Offline detection

Not knowing why the search experience is loading endlessly or is not returning any results can be frustrating. We now detect when the search servers cannot answer and display data according to your network state.

We're investigating if offline search should be supported by DocSearch.

Dark mode

We support Docusaurus' dark mode:

Search button

Search modal

Color matching

The main colors are customizable via CSS variables for the DocSearch experience to match the Docusaurus websites.

Developer experience (DX)

React components

A recurring feedback from developers who implement DocSearch was the lack of React components. DocSearch has been rewritten in React and exposes React components now.

We'll base the vanilla JavaScript version on this React version with an alias to Preact.

Bundle size

Although this new version provides more features, the bundle is lightweight and compatible with lazy loading.

Lazy loading

Since we now export two components (search button and search modal) we can lazy load the modal to load the code only when needed.

This Docusaurus integration loads the modal code only when users are about the interact with the search: on the search button touch start on mobile and on hover on desktop.

What's next

We've been using this new DocSearch version on docsearch.algolia.com for a couple of weeks and a few users already expressed interest in this version.

Docusaurus is the first platform that we show this new version to. We consider this version as "beta" because it's a brand new direction that we've been reflecting on for over 3 years — we're open to your suggestions.

Once we roll it out to Docusaurus, we'll slowly roll it out to new DocSearch users.
CLA Signed pr: new feature
opened by francoischalifour 46
Feature: referencing variables from markdown pages

First of all, thanks for sharing and supporting Docusaurus! It's been pretty easy to get started.

I'm posting a feature request — I haven't found anything similar in the issue tracker so forgive me if it's been discussed before.

Motivation: sometimes docs need to reference information such as version numbers, URLs etc. and having them manually typed in the markdown pages is not ideal because this type of information often gets referenced multiple times.

Taking that into account, it would be great if Docusaurus supported passing variables into pages (from e.g. siteConfig). It already supports special Markdown markup via the <AUTOGENERATED_TABLE_OF_CONTENTS> marker, and it could potentially do something similar for variables.

For example, typing in<VAR:projectName> would get replaced with the value of siteConfig.projectName. Ideally this works in code blocks too (```).
feature difficulty: advanced

opened by julen 46
feat(content-docs): sidebar category linking to document or auto-generated index page
Breaking changes

Doc index slugs

Docs with the following filename patterns now have better urls/slugs:

docs/dir/subdir/index.md => slug becomes /docs/dir/subdir/ instead of /docs/dir/subdir/index

docs/dir/subdir/readme.md => slug becomes /docs/dir/subdir/ instead of /docs/dir/subdir/readme

docs/dir/subdir/subdir.md => slug becomes /docs/dir/subdir/ instead of /docs/dir/subdir/subdir

You can revert to the former behavior easily with frontmatter: slug: /dir/subdir/index

Motivation

Ability to link a sidebar category to a category introductory doc

Ability for auto-generated sidebars to use filename conventions (such as index.md) as category introductory doc

Ability to auto-generate a category index from its subitems

See also https://github.com/facebook/docusaurus/issues/2643

Not included

The following were considered but are not part of the current PR (may eventually come later):

Add a link: {type: "firstDoc"} shortcut to automatically link the category to its first child doc

Ability to add a generated-index link to all categories by default as a plugin option

Assign a default slug/path to a sidebar category (canny)

Have you read the Contributing Guidelines on pull requests?

yes

Test Plan

Unit tests, snapshots and dogfood on website

Test urls:

https://deploy-preview-5830--docusaurus-2.netlify.app/docs/next/category/getting-started

https://deploy-preview-5830--docusaurus-2.netlify.app/docs/next/category/guides

https://deploy-preview-5830--docusaurus-2.netlify.app/docs/next/markdown-features/

https://deploy-preview-5830--docusaurus-2.netlify.app/tests/docs/category/tests

Docs:

Category links (doc, generated-index)

Category index.md convention

docCategoryGeneratedIndexComponent option

CLA Signed pr: new feature pr: breaking change
opened by slorber 40

unable to start docusaurus

Have you read the Contributing Guidelines on issues?

[X] I have read the Contributing Guidelines on issues.

Prerequisites

[X] I'm using the latest version of Docusaurus.
[X] I have tried the npm run clear or yarn clear command.
[X] I have tried rm -rf node_modules yarn.lock package-lock.json and re-installing packages.
[ ] I have tried creating a repro with https://new.docusaurus.io.
[ ] I have read the console error message carefully (if applicable).

Description

 yarn start 
yarn run v1.22.19
$ docusaurus start
node:internal/modules/cjs/loader:1039
  const err = new Error(message);
              ^

Error: Cannot find module './fp/_baseConvert'
Require stack:
- C:\Users\MATTH\OneDrive\Documents\GitHub\vision-camera-face-detector\docs\node_modules\lodash\fp.js
- C:\Users\MATTH\OneDrive\Documents\GitHub\vision-camera-face-detector\docs\node_modules\wait-on\lib\wait-on.js
- C:\Users\MATTH\OneDrive\Documents\GitHub\vision-camera-face-detector\docs\node_modules\@docusaurus\core\lib\webpack\plugins\WaitPlugin.js
- C:\Users\MATTH\OneDrive\Documents\GitHub\vision-camera-face-detector\docs\node_modules\@docusaurus\core\lib\webpack\server.js
- C:\Users\MATTH\OneDrive\Documents\GitHub\vision-camera-face-detector\docs\node_modules\@docusaurus\core\lib\commands\build.js
- C:\Users\MATTH\OneDrive\Documents\GitHub\vision-camera-face-detector\docs\node_modules\@docusaurus\core\lib\index.js
    at Module._resolveFilename (node:internal/modules/cjs/loader:1039:15)
    at Module._load (node:internal/modules/cjs/loader:885:27)
    at Module.require (node:internal/modules/cjs/loader:1105:19)
    at require (node:internal/modules/cjs/helpers:103:18)
    at Object.<anonymous> (C:\Users\MATTH\OneDrive\Documents\GitHub\vision-camera-face-detector\docs\node_modules\lodash\fp.js:2:18)
    at Module._compile (node:internal/modules/cjs/loader:1218:14)
    at Module._extensions..js (node:internal/modules/cjs/loader:1272:10)
    at Module.load (node:internal/modules/cjs/loader:1081:32)
    at Module._load (node:internal/modules/cjs/loader:922:12)
    at Module.require (node:internal/modules/cjs/loader:1105:19) {
  code: 'MODULE_NOT_FOUND',
  requireStack: [
    'C:\\Users\\MATTH\\OneDrive\\Documents\\GitHub\\vision-camera-face-detector\\docs\\node_modules\\lodash\\fp.js',
    'C:\\Users\\MATTH\\OneDrive\\Documents\\GitHub\\vision-camera-face-detector\\docs\\node_modules\\wait-on\\lib\\wait-on.js',
    'C:\\Users\\MATTH\\OneDrive\\Documents\\GitHub\\vision-camera-face-detector\\docs\\node_modules\\@docusaurus\\core\\lib\\webpack\\plugins\\WaitPlugin.js',
    'C:\\Users\\MATTH\\OneDrive\\Documents\\GitHub\\vision-camera-face-detector\\docs\\node_modules\\@docusaurus\\core\\lib\\webpack\\server.js',
    'C:\\Users\\MATTH\\OneDrive\\Documents\\GitHub\\vision-camera-face-detector\\docs\\node_modules\\@docusaurus\\core\\lib\\commands\\build.js',
    'C:\\Users\\MATTH\\OneDrive\\Documents\\GitHub\\vision-camera-face-detector\\docs\\node_modules\\@docusaurus\\core\\lib\\index.js'
  ]
}

Node.js v19.3.0
error Command failed with exit code 1.
info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.

Reproducible demo

No response

Steps to reproduce

follow typescript installation. run in created folder yarn yarn start

Expected behavior

for it to work

Actual behavior

MODULE_NOT_FOUND

Your environment

Public source code:
Public site URL:
Docusaurus version used:
Environment name and version (e.g. Chrome 89, Node.js 16.4):
Operating system and version (e.g. Ubuntu 20.04.2 LTS):

Self-service

[ ] I'd be willing to fix this bug myself.

bug status: needs triage

opened by mat2718 2

404 error page after click `remark plugins` and `rehype plugins`
Have you read the Contributing Guidelines on issues?

[X] I have read the Contributing Guidelines on issues.

Prerequisites

[X] I'm using the latest version of Docusaurus.

[ ] I have tried the npm run clear or yarn clear command.

[ ] I have tried rm -rf node_modules yarn.lock package-lock.json and re-installing packages.

[ ] I have tried creating a repro with https://new.docusaurus.io.

[ ] I have read the console error message carefully (if applicable).

Description

On the docs/markdown-feature/plugins (MDX Plugins) page, both remark plugins and rehype plugins links lead to 404 error page.

Reproducible demo

No response

Steps to reproduce

go to docs/markdown-feature/plugins

click remark/rehype plugins links

Expected behavior

it should lead to the correct page about remark and rehype plugin pages

Actual behavior

both links leads to 404 error page

Your environment

Public source code:

Public site URL:

Docusaurus version used:

Environment name and version (e.g. Chrome 89, Node.js 16.4):

Operating system and version (e.g. Ubuntu 20.04.2 LTS):

Self-service

[ ] I'd be willing to fix this bug myself.

documentation
opened by victoriacheng15 3
[i18n] The idea of translating slugs
Have you read the Contributing Guidelines on issues?

[X] I have read the Contributing Guidelines on issues.

Motivation

Referring to #3317 discussion and https://docusaurus.io/docs/i18n/introduction#i18n-non-goals

I wanted to present my idea for translating slugs.

Example configuration

i18n: { defaultLocale: 'en', locales: ['en', 'pl'], slugsMode: 'map', // <--- values: `path` or `map` },

path as it is now

map based on the slugs map

Example md file

--- id: hello slug: /test/bonjour slugMap: /test/hello --- ...

There is a slugMap (parameter name proposal) parameter in the MD file from which the mapping will be created in the i18n//slugs.json file (js or json file). Alternatively, make one mapping file.

Example of a mapping file (i18n/<locale>/slugs.json)

{ "/test/hello": "/test/bonjour", "/test/i18n": "https://docusaurus.io/docs/i18n/introduction" }

The mapping would allow internal redirection and external redirection (a different address such as Crowdin) No slug in the mapping of switching to a particular language not possible.

https://docusaurus.io/docs/i18n/introduction#i18n-non-goals

Translation of slugs: technically complicated, little SEO value

I'm not a node/react programmer but it doesn't seem to have a hard time

https://github.com/facebook/docusaurus/issues/3317

Slugs Should we allow to create custom slugs per language? If we do that, to be able to switch from one lang to the other without loosing context (the doc you are currently reading), one version would have to be aware of the slugs of all the other language versions, which might be quite a lot of data.

With current Internet connections and available equipment, this does not seem to be a problem.

How do we access such data in a performant way?

Handling custom Slugs can be efficient , the mapping only needs to be loaded into memory once. Or you can divide the mapping into smaller files, e.g. one level of URL path one file .

path : docs/i18n , mapping file i18n/<locale>/docs/slugs.json or i18n/docs/slugs.json path : docs/i18n/introduction , mapping file i18n/<locale>/docs/introduction/slugs.json or i18n/docs/introduction/slugs.json

Self-service

[ ] I'd be willing to do some initial work on this proposal myself.

proposal status: needs triage
opened by mariuszkrzaczkowski 0
theme-search-algolia Polish translations
Pre-flight checklist

[x] I have read the Contributing Guidelines on pull requests.

[ ] If this is a code change: I have written unit tests and/or added dogfooding pages to fully verify the new behavior.

[ ] If this is a new API or substantial change: the PR has an accompanying issue (closes #0000) and the maintainers have approved on my working plan.

Motivation

Test Plan

Test links

Deploy preview: https://deploy-preview-_____--docusaurus-2.netlify.app/

Related issues/PRs
CLA Signed
opened by mariuszkrzaczkowski 4
collapsing a sidebar erroneously shows a collapse animation for open sub-items
Have you read the Contributing Guidelines on issues?

[X] I have read the Contributing Guidelines on issues.

Prerequisites

[X] I'm using the latest version of Docusaurus.

[X] I have tried the npm run clear or yarn clear command.

[X] I have tried rm -rf node_modules yarn.lock package-lock.json and re-installing packages.

[ ] I have tried creating a repro with https://new.docusaurus.io.

[X] I have read the console error message carefully (if applicable).

Description

When a sidebar has nested sections, collapsing the parent also shows the animation for the children icons.

https://user-images.githubusercontent.com/6070939/210901282-c0ba9a5d-c5f0-411c-9392-aaacbfb3776c.mov

Notice how the icon to the right of "iOS and Android Apps" spins even though the parent "Demos" block is collapsing.

It is surprising because the nested groups are not collapsed when the parent group is uncollapsed.

Reproducible demo

https://git.sheetjs.com/sheetjs/docs.sheetjs.com

Steps to reproduce

Visit https://docs.sheetjs.com/docs/demos/mobile/ on a computer and click the chevron next to "Demos". Observe that two icons rotate

Expected behavior

Only the Demos chevron rotates (since the inner block does not collapse when you expand the Demos group again)

Actual behavior

Both chevrons rotate

Your environment

Public source code: https://git.sheetjs.com/sheetjs/docs.sheetjs.com

Public site URL: https://docs.sheetjs.com/docs/demos/mobile/

Docusaurus version used: 2.2.0

Environment name and version (e.g. Chrome 89, Node.js 16.4): Chrome 108

Operating system and version (e.g. Ubuntu 20.04.2 LTS): macOS 12.6

Self-service

[ ] I'd be willing to fix this bug myself.

bug status: needs triage
opened by SheetJSDev 0
docs: the documentation, starter templates and tutorials should use the .mdx extension
As part of the MDX 2 migration (https://github.com/facebook/docusaurus/pull/8288) we want to encourage the usage of the .mdx extension, as it's historically not good to use .md and compile with MDX

For example, tooling (IDE, Prettier...) doesn't understand JSX when inside .md files

Also related to:

https://github.com/facebook/docusaurus/pull/8490

https://github.com/facebook/docusaurus/pull/8507

CLA Signed pr: polish
opened by slorber 4

Releases(v2.2.0)

v2.2.0(Oct 29, 2022)
2.2.0 (2022-10-29)

Blog post

Tweet

:rocket: New Feature

docusaurus-plugin-client-redirects

#8227 feat(plugin-client-redirects): keep the query string + hash (@Xabilahu)

docusaurus

#8210 feat(core): add --config param to swizzle command (@e-im)

docusaurus-mdx-loader, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-theme-classic, docusaurus-theme-mermaid, docusaurus-types, docusaurus

#7490 feat: support mermaid code blocks in Markdown (@sjwall)

docusaurus-types, docusaurus

#8151 feat(core): siteConfig.headTags API to render extra tags in document head (@johnnyreilly)

:bug: Bug Fix

docusaurus-plugin-ideal-image

#8250 fix(ideal-image): do not pass down img prop (@lex111)

docusaurus-theme-common

#8246 fix(mdx-loader): properly unwrap mdxAdmonitionTitle placeholder (@Josh-Cena)

docusaurus-plugin-content-docs

#8234 fix(plugin-content-docs): fix error message context (error cause) when doc processing fails (@shanpriyan)

docusaurus-theme-classic, docusaurus-theme-translations

#8207 fix(theme-classic): hamburger menu control navigation by keyboard (@jeferson-sb)

docusaurus-theme-classic, docusaurus-theme-common

#8204 fix(theme-classic): fix SkipToContent without JS , refactor, make it public theming API (@mturoci)

#8059 fix(theme): preserve url ?search#hash on navbar version/locale dropdowns navigations (@slorber)

docusaurus

#8192 fix(core): throw error for invalid URL in config file (@forgeRW)

docusaurus-theme-classic

#8174 fix(theme): announce theme switches (@mturoci)

#8190 fix(theme): add more tag names to inline code element set (@Josh-Cena)

#8163 fix(theme): mobile navbar & skipToContent should cover announcementBar (@adnanhashmi09)

#8068 fix(theme): preserve line breaks when copying code with showLineNumbers in Firefox (@LittleboyHarry)

docusaurus-utils

#8137 fix(utils): remove non-ASCII limitation for path normalization (@birjj)

#8158 fix(content-blog): make RSS feed generation work with slugs with .html extension (@Pranav2612000)

docusaurus-theme-translations

#8105 fix(theme-translations): complete turkish theme default translations (@ramazansancar)

#8087 fix(theme-translations): remove extra vi translations (@namnguyenthanhwork)

docusaurus-plugin-client-redirects

#8067 fix(redirect): tolerate trailing slash difference if config is undefined (@Josh-Cena)

:nail_care: Polish

docusaurus-theme-translations

#8253 chore(theme-translations): complete ru translations (@lex111)

#8243 chore(theme-translations): complete French translations (@forresst)

#8075 fix(theme-translation): complete Japanese theme default translation (@pasora)

docusaurus

#8159 fix(core): throw error for invalid URL in config file (@forgeRW)

#8109 feat(core): prefetch on mobile touchstart (@sanjaiyan-dev)

docusaurus-theme-classic

#8161 fix(theme): do not show tab content when tabbing over it; show after selection only (@mturoci)

#8062 refactor(theme): remove hard-coded tag border-radius (@homotechsual)

docusaurus-utils-validation, docusaurus

#8066 fix(core): normalize slashes for url/baseUrl instead of throwing (@Josh-Cena)

Committers: 22

Adnan Hashmi (@adnanhashmi09)

Alexey Pyltsyn (@lex111)

Forresst (@forresst)

Jan Peer Stöcklmair (@JPeer264)

Jeferson S. Brito (@jeferson-sb)

Johan Fagerberg (@birjj)

John Reilly (@johnnyreilly)

Joshua Chen (@Josh-Cena)

LittleboyHarry (@LittleboyHarry)

Masahiko Hara (@pasora)

Mikey O'Toole (@homotechsual)

Nguyễn Thành Nam (@namnguyenthanhwork)

Pranav Joglekar (@Pranav2612000)

Ramazan SANCAR (@ramazansancar)

Sam Wall (@sjwall)

Sanjaiyan Parthipan (@sanjaiyan-dev)

Shanmughapriyan S (@shanpriyan)

Sébastien Lorber (@slorber)

Xabier Lahuerta Vazquez (@Xabilahu)

@forgeRW

@mturoci

evan (@e-im)

Source code(tar.gz)
Source code(zip)
v2.1.0(Sep 2, 2022)
2.1.0 (2022-09-01)

:rocket: New Feature

docusaurus-theme-classic, docusaurus-theme-common

#8008 feat(theme): ability to use <DocCardList> without items prop, on any doc page (@slorber)

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

#7963 feat(docs): allow to configure noIndex per doc version (@slorber)

#7949 feat(plugin-docs): docs sidebar item link: support "autoAddBaseUrl" attribute (@slorber)

docusaurus-theme-translations

#7953 feat(theme): adds Ukrainian default theme translations (@b-ovsepian)

:bug: Bug Fix

create-docusaurus

#8032 fix(create-docusaurus): tutorial and init template improvements (@slorber)

docusaurus-preset-classic

#8029 fix(preset-classic): broken link in "unrecognized keys" error message (@mdubus)

docusaurus

#7977 fix(core): preload should support encoded page links (@adventure-yunfei)

#7996 fix(core): CLI command write-translations should extract translations from @docu… (@slorber)

#7952 fix(core): allow overriding ssr/dev template meta tags (@slorber)

docusaurus-plugin-sitemap

#7964 fix(sitemap): filter all routes with robots meta containing noindex (@slorber)

docusaurus-theme-classic

#7910 fix(theme-classic): code block line number display with line wrapping (@yzhe819)

#7786 fix: collapse siblings when first category is selected (@whiteand)

:nail_care: Polish

docusaurus-theme-classic

#7982 fix(theme): add aria-label to skip to content link region (@YoniChechik)

#7940 refactor(theme-classic): split AnnouncementBar, increase z-index, use shadow (@slorber)

#7876 refactor(theme-classic): make tag text visually certered (@Kosai106)

docusaurus-utils

#7941 feat(core): add new Webpack file-loader extensions: avif, mov, mkv, mpg, avi... (@slorber)

docusaurus-theme-classic, docusaurus-types

#7942 feat(theme-classic): use lang attribute in navbar locale dropdown items (@slorber)

docusaurus-theme-translations

#7928 chore(theme-translations): complete vi translations (@datlechin)

:memo: Documentation

create-docusaurus

#8032 fix(create-docusaurus): tutorial and init template improvements (@slorber)

docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-plugin-debug, docusaurus-plugin-google-analytics, docusaurus-plugin-google-gtag, docusaurus-plugin-ideal-image, docusaurus-plugin-sitemap, docusaurus-theme-classic

#7905 docs: remove mention of beta (@Josh-Cena)

Committers: 10

Bagdasar Ovsepyan (@b-ovsepian)

Joshua Chen (@Josh-Cena)

Kevin Østerkilde (@Kosai106)

Morgane Dubus (@mdubus)

Ngô Quốc Đạt (@datlechin)

Sébastien Lorber (@slorber)

Yoni Chechik (@YoniChechik)

@whiteand

@yzhe819

adventure-yunfei (@adventure-yunfei)

Source code(tar.gz)
Source code(zip)
v2.0.1(Aug 8, 2022)
2.0.1 (2022-08-01)

Fix bad npm publish of 2.0.0

Committers: 1

Sébastien Lorber (@slorber)

Source code(tar.gz)
Source code(zip)
v2.0.0(Aug 8, 2022)
2.0.0 (2022-08-01)

Bad npm publish, please use 2.0.1

:nail_care: Polish

docusaurus

#7781 refactor(core): log Docusaurus & Node version before exiting (@Josh-Cena)

Committers: 2

Joshua Chen (@Josh-Cena)

Sébastien Lorber (@slorber)

Source code(tar.gz)
Source code(zip)
v2.0.0-rc.1(Jul 14, 2022)
2.0.0-rc.1 (2022-07-14)

:bug: Bug Fix

docusaurus

#7776 fix(core): swizzle --eject js should not copy theme .d.ts files (@slorber)

#7750 fix(deploy): revert "feat(deploy): copy local git config to tmp repo (#7702)" (@ghostsquad)

docusaurus-plugin-sitemap

#7774 fix(sitemap): complete gracefully when all pages have noIndex meta (@Josh-Cena)

docusaurus-theme-classic

#7771 chore: bump Infima to 0.2.0-alpha.42, fix a:hover link bug (@slorber)

#7755 fix(theme-classic): validate options properly (@Josh-Cena)

#7752 fix(theme-classic): fix Layout theme height CSS (@LichLord91)

docusaurus-migrate

#7766 fix(migrate): import siteConfig with file extension (@Josh-Cena)

docusaurus-theme-search-algolia

#7761 fix(algolia-search): test for canUseIntersectionObserver (@RoiArthurB)

:nail_care: Polish

docusaurus-theme-translations

#7762 chore(theme-translations): complete ko translations (@anaclumos)

:memo: Documentation

docusaurus-plugin-content-docs

#7706 docs: release process, versioning, breaking changes, public API surface (@slorber)

:wrench: Maintenance

docusaurus-theme-classic

#7777 refactor(theme): fix duplicate page metadata usage (@slorber)

#7771 chore: bump Infima to 0.2.0-alpha.42, fix a:hover link bug (@slorber)

Committers: 11

Arthur Brugière (@RoiArthurB)

Bruce Song (@recallwei)

Evan (@DigiPie)

Jeffrey Aven (@jeffreyaven)

Joshua Chen (@Josh-Cena)

Sunghyun Cho (@anaclumos)

Sébastien Lorber (@slorber)

The Nguyen (@treoden)

Wes McNamee (@ghostsquad)

@LichLord91

凱恩 Kane (@Gary50613)

Source code(tar.gz)
Source code(zip)
v2.0.0-beta.22(Jul 8, 2022)
2.0.0-beta.22 (2022-07-08)

:boom: Breaking Change

docusaurus-theme-classic

#7740 refactor(theme): nest theme icons under subfolder @theme/Icon/* (@slorber)

docusaurus-plugin-content-blog, docusaurus-theme-classic, docusaurus-theme-common

#7716 refactor(theme): split BlogPostItem into smaller theme subcomponents (@slorber)

docusaurus-theme-classic, docusaurus-theme-common, docusaurus-theme-search-algolia

#7660 refactor(theme-common): split package into public/internal API entrypoints (@slorber)

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

#7644 refactor(docs,theme): split DocItem comp, useDoc hook (@slorber)

docusaurus-logger, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-types, docusaurus-utils, docusaurus

#7642 refactor: remove "error" reporting level, move reportMessage to logger (@Josh-Cena)

docusaurus-mdx-loader, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-theme-classic, docusaurus-utils-validation, docusaurus

#7152 refactor: handle all admonitions via JSX component (@lex111)

:rocket: New Feature

docusaurus-theme-translations

#7732 feat(theme-translations): Dutch translation (@reinvanhaaren)

#7715 feat(theme-translations): Swedish translation (@johnie)

docusaurus-theme-search-algolia, docusaurus-theme-translations

#7666 feat(algolia-search): allow translating search modal (@forresst)

create-docusaurus, docusaurus-theme-classic, docusaurus-theme-common

#7643 feat(theme-classic): themeConfig navbar/footer logos accept className/style + update Meta Open-Source Logo (@slorber)

docusaurus-plugin-client-redirects

#7649 feat(client-redirects): make plugin respect onDuplicateRoutes config (@Josh-Cena)

docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-types, docusaurus-utils, docusaurus

#7624 feat: allow customizing localization path of each locale (@Josh-Cena)

docusaurus

#7581 feat(core): allow opting out of HTML minification (@alexandernst)

docusaurus-theme-classic, docusaurus-theme-common

#7557 feat: allow specifying custom target for FooterLogo (@vannyle)

docusaurus-theme-classic, docusaurus-theme-common, docusaurus-theme-translations

#7556 feat: add admonition type title translations (@slorber)

docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-types, docusaurus-utils, docusaurus

#7386 feat(core): allow customizing the i18n directory path (@Josh-Cena)

docusaurus-theme-live-codeblock

#7514 feat(live-codeblock): add support for noInline to interactive code blocks (@jpdriver)

docusaurus-plugin-content-docs

#7461 feat(content-docs): last_update front matter (@dpang314)

:bug: Bug Fix

docusaurus-theme-classic

#7727 fix(theme): show blog post edit link even when no tag & not truncated (@anaclumos)

#7659 fix(theme-classic): expose empty string alt text in navbar logos (@BenDMyers)

#7595 fix(content-pages): add article wrapper around MDXContent (@matkoch)

docusaurus-theme-translations

#7694 fix(theme-translations): typo in vi locale (@saosangmo)

docusaurus-plugin-content-docs

#7638 fix(docs): forward doc frontMatter.sidebar_custom_props to linking sidebar category (@slorber)

#7634 fix(content-docs): allow translating doc labels in sidebars.js (@Josh-Cena)

docusaurus-utils

#7604 fix(utils): allow any non-boundary characters in Markdown heading ID (@Josh-Cena)

docusaurus-cssnano-preset

#7593 fix(cssnano-preset): disable z-index minification (@dpang314)

docusaurus-theme-common

#7551 fix(theme-classic): code block wrap mode should allow wrapping in the middle of a word (@slorber)

#7485 fix(theme-classic): inconsistent code block wrapping (@dpang314)

docusaurus-mdx-loader, docusaurus-module-type-aliases, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-plugin-debug, docusaurus-plugin-google-analytics, docusaurus-plugin-google-gtag, docusaurus-plugin-ideal-image, docusaurus-plugin-pwa, docusaurus-plugin-sitemap, docusaurus-preset-classic, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-types, docusaurus-utils-common, docusaurus-utils

#7521 fix: make type-checking work in Yarn PnP (@Josh-Cena)

:nail_care: Polish

docusaurus-theme-translations

#7696 fix(theme-translations): improve grammar of zh translation (@AkagiYui)

#7691 chore(theme-translations): complete vi translations (@datlechin)

#7683 chore(theme-translations): complete ar translations (@Altomy)

#7633 chore(theme-translations): complete ko translations (@HyunseungLee-Travis)

docusaurus

#7702 feat(deploy): copy local git config to tmp repo (@ghostsquad)

#7600 fix: force refresh on chunk preload error (@yangshun)

docusaurus-plugin-content-docs

#7673 fix(content-docs): format last update date as "Jun 19, 2020" (@sigwinch28)

docusaurus-theme-common, docusaurus-theme-search-algolia

#7671 refactor(theme-common): rename useDynamicCallback to useEvent (@slorber)

docusaurus-theme-common

#7648 fix(theme-common): make useShallowMemoObject key-order-insensitive (@Josh-Cena)

create-docusaurus

#7639 chore(create): update the facebook template with current assets (@zpao)

#7520 feat: add engines field to templates' package.json (@johnnyreilly)

docusaurus-mdx-loader, docusaurus-migrate, docusaurus-plugin-content-docs, docusaurus-plugin-pwa, docusaurus-theme-classic, docusaurus

#7579 refactor(pwa): simplify registerSW code, fix ESLint errors (@Josh-Cena)

docusaurus-plugin-google-analytics, docusaurus-plugin-google-gtag

#7545 feat(analytics): allow query/hash changes to be sent to GA (@lanegoolsby)

:memo: Documentation

Other

#7739 docs: swizzle react-live with eject (@SheetJSDev)

#7723 docs: add GitHub pages deployment troubleshooting guide (@Josh-Cena)

#7705 docs: mention MDXContent (@Josh-Cena)

#7675 docs: add docusaurus-openapi-docs to resources (@sserrata)

#7677 docs: add more info on github cross repo deployment (@bcabanes)

#7563 docs: add awesome-docusaurus resource (@webbertakken)

#7665 docs: add link from every category index page to the guide page (@Josh-Cena)

#7519 docs: multiple documentation elaborations (@Josh-Cena)

#7518 docs: remove useless front matter (@Josh-Cena)

#7512 docs: update Kent C. Dodds Twitter avatar (@DharsanB)

create-docusaurus

#7611 docs: advise using Node 18 in deployment (@Josh-Cena)

#7582 docs: make localhost links clickable (@dht)

docusaurus-plugin-client-redirects

#7607 refactor(client-redirects): elaborate documentation, minor refactor (@Josh-Cena)

:wrench: Maintenance

docusaurus-theme-classic, docusaurus-theme-common

#7676 refactor(theme): move LayoutProviders to Layout/Provider; composeProviders util (@slorber)

docusaurus-theme-classic

#7674 chore: prevent importing theme components with relative paths (@slorber)

#7664 chore: upgrade Infima to alpha.40 (@slorber)

Other

#7663 misc: share .vscode/extensions.json (@Josh-Cena)

docusaurus

#7583 refactor(cli): make the CLI an even thinner wrapper around command functions (@Josh-Cena)

#7547 chore: update static-site-generator-webpack-plugin (@slorber)

create-docusaurus, docusaurus-cssnano-preset, docusaurus-logger, docusaurus-mdx-loader, docusaurus-migrate, docusaurus-plugin-client-redirects, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-plugin-debug, docusaurus-plugin-google-analytics, docusaurus-plugin-google-gtag, docusaurus-plugin-ideal-image, docusaurus-plugin-pwa, docusaurus-plugin-sitemap, docusaurus-preset-classic, docusaurus-remark-plugin-npm2yarn, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-theme-live-codeblock, docusaurus-theme-search-algolia, docusaurus-theme-translations, docusaurus-types, docusaurus-utils-common, docusaurus-utils-validation, docusaurus-utils, docusaurus, eslint-plugin, lqip-loader, stylelint-copyright

#7586 chore: upgrade to TS 4.7, compile with NodeNext (@Josh-Cena)

Committers: 51

7Wate (@7Wate)

Ahmed Altomy (@Altomy)

Alexander Nestorov (@alexandernst)

Alexey Pyltsyn (@lex111)

Ben Myers (@BenDMyers)

Benjamin Cabanes (@bcabanes)

Boulet (@Boulet-)

Charles Ancheta (@cbebe)

Clemie McCartney (@clemiee)

DOLLE (@JeremyDolle)

Dharsan B (@DharsanB)

Diego França (@difranca)

Dima Grossman (@scopsy)

Dzung Do (@saosangmo)

Flávio Silva (@201flaviosilva)

Forresst (@forresst)

Huy Nguyen (@Smilefounder)

Hyunseung Lee (@HyunseungLee-Travis)

JP (@jpdriver)

Joe Harrison (@sigwinch28)

John Reilly (@johnnyreilly)

Johnie Hjelm (@johnie)

Joshua Chen (@Josh-Cena)

Joshua Schmitt (@jqshuv)

Kürşat Şimşek (@kursatsmsek)

Lane Goolsby (@lanegoolsby)

Le Thi Van (@vannyle)

Matthias Koch (@matkoch)

Ngô Quốc Đạt (@datlechin)

Paul O’Shannessy (@zpao)

Redcamel (@redcamel)

Rein van Haaren (@reinvanhaaren)

Rudra Sen (@RudraSen2)

Steven Serrata (@sserrata)

Sunghyun Cho (@anaclumos)

Szilárd Dóró (@szilarddoro)

Sébastien Lorber (@slorber)

Tom Mrazauskas (@mrazauskas)

Webber Takken (@webbertakken)

Wes McNamee (@ghostsquad)

Yangshun Tay (@yangshun)

@SheetJSDev

@alewolf

@dpang314

dht (@dht)

emattia (@emattia)

pincman (@pincman)

sado (@sado0823)

凱恩 Kane (@Gary50613)

李小雨 (@metal-young)

赤城结衣 (@AkagiYui)

Source code(tar.gz)
Source code(zip)
v2.0.0-beta.21(May 27, 2022)
2.0.0-beta.21 (2022-05-27)

:boom: Breaking Change

docusaurus-plugin-pwa

#7422 refactor(pwa): remove reloadPopup option in favor of swizzling (@Josh-Cena)

create-docusaurus, docusaurus-cssnano-preset, docusaurus-logger, docusaurus-mdx-loader, docusaurus-migrate, docusaurus-plugin-client-redirects, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-plugin-debug, docusaurus-plugin-google-analytics, docusaurus-plugin-google-gtag, docusaurus-plugin-ideal-image, docusaurus-plugin-pwa, docusaurus-plugin-sitemap, docusaurus-preset-classic, docusaurus-remark-plugin-npm2yarn, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-theme-live-codeblock, docusaurus-theme-search-algolia, docusaurus-theme-translations, docusaurus-utils-common, docusaurus-utils-validation, docusaurus-utils, docusaurus, eslint-plugin, lqip-loader

#7501 chore: require Node 16.14 (@Josh-Cena)

:rocket: New Feature

docusaurus-plugin-sitemap

#7469 feat(sitemap): allow customizing the output name (@Josh-Cena)

docusaurus-utils, docusaurus

#7371 feat(core): support docusaurus.config.cjs as default file name (@Josh-Cena)

docusaurus

#7500 feat: make docusaurus serve automatically open in browser (@Zamiell)

#7452 feat: add --no-minify flag to docusaurus start (@lanegoolsby)

docusaurus-theme-classic

#7357 feat(theme-classic): allow className as option for type: "search" (@JPeer264)

:bug: Bug Fix

docusaurus

#7362 fix: always emit SEO title + og:title meta (@charleskorn)

#7453 fix(core): avoid using logger and fs.readJSON in SSR (@Josh-Cena)

#7369 fix(cli): output correct path when swizzling bare-file component in subfolder (@Josh-Cena)

#7360 fix(core): allow githubPort in config validation (@mhughes2k)

docusaurus-plugin-google-gtag

#7424 fix(gtag): send the newly rendered page's title instead of the old one's (@ori-shalom)

create-docusaurus, docusaurus-utils

#7507 fix(create-docusaurus): potential security issue with command injection (@slorber)

docusaurus-module-type-aliases, docusaurus-theme-classic, docusaurus

#7492 fix(core): always treat error boundary fallback as a callback (@Josh-Cena)

docusaurus-theme-classic

#7438 fix(theme-classic): allow nested task lists to preserve the indent (@Josh-Cena)

#7430 fix(theme-classic): consistently apply the right active class name for all navbar items (@Josh-Cena)

#7411 fix(theme-classic): autocollapse sidebar categories when navigating with paginator (@pranabdas)

#7363 fix(theme-classic): resolve customCss from site dir (@Josh-Cena)

docusaurus-utils

#7464 fix(utils): fix Markdown link replacement when link text is same as href (@Josh-Cena)

#7458 fix(utils): avoid replacing Markdown links missing the directly next link (@Josh-Cena)

docusaurus-mdx-loader

#7392 fix(mdx-loader): use React.Fragment as fragment factory (@Josh-Cena)

docusaurus-plugin-content-docs

#7385 fix(content-docs): restore functionality when a category only has index page (@Josh-Cena)

:nail_care: Polish

docusaurus-theme-translations

#7493 chore(theme-translations): complete French translations (@forresst)

#7474 chore(theme-translations): complete zh translations (@Josh-Cena)

#7400 chore(theme-translations): complete Farsi translations (@massoudmaboudi)

docusaurus

#7499 fix: avoid printing period after localhost URL (@Zamiell)

create-docusaurus

#7374 refactor(create): clean up logic when prompting for unspecified arguments (@Josh-Cena)

:memo: Documentation

#7503 docs: document MDXComponents scope (@Josh-Cena)

#7497 docs: link every reference of types in API table to the type definition (@Zamiell)

#7407 docs: add Azure SWA as deployment option (@nitya)

#7390 fix(website): use react-lite-youtube-embed for lazy YouTube video (@matkoch)

:wrench: Maintenance

create-docusaurus, docusaurus-logger, docusaurus-mdx-loader, docusaurus-migrate, docusaurus-module-type-aliases, docusaurus-plugin-client-redirects, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-plugin-debug, docusaurus-plugin-google-gtag, docusaurus-plugin-ideal-image, docusaurus-plugin-pwa, docusaurus-plugin-sitemap, docusaurus-remark-plugin-npm2yarn, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-theme-live-codeblock, docusaurus-theme-search-algolia, docusaurus-theme-translations, docusaurus-utils-validation, docusaurus-utils, docusaurus, lqip-loader, stylelint-copyright

#7477 refactor: fix a lot of errors in type-aware linting (@Josh-Cena)

docusaurus-theme-classic, docusaurus-theme-translations

#7447 refactor(theme-classic): migrate to tsc for build (@Josh-Cena)

stylelint-copyright

#7441 refactor(stylelint-copyright): migrate to TS (@Josh-Cena)

docusaurus-cssnano-preset

#7440 refactor(cssnano-preset): migrate to TS (@Josh-Cena)

create-docusaurus, docusaurus-logger, docusaurus-mdx-loader, docusaurus-migrate, docusaurus-plugin-client-redirects, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-plugin-debug, docusaurus-plugin-google-analytics, docusaurus-plugin-google-gtag, docusaurus-plugin-ideal-image, docusaurus-plugin-pwa, docusaurus-plugin-sitemap, docusaurus-preset-classic, docusaurus-remark-plugin-npm2yarn, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-theme-live-codeblock, docusaurus-theme-search-algolia, docusaurus-theme-translations, docusaurus-utils-common, docusaurus-utils-validation, docusaurus-utils, docusaurus, eslint-plugin, lqip-loader

#7437 refactor: use TS project references instead of running tsc multiple times (@Josh-Cena)

docusaurus-plugin-pwa

#7421 refactor(pwa): migrate client modules to TS (@Josh-Cena)

docusaurus-theme-classic

#7415 refactor(theme-classic): always collocate stylesheets with components in one folder (@Josh-Cena)

docusaurus

#7405 refactor(core): properly code-split NotFound page (@Josh-Cena)

Committers: 23

Akara (@Messiahhh)

Benjamin Diolez (@BenDz)

Charles Korn (@charleskorn)

Designatory (@Designatory)

Forresst (@forresst)

Ggicci (@ggicci)

James (@Zamiell)

Jan Peer Stöcklmair (@JPeer264)

Jeremy (@jrmyw92)

Joshua Chen (@Josh-Cena)

Junjie (@junjieweb)

Lane Goolsby (@lanegoolsby)

Massoud Maboudi (@massoudmaboudi)

Matthias Koch (@matkoch)

Michael Hughes (@mhughes2k)

Ngô Quốc Đạt (@datlechin)

Nitya Narasimhan (@nitya)

Oluwatobi Sofela (@oluwatobiss)

Ori Shalom (@ori-shalom)

Pranab Das (@pranabdas)

Rui Peres (@RuiAAPeres)

Sébastien Lorber (@slorber)

凱恩 Kane (@Gary50613)

Source code(tar.gz)
Source code(zip)
v2.0.0-beta.20(May 5, 2022)
2.0.0-beta.20 (2022-05-05)

:bug: Bug Fix

docusaurus

#7342 fix: avoid flash of page scrolling to top on refresh (@slorber)

#7329 fix(core): inject docusaurus version into SSR as local (@RDIL)

docusaurus-theme-classic

#7341 fix(theme-classic): properly highlight code block line numbers (@Josh-Cena)

:memo: Documentation

#7334 feat(website): make canary release page display actual canary version name (@Josh-Cena)

#7343 docs: add page for create-docusaurus API documentation (@Josh-Cena)

#7340 docs: add Yandex Metrika plugin to community plugins (@sgromkov)

#7336 fix(website): fix multiple accessibility issues around color contrast (@Josh-Cena)

#7327 docs: add clarity to versioning behavior (@pepopowitz)

Committers: 6

Alexey Pyltsyn (@lex111)

Joshua Chen (@Josh-Cena)

Reece Dunham (@RDIL)

Sergey Gromkov (@sgromkov)

Steven Hicks (@pepopowitz)

Sébastien Lorber (@slorber)

Source code(tar.gz)
Source code(zip)
v2.0.0-beta.19(May 4, 2022)
2.0.0-beta.19 (2022-05-04)

:rocket: New Feature

docusaurus-theme-classic, docusaurus-theme-common

#7178 feat(theme-classic): extensible code block magic comment system (@Josh-Cena)

#7007 feat(theme-classic): code block showLineNumbers (@lex111)

#7012 feat(theme-classic): show blog sidebar on mobile (@Josh-Cena)

docusaurus-theme-classic, docusaurus-theme-live-codeblock, docusaurus, eslint-plugin

#7206 feat: Docusaurus ESLint plugin to enforce best Docusaurus practices (@elias-pap)

docusaurus-plugin-google-analytics, docusaurus-plugin-google-gtag, docusaurus-theme-classic, docusaurus-types, docusaurus

#6732 feat(core): rework client modules lifecycles, officially make API public (@Josh-Cena)

docusaurus-theme-classic

#7231 feat: allow custom navbarItem types to pass through validation (@slorber)

#7058 feat(theme-classic): new 'html' type navbar item (@lex111)

#7079 feat: allow using pure HTML as label in navbar links (@lex111)

docusaurus-theme-classic, docusaurus-theme-common, docusaurus-theme-translations

#7036 feat(theme-classic): toggle code wrap button (@lex111)

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

#6457 feat(content-docs): draft docs excluded from build & sidebars (@jodyheavener)

docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-types, docusaurus

#6430 feat: allow setting calendar for i18n date formatting (@Josh-Cena)

docusaurus-module-type-aliases, docusaurus-plugin-content-docs, docusaurus-types, docusaurus

#7083 feat(core): fail-safe global data fetching (@Josh-Cena)

docusaurus-plugin-content-docs

#7106 feat(content-docs): make docs:version command work on localized docs (@Josh-Cena)

docusaurus-types, docusaurus

#7082 feat(core): allow plugins to declare custom route context (@Josh-Cena)

#7124 feat(core): allow plugin/preset config to contain false/null (@Josh-Cena)

docusaurus-plugin-sitemap, docusaurus-utils

#6979 feat(sitemap): add ignorePatterns option (@ApsarasX)

:boom: Breaking Change

docusaurus-types, docusaurus

#7257 refactor: remove long-deprecated routesLoaded lifecycle (@Josh-Cena)

docusaurus-theme-classic, docusaurus-theme-common

#7277 refactor(theme-classic): move all sidebar-related config under themeConfig.docs.sidebar (@Josh-Cena)

docusaurus-plugin-google-analytics, docusaurus-plugin-google-gtag, docusaurus-theme-classic, docusaurus-types, docusaurus

#6732 feat(core): rework client modules lifecycles, officially make API public (@Josh-Cena)

create-docusaurus, docusaurus-theme-classic

#7176 refactor: customize code block line highlight color via CSS var (@lex111)

docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-types, docusaurus-utils-validation, docusaurus-utils

#7117 refactor(content-{blog,docs}): unify handling of tags (@Josh-Cena)

docusaurus-mdx-loader, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-theme-classic, docusaurus-theme-live-codeblock

#7027 refactor(content-docs): deduplicate types, JSDoc for some APIs (@Josh-Cena)

:bug: Bug Fix

docusaurus-theme-classic

#7304 fix(theme-classic): remove breadcrumb items without href from microdata (@Josh-Cena)

#7179 fix(theme-classic): do not add microdata item prop to trailing breadcrumb (@Josh-Cena)

#7173 fix(theme-classic): admonition title: disable text-transform on inline code blocks (@chelproc)

#7048 fix(theme-classic): add caret for dropdown on mobile (@lex111)

#7025 fix: make docs page wrapper take full height (@lex111)

#7013 fix(theme-classic): adjust shadow on code block (@chernodub)

#7015 fix(theme-classic): do not add caret for non-collapsible categories (@Josh-Cena)

docusaurus-plugin-client-redirects, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-plugin-debug, docusaurus-plugin-google-analytics, docusaurus-plugin-google-gtag, docusaurus-plugin-sitemap, docusaurus-preset-classic, docusaurus-theme-classic

#7294 fix(*): make TypeScript realize that each plugin package has a default export (@Josh-Cena)

docusaurus

#7285 fix(core): allow empty static directories (@Josh-Cena)

#7180 fix: pass pollOptions to webpack (@JohnnyMcWeed)

#7184 fix(core): prevent 404 when accessing /page.html (@Josh-Cena)

#7225 fix: allow swizzling a component's parent folder (@slorber)

#7066 fix(core): all plugin lifecycles should receive translated content (@Josh-Cena)

docusaurus-plugin-content-docs

#7233 fix(content-docs): make category index text translatable (@Josh-Cena)

docusaurus-theme-common

#7200 fix(theme-common): do not persist color mode for OS-triggered changes (@Josh-Cena)

#7057 fix(theme-common): use native scrolling when smooth behavior set in CSS (@Josh-Cena)

#7033 fix(theme): only parse HTML- and JSX-style comments in MD code (@Josh-Cena)

docusaurus-plugin-content-blog

#7212 fix(content-blog): make footnote reference DOM ID unique on post listing page (@AkiraVoid)

docusaurus-utils, docusaurus

#7187 fix(core): handle case where package.json is not available at CWD (@Josh-Cena)

docusaurus-theme-translations

#7222 fix(theme-translations): fix invalid pluralization in cs (@Josh-Cena)

#7166 fix(theme-translations): always try all possible locale resolutions (@Josh-Cena)

docusaurus-theme-classic, docusaurus-theme-search-algolia

#7164 fix: adjust spacing for custom search properly (@lex111)

docusaurus-plugin-debug, docusaurus-plugin-sitemap, docusaurus-preset-classic, docusaurus-types, docusaurus

#7143 fix(sitemap): exclude pages with robots noindex from sitemap (@Josh-Cena)

create-docusaurus, docusaurus-types

#7078 fix(create): install types for JS template as well (@Josh-Cena)

docusaurus-utils

#7043 fix(utils): parse Markdown headings with CRLF line break (@Josh-Cena)

docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-utils, docusaurus

#7023 refactor: fix a few places of path handling (@Josh-Cena)

docusaurus-types

#7014 fix(types): declare history and react-loadable as dependencies (@sulu5890)

:nail_care: Polish

docusaurus-theme-classic, docusaurus-theme-translations

#7299 refactor: minor improvements for breadcrumbs (@lex111)

create-docusaurus

#7290 refactor(create): add i18n config in init template (@Josh-Cena)

#7286 refactor(create): update screenshots in quick start tutorial (@Josh-Cena)

#7223 refactor: use generated-index in init templates (@slorber)

#7118 refactor(create): mention that the edit links can be removed (@Josh-Cena)

docusaurus-plugin-debug, docusaurus-theme-classic

#7306 chore: upgrade Infima to alpha.39 (@lex111)

docusaurus-plugin-debug, docusaurus-types, docusaurus

#7291 feat(types): JSDoc for docusaurus config fields (@Josh-Cena)

docusaurus-theme-classic, docusaurus-theme-common

#7267 fix(theme-common): allow details to not provide a summary (@Josh-Cena)

#7172 refactor: control base styling of code blocks via CSS vars (@lex111)

#7129 refactor(theme-classic): fix a few margin inconsistencies (@lex111)

docusaurus-plugin-content-docs, docusaurus-utils

#7248 refactor: normalize Markdown linkification behavior, elaborate in documentation (@Josh-Cena)

docusaurus-theme-classic

#7244 refactor: semantic markup improvement, fix validation warnings (@Josh-Cena)

#7183 refactor: use SVG icon for home breadcrumb (@Dr-Electron)

#7139 fix: proper spacing between generated card items on mobiles (@lex111)

#7134 fix(theme-classic): fix docs sidebar layout shifts when expanding categories (@slorber)

#7068 refactor(theme-classic): blog mobile secondary menu use consistent styles (@Josh-Cena)

#7004 fix(theme-classic): shrink title size on mobile (@Pierre-Gilles)

docusaurus-theme-translations

#7214 chore(theme-translations): complete Polish translations (@rev4324)

#7031 chore(theme-translations): complete German translations (@deployn)

create-docusaurus, docusaurus-theme-classic

#7176 refactor: customize code block line highlight color via CSS var (@lex111)

docusaurus

#7218 fix(cli): always show error stack to unhandled rejection (@Josh-Cena)

#7142 refactor(core): lower timeout before rendering progress bar to 200ms (@Josh-Cena)

#7103 fix(core): preserve Interpolate children semantics (@Josh-Cena)

#7029 refactor: console output improvements (@lex111)

#7017 refactor: remove copyright comment from swizzled components (@lex111)

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

#7148 feat(preset-classic, content-docs/client): JSDoc (@Josh-Cena)

docusaurus-plugin-debug, docusaurus-preset-classic

#7122 feat(preset-classic): exclude debug plugin routes from sitemap (@lex111)

docusaurus-theme-common, docusaurus-utils, docusaurus

#7113 test: improve test coverage (@Josh-Cena)

docusaurus-mdx-loader, docusaurus-migrate, docusaurus-module-type-aliases, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-ideal-image, docusaurus-remark-plugin-npm2yarn, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-theme-live-codeblock, docusaurus-types, docusaurus-utils-validation, docusaurus

#7080 refactor: replace non-prop interface with type; allow plugin lifecycles to have sync type (@Josh-Cena)

create-docusaurus, docusaurus-logger, docusaurus-plugin-content-docs, docusaurus

#7019 feat(logger): new "url" format, add double quotes around paths (@lex111)

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

#7006 refactor: split and cleanup theme/DocPage (@slorber)

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

#7005 refactor: split DocSidebarItem by item type (@slorber)

:memo: Documentation

docusaurus-logger

#7305 docs: update docs for logger, add API docs to website (@Josh-Cena)

Other

#7284 docs: add a paragraph about SSR as an optimization technique (@Josh-Cena)

#7278 docs: enhance docs about Markdown TOC and metadata (@Josh-Cena)

#7271 docs: specify Node version requirement to a minor (@DanRoscigno)

#7252 docs: update gtag docs to reflect what a GA4 tag looks like (@johnnyreilly)

#7240 docs: add PCC Archive site to showcase (@CuratorCat)

#7239 docs: add Chaos mesh site to showcase (@cwen0)

#7235 docs: add TiDB community books to showcase (@shczhen)

#7236 docs: add documentation about pluralization (@Josh-Cena)

#7230 docs: add OSS Insight to showcase (@sykp241095)

#7208 docs: remove mention of "template" from README installation guide (@Josh-Cena)

#7159 docs: explain more clearly the purpose of a ref sidebar type (@andrewnicols)

#7126 docs: multiple documentation improvements (@Josh-Cena)

#7123 refactor(showcase): enforce descriptions with maximum length of 120 characters (@Josh-Cena)

#7026 docs: correct plugin example filename (@mxhdx)

#7110 docs: add a note about additional languages needing to be Prism component names (@Josh-Cena)

#6746 fix(website): lazy-load YT iframe (@Josh-Cena)

#7061 docs: add docusaurus-plugin-typedoc to resources (@nartc)

#7059 docs: add firelordjs to showcase (@Josh-Cena)

#7050 docs: add import React statement in JSX file example (@kaycebasques)

#7022 docs: add Easypanel to showcase (@deiucanta)

#7016 docs: consistently use sidebars.js filename (@leedom92)

#7020 docs: add Divine WSF and Ghostly to showcase (@LeviticusMB)

#7000 docs: remove unnecessary semicolon (@imsingh)

docusaurus-plugin-content-docs, docusaurus-utils

#7248 refactor: normalize Markdown linkification behavior, elaborate in documentation (@Josh-Cena)

create-docusaurus, docusaurus-plugin-content-docs, docusaurus-theme-classic, docusaurus-utils

#7081 docs: fix some casing inconsistencies (@Josh-Cena)

:wrench: Maintenance

Other

#7309 chore: use "Maintenance" instead of "Internal" in changelog (@Josh-Cena)

#7300 misc: check doc page by Lighthouse CI (@lex111)

#7266 misc: add links section to PR template (@slorber)

#7224 chore: GitHub Actions cancel-in-progress (@slorber)

#7216 chore: remove netlify-cli from devDependencies (@Josh-Cena)

#7211 chore: replace node 17 with 18 in CI matrix (@Josh-Cena)

#7168 misc: add CI actions/dependency-review-action for security (@slorber)

#6984 misc: pin actions to a full-length commit SHA (@naveensrinivasan)

#7002 chore: regen examples for 2.0 beta.18 (@slorber)

docusaurus-logger, docusaurus-remark-plugin-npm2yarn

#7295 refactor: use export = syntax for Node utility packages (@Josh-Cena)

docusaurus-mdx-loader, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-types, docusaurus-utils-validation, docusaurus-utils, docusaurus

#7293 refactor(types): move non-core, non-public types out of the types package (@Josh-Cena)

docusaurus-types, docusaurus

#7292 refactor(core): collocate CLI commands and their option types (@Josh-Cena)

#7084 refactor(core): code cleanup (@Josh-Cena)

docusaurus-module-type-aliases, docusaurus

#7282 refactor(core): prefetch/preload refactor (@Josh-Cena)

docusaurus-theme-classic, docusaurus-theme-common

#7273 refactor(theme-classic): multiple re-arrangements (@Josh-Cena)

#7268 refactor(theme-classic): DocPage theme refactors polish (@slorber)

#7269 refactor: extract useSkipToContent() (@slorber)

#7175 refactor(theme-classic): split CodeBlock (@slorber)

#7067 refactor(theme-classic): extract doc-related navbar items' logic to theme-common (@Josh-Cena)

#7021 refactor(theme): extract plumbing code of BTT button into theme-common (@Josh-Cena)

docusaurus-theme-classic

#7270 refactor(theme-classic): refactor TOC-related theme components (@slorber)

docusaurus

#7220 refactor(cli): normalize the application of default option values (@Josh-Cena)

#7141 refactor(core): minor PendingNavigation refactor (@Josh-Cena)

docusaurus-plugin-content-docs

#7243 chore: upgrade Jest to 28; add GitHub-actions reporter (@Josh-Cena)

#7140 refactor(content-docs): split version handling into several files (@Josh-Cena)

docusaurus-mdx-loader, docusaurus-plugin-content-blog, docusaurus-plugin-ideal-image, docusaurus-plugin-pwa, docusaurus-theme-live-codeblock, docusaurus

#7194 fix: fix a few internal declaration semantic errors (@Josh-Cena)

create-docusaurus, docusaurus-migrate, docusaurus-theme-translations, docusaurus

#7186 refactor: prefer fs.readJSON over readFile.then(JSON.parse) (@Josh-Cena)

docusaurus-mdx-loader, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages

#7145 refactor: unify how MDX content types are represented (@Josh-Cena)

create-docusaurus, docusaurus-mdx-loader, docusaurus-migrate, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-plugin-ideal-image, docusaurus-plugin-pwa, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-theme-search-algolia, docusaurus-types, docusaurus-utils, docusaurus, lqip-loader

#7138 chore: upgrade dependencies + upgrade React types (@Josh-Cena)

docusaurus-logger, docusaurus-mdx-loader, docusaurus-migrate, docusaurus-plugin-client-redirects, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-plugin-sitemap, docusaurus-remark-plugin-npm2yarn, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-theme-live-codeblock, docusaurus-theme-search-algolia, docusaurus-theme-translations, docusaurus-utils-validation, docusaurus-utils, docusaurus

#7131 chore: disable string escaping in snapshots (@Josh-Cena)

docusaurus-module-type-aliases, docusaurus-plugin-content-blog, docusaurus-theme-common, docusaurus-types, docusaurus-utils, docusaurus

#7054 refactor(core): refactor routes generation logic (@Josh-Cena)

docusaurus-module-type-aliases, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-types, docusaurus

#7042 refactor(core): reorganize files (@Josh-Cena)

docusaurus-plugin-content-docs, docusaurus-utils, docusaurus

#7037 refactor(core): reorganize functions (@Josh-Cena)

docusaurus-mdx-loader, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-theme-classic, docusaurus-theme-live-codeblock

#7027 refactor(content-docs): deduplicate types, JSDoc for some APIs (@Josh-Cena)

:running_woman: Performance

docusaurus-plugin-content-docs, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-theme-live-codeblock, docusaurus-theme-search-algolia, docusaurus-utils-common

#7085 refactor: mark a few client-side packages as side-effect-free (@Josh-Cena)

docusaurus-mdx-loader, docusaurus-remark-plugin-npm2yarn

#4997 perf(mdx-loader): cache mdx/remark compiler instances (@phryneas)

Committers: 47

Aaron Nwabuoku (@aerovulpe)

AkiraVoid (@AkiraVoid)

Alexey Pyltsyn (@lex111)

Andrei Canta (@deiucanta)

Andrew Lyons (@andrewnicols)

ApsarasX (@ApsarasX)

Chau Tran (@nartc)

Chinazaekpere Ngubo (@dr-ngubo)

Cwen Yin (@cwen0)

Dan Roscigno (@DanRoscigno)

Elias Papavasileiou (@elias-pap)

Evan (@sulu5890)

Fusang❀ (@cxOrz)

Indermohan Singh (@imsingh)

JMW (@JohnnyMcWeed)

Jeffrey Aven (@jeffreyaven)

Jody Heavener (@jodyheavener)

John Reilly (@johnnyreilly)

Joshua Chen (@Josh-Cena)

Karl Ward (@mjau-mjau)

Kayce Basques (@kaycebasques)

Leedom (@leedom92)

Lenz Weber-Tronic (@phryneas)

Lukas Bach (@lukasbach)

Martin Blom (@LeviticusMB)

Naveen (@naveensrinivasan)

Pablo Cordon (@pcordon)

Pierre-Gilles Leymarie (@Pierre-Gilles)

Qi Zhang (@zzzhangqi)

Sébastien Lorber (@slorber)

Viktor Chernodub (@chernodub)

Zac A (@sandypockets)

@Dr-Electron

@chelproc

@deployn

@duanwilliam

@kgolubic

@redhat123456

@surendran82

@svix-ken

apq (@AntonPalmqvist)

curatorcat.pcc.eth (@CuratorCat)

czhen (@shczhen)

loic (@layerzzzio)

mehdim (@mxhdx)

rev (@rev4324)

sykp241095 (@sykp241095)

Source code(tar.gz)
Source code(zip)
v2.0.0-beta.18(Mar 25, 2022)
2.0.0-beta.18 (2022-03-25)

:rocket: New Feature

docusaurus-mdx-loader, docusaurus-theme-classic

#6990 feat: lazy-load external images + ability to customize image display (@slorber)

docusaurus-module-type-aliases, docusaurus-plugin-content-docs, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-types, docusaurus

#6933 feat(core,theme): useRouteContext + HtmlClassNameProvider (@slorber)

docusaurus-plugin-debug, docusaurus-plugin-google-analytics, docusaurus-plugin-google-gtag, docusaurus-plugin-ideal-image, docusaurus-plugin-pwa, docusaurus-theme-classic, docusaurus-theme-live-codeblock, docusaurus-theme-search-algolia, docusaurus-types, docusaurus

#6921 feat(core): allow plugin lifecycles to return relative paths (@Josh-Cena)

docusaurus-theme-classic

#6697 feat: add SEO microdata for doc breadcrumbs (@Josh-Cena)

#6842 feat(theme-classic): MDXContent wrapper component (@slorber)

docusaurus-plugin-content-docs

#6780 feat(content-docs): allow custom props through category.json (@taejs)

:boom: Breaking Change

docusaurus-plugin-content-docs

#6859 feat(content-docs): autogenerate category with linked doc metadata as fallback (@Josh-Cena)

docusaurus-theme-classic

#6989 refactor: extract MDX components (@slorber)

docusaurus-module-type-aliases, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-theme-search-algolia, docusaurus

#6925 refactor(theme-{classic,common}): refactor site/page/search metadata + apply className on html element (@slorber)

docusaurus-theme-classic, docusaurus-theme-common

#6895 refactor(theme-{classic,common}): split navbar into smaller components + cleanup + swizzle config (@slorber)

#6930 refactor(theme-{classic,common}): refactor ColorModeToggle + useColorMode() hook (@lex111)

:bug: Bug Fix

docusaurus

#6993 fix(core): prevent useBaseUrl returning /base/base when on /base (@Josh-Cena)

#6936 fix: remove semicolon from HTML output (@lex111)

#6849 fix(cli): write-heading-id should not generate colliding slugs when not overwriting (@Josh-Cena)

docusaurus-theme-classic

#6983 fix(search): bump Infima, fix search issue due to broken CSS selector (@slorber)

docusaurus-utils-validation

#6977 fix(validation): allow non-object params to remark/rehype plugins (@aloisklink)

docusaurus-plugin-content-docs, docusaurus-utils

#6973 fix(content-docs): suppress git error on multiple occurrences (@felipecrs)

docusaurus-plugin-content-blog

#6947 fix(content-blog): only create archive route if there are blog posts (@Josh-Cena)

#6918 fix(content-blog): remove double leading slash in blog-only paginated view (@heowc)

docusaurus-theme-search-algolia

#6888 fix(theme-algolia): declare content-docs as dependency (@Josh-Cena)

docusaurus-theme-translations

#6847 fix: minor Chinese translation fixes (@rccttwd)

:nail_care: Polish

docusaurus-plugin-content-docs

#6859 feat(content-docs): autogenerate category with linked doc metadata as fallback (@Josh-Cena)

#6887 fix(content-docs): give context about sidebar loading failure (@Josh-Cena)

docusaurus-plugin-content-docs, docusaurus-utils-validation, docusaurus

#6997 fix(validation): improve error messages for a few schemas (@Josh-Cena)

docusaurus-theme-classic

#6971 refactor: improve a11y of dropdown menu (@lex111)

#6987 refactor(theme-classic): cleanup of code blocks (@lex111)

#6950 refactor(theme-classic): clean up CSS of doc cards (@lex111)

#6994 refactor: better external link icon positioning (@lex111)

#6989 refactor: extract MDX components (@slorber)

#6985 refactor(theme-classic): remove span wrappers from layout links (@lex111)

#6986 fix(theme-classic): minor code copy button improvements (@Josh-Cena)

#6964 refactor: replace text-based copy code button with icons (@lex111)

#6932 refactor(theme-classic): little breadcrumbs improvements (@lex111)

#6914 feat(theme-classic): set aria-expanded on expandable sidebar categories (@pkowaluk)

#6844 refactor(theme-classic): split sidebar into smaller parts (@slorber)

#6846 refactor(theme-classic): consistently add span wrapper for layout links (@Josh-Cena)

docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-theme-classic, docusaurus-utils-validation, docusaurus-utils, docusaurus

#6980 feat(utils): JSDoc for all APIs (@Josh-Cena)

docusaurus-theme-common

#6974 feat(theme-common): JSDoc for all APIs (@Josh-Cena)

docusaurus

#6784 feat(core): allow configureWebpack to return undefined (@yorkie)

#6941 refactor(core): improve error message when a page has no default-export (@Josh-Cena)

#6878 fix(core): ensure stable webpack theme aliases sorting (@jrvidal)

#6854 fix(core): fix swizzle legend typo (@DigiPie)

#6850 fix(core): make plugin lifecycles consistently bound to the plugin instance (@Josh-Cena)

docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-utils

#6937 fix(content-docs): warn when files are not tracked (@felipecrs)

docusaurus-module-type-aliases, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-theme-search-algolia, docusaurus

#6925 refactor(theme-{classic,common}): refactor site/page/search metadata + apply className on html element (@slorber)

docusaurus-theme-classic, docusaurus-theme-common

#6895 refactor(theme-{classic,common}): split navbar into smaller components + cleanup + swizzle config (@slorber)

#6930 refactor(theme-{classic,common}): refactor ColorModeToggle + useColorMode() hook (@lex111)

#6894 refactor(theme-classic): split theme footer into smaller components + swizzle config (@slorber)

docusaurus-types, docusaurus

#6929 refactor(core): minor routes type improvement (@Josh-Cena)

docusaurus-plugin-client-redirects, docusaurus-plugin-ideal-image, docusaurus-plugin-pwa, docusaurus-plugin-sitemap

#6928 chore(pwa, sitemap, client-redirects, ideal-image): JSDoc for types (@Josh-Cena)

docusaurus-plugin-content-blog, docusaurus-theme-classic, docusaurus-utils

#6922 refactor(content-blog): clean up type definitions; in-code documentation (@Josh-Cena)

docusaurus-theme-translations

#6781 feat(theme-translations): complete Russian translations (@dragomano)

#6877 chore(theme-translations): complete Vietnamese translations (@datlechin)

docusaurus-plugin-content-blog

#6909 refactor(content-blog): improve error message of authors map validation (@Josh-Cena)

create-docusaurus

#6860 fix(create): load entry file after node version checking (@taejs)

:memo: Documentation

Other

#6988 docs: fix example admonition syntax (@kaycebasques)

#6978 docs: npm run tsc -> npx tsc (@jadonn)

#6952 docs: add K3ai to showcase (@alefesta)

#6948 docs: add pdfme docs to showcase (@hand-dot)

#6943 docs: add SeaORM docs to showcase (@billy1624)

#6926 docs: clarify the usage of slug (@kaycebasques)

#6911 docs: add Reactive Button site to showcase (@arifszn)

#6904 docs: update image for digital support services (@PatelN123)

#6892 docs: add EduLinks site to showcase (@odarpi)

#6889 docs: editorial fixes (@Josh-Cena)

#6883 docs(cli): add info about development on github codespaces (@vedantmgoyal2009)

#6856 docs: add Reddit Image Fetcher site to showcase (@arifszn)

#6875 docs: update TRPG Engine showcase (@moonrailgun)

#6871 docs: mark clutch and gulp as open-source (@Josh-Cena)

#6862 docs: update showcase data (@Josh-Cena)

#6837 docs: add PcapPlusPlus to showcase (@seladb)

#6832 docs: add Spicetify site to showcase (@afonsojramos)

#6830 docs: simplify imported code blocks syntax (@nathan-contino-mongo)

docusaurus-types

#6881 docs: mention configureWebpack devServer return value (@Josh-Cena)

create-docusaurus

#6833 docs: make tutorial code block directly copyable (@samgutentag)

:house: Internal

create-docusaurus, docusaurus-mdx-loader, docusaurus-migrate, docusaurus-module-type-aliases, docusaurus-plugin-client-redirects, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-plugin-debug, docusaurus-plugin-google-gtag, docusaurus-plugin-ideal-image, docusaurus-remark-plugin-npm2yarn, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-theme-search-algolia, docusaurus-theme-translations, docusaurus-types, docusaurus-utils-validation, docusaurus-utils, docusaurus, lqip-loader

#6995 refactor: ensure all types are using index signature instead of Record (@Josh-Cena)

create-docusaurus, docusaurus-cssnano-preset, docusaurus-plugin-pwa, docusaurus-theme-search-algolia, docusaurus-utils, docusaurus, lqip-loader

#6991 chore: upgrade dependencies (@Josh-Cena)

lqip-loader

#6992 refactor(lqip-loader): remove unused palette option (@Josh-Cena)

docusaurus

#6975 chore: update static-site-generator-webpack-plugin (@slorber)

stylelint-copyright

#6967 chore: publish stylelint-copyright again (@slorber)

docusaurus-plugin-client-redirects, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-plugin-google-analytics, docusaurus-plugin-google-gtag, docusaurus-plugin-ideal-image, docusaurus-plugin-pwa, docusaurus-plugin-sitemap, docusaurus-theme-classic, docusaurus-theme-live-codeblock, docusaurus-theme-search-algolia, docusaurus-types, docusaurus-utils-validation, docusaurus

#6961 refactor: unify how validateOptions is handled (@Josh-Cena)

docusaurus-types

#6957 chore(types): remove querystring from dependencies (@Josh-Cena)

docusaurus-theme-common, docusaurus

#6956 test: improve test coverage; reorder theme-common files (@Josh-Cena)

#6955 refactor(core): move browserContext and docusaurusContext out of client exports (@Josh-Cena)

#6944 chore: migrate Jest and website to SWC (@Josh-Cena)

docusaurus-utils

#6951 test: fix Windows test for gitUtils (@Josh-Cena)

docusaurus-mdx-loader, docusaurus-migrate, docusaurus-plugin-client-redirects, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-plugin-debug, docusaurus-plugin-pwa, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-theme-translations, docusaurus-utils, docusaurus, stylelint-copyright

#6931 chore: tighten ESLint config (@Josh-Cena)

docusaurus-module-type-aliases, docusaurus-plugin-client-redirects

#6924 refactor(client-redirects): migrate validation to validateOptions lifecycle (@Josh-Cena)

create-docusaurus, docusaurus-cssnano-preset, docusaurus-mdx-loader, docusaurus-migrate, docusaurus-plugin-ideal-image, docusaurus-plugin-pwa, docusaurus-theme-classic, docusaurus-theme-search-algolia, docusaurus-utils, docusaurus, lqip-loader

#6916 chore: upgrade dependencies (@Josh-Cena)

create-docusaurus, docusaurus-plugin-content-docs, docusaurus-theme-translations, docusaurus-types, docusaurus-utils-validation, docusaurus-utils, docusaurus, stylelint-copyright

#6912 test: improve test coverage; multiple internal refactors (@Josh-Cena)

Other

#6910 refactor: convert Jest infrastructure to TS (@Josh-Cena)

#6838 fix(website): changelog plugin leads to CI bugs on release (@slorber)

docusaurus-logger, docusaurus-mdx-loader, docusaurus-migrate, docusaurus-plugin-client-redirects, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-utils, docusaurus

#6908 chore: do not print prototype in jest snapshot (@Josh-Cena)

docusaurus-migrate, docusaurus-plugin-content-docs, docusaurus-theme-common, docusaurus-utils-validation, docusaurus-utils, docusaurus

#6906 refactor: install eslint-plugin-regexp (@Josh-Cena)

docusaurus-mdx-loader, docusaurus-plugin-client-redirects, docusaurus-plugin-content-docs, docusaurus-theme-common, docusaurus-theme-search-algolia, docusaurus-utils, docusaurus

#6905 test: improve test coverage; properly test core client APIs (@Josh-Cena)

docusaurus-logger, docusaurus-mdx-loader, docusaurus-migrate, docusaurus-plugin-client-redirects, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-sitemap, docusaurus-remark-plugin-npm2yarn, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-theme-live-codeblock, docusaurus-theme-translations, docusaurus-utils, docusaurus

#6903 chore: spell-check test files (@Josh-Cena)

docusaurus-migrate, docusaurus-module-type-aliases, docusaurus-plugin-client-redirects, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-theme-common, docusaurus-types, docusaurus-utils-common, docusaurus-utils, docusaurus, lqip-loader

#6902 test(theme-common): improve test coverage (@Josh-Cena)

docusaurus-cssnano-preset, docusaurus-logger, docusaurus-mdx-loader, docusaurus-migrate, docusaurus-plugin-client-redirects, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-plugin-sitemap, docusaurus-remark-plugin-npm2yarn, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-theme-live-codeblock, docusaurus-theme-search-algolia, docusaurus-theme-translations, docusaurus-utils-common, docusaurus-utils-validation, docusaurus-utils, docusaurus, lqip-loader, stylelint-copyright

#6900 test: enable a few jest eslint rules (@Josh-Cena)

docusaurus-logger, docusaurus-mdx-loader, docusaurus-migrate, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-theme-translations, docusaurus-utils-validation, docusaurus-utils, docusaurus, lqip-loader

#6898 refactor: import jest as global; unify import style of some modules (@Josh-Cena)

docusaurus-theme-classic, docusaurus-theme-common

#6891 refactor(theme-classic): avoid using clsx class dict with CSS modules (@Josh-Cena)

docusaurus-migrate, docusaurus-plugin-client-redirects, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-theme-translations, docusaurus-utils, docusaurus

#6880 refactor: prefer fs.outputFile to ensureDir + writeFile (@Josh-Cena)

docusaurus-plugin-pwa, docusaurus-types, docusaurus

#6866 refactor: improve types (@Josh-Cena)

docusaurus-mdx-loader, docusaurus-plugin-client-redirects, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-plugin-pwa, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-types, docusaurus, lqip-loader

#6864 refactor: remove unnecessary default values normalized during validation (@Josh-Cena)

create-docusaurus, docusaurus-migrate, docusaurus

#6861 refactor: make JS executables included in the tsconfig for editor hints (@Josh-Cena)

docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-types, docusaurus

#6857 test: improve test coverage (@Josh-Cena)

docusaurus-logger, docusaurus-mdx-loader, docusaurus-migrate, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-remark-plugin-npm2yarn, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-theme-search-algolia, docusaurus-utils-common, docusaurus-utils, docusaurus, lqip-loader

#6852 refactor: enable a few TS flags (@Josh-Cena)

Committers: 28

Afonso Jorge Ramos (@afonsojramos)

Alessandro Festa (@alefesta)

Alexey Pyltsyn (@lex111)

Alois Klink (@aloisklink)

Ariful Alam (@arifszn)

Begula (@vedantmgoyal2009)

Billy Chan (@billy1624)

Bugo (@dragomano)

Evan (@DigiPie)

Felipe Santos (@felipecrs)

Jadon N (@jadonn)

Joshua Chen (@Josh-Cena)

Kayce Basques (@kaycebasques)

Kyohei Fukuda (@hand-dot)

Nayan Patel (@PatelN123)

Ngô Quốc Đạt (@datlechin)

Odarpi (@odarpi)

Pawel Kowaluk (@pkowaluk)

Roberto Vidal (@jrvidal)

Sam Gutentag (@samgutentag)

Sébastien Lorber (@slorber)

Tsz W. TAM (@rccttwd)

WonChul Heo (@heowc)

Yorkie Liu (@yorkie)

@seladb

moonrailgun (@moonrailgun)

nate contino (@nathan-contino-mongo)

tae (@taejs)

Source code(tar.gz)
Source code(zip)
v2.0.0-beta.17(Mar 3, 2022)
2.0.0-beta.17 (2022-03-03)

:rocket: New Feature

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

#6783 feat: allow blog authors email (@Josh-Cena)

:boom: Breaking Change

docusaurus-theme-classic, docusaurus-theme-common

#6771 refactor(theme-classic): replace color mode toggle with button; remove switchConfig (@Josh-Cena)

:bug: Bug Fix

docusaurus-theme-classic

#6827 fix(theme-classic): restore docusaurus search meta (@slorber)

#6767 fix(theme-classic): allow code tags containing inline elements to stay inline (@Josh-Cena)

docusaurus-theme-common

#6824 fix(theme-common): breadcrumbs home bug in docs-only (@slorber)

#6816 fix(theme-common): docs breadcrumbs not working with baseUrl (@slorber)

docusaurus-plugin-content-docs

#6700 fix(content-docs): always sort autogenerated sidebar items by file/folder name by default (@Josh-Cena)

docusaurus

#6812 fix(core): remove hash/query when filtering existing files for broken link check (@Josh-Cena)

docusaurus-mdx-loader

#6779 fix(mdx-loader): suppress image reading warning in Yarn PnP; log warning instead of error (@Josh-Cena)

create-docusaurus

#6762 fix(create): update broken SVG paths in templates (@anicholls)

:nail_care: Polish

docusaurus-theme-common

#6826 refactor(theme-common): unify missing context errors (@Josh-Cena)

docusaurus-theme-classic, docusaurus-theme-common

#6771 refactor(theme-classic): replace color mode toggle with button; remove switchConfig (@Josh-Cena)

docusaurus-theme-classic

#6769 refactor(theme-classic): use Material icon for language dropdown (@Josh-Cena)

docusaurus-mdx-loader

#6792 fix(mdx-loader): allow image paths to be URL encoded (@Josh-Cena)

:memo: Documentation

Other

#6825 docs: Adds Netlify one click deploy to README (@PatelN123)

#6818 docs: add deploy with vercel button to README (@PatelN123)

#6817 docs: fix broken links (@PatelN123)

#6811 docs: add homepage banner in support of Ukraine (@dmitryvinn)

#6813 docs: mark dyte as opensource in showcase (@vaibhavshn)

#6776 docs: make GitHub actions explanation aligned with the code (@arifszn)

#6772 docs: add basic documentation about client modules (@Josh-Cena)

create-docusaurus

#6815 fix: consistently use max-width: 996px in media queries (@dstotijn)

:house: Internal

docusaurus-plugin-content-docs

#6821 test(content-docs): refactor navigation test snapshot (@Josh-Cena)

Other

#6768 test: add TypeScript template to E2E test matrix (@Josh-Cena)

docusaurus-utils

#6773 refactor(utils): categorize functions into separate files (@Josh-Cena)

docusaurus-migrate

#6761 chore: various internal fixes (@Josh-Cena)

Committers: 8

Alex Nicholls (@anicholls)

Ariful Alam (@arifszn)

David Stotijn (@dstotijn)

Dmitry Vinnik (@dmitryvinn)

Joshua Chen (@Josh-Cena)

Nayan Patel (@PatelN123)

Sébastien Lorber (@slorber)

Vaibhav Shinde (@vaibhavshn)

Source code(tar.gz)
Source code(zip)
v2.0.0-beta.16(Feb 25, 2022)
2.0.0-beta.16 (2022-02-25)

:rocket: New Feature

docusaurus-logger, docusaurus-module-type-aliases, docusaurus-plugin-debug, docusaurus-plugin-pwa, docusaurus-theme-classic, docusaurus-theme-search-algolia, docusaurus-types, docusaurus

#6243 feat(core): brand new swizzle CLI experience (@Josh-Cena)

create-docusaurus

#6750 feat(create): new --package-manager option; interactive package manager selection (@Josh-Cena)

#6610 feat(create): allow specifying a git clone strategy (@Josh-Cena)

docusaurus-theme-classic, docusaurus-theme-common

#6723 feat: sync color mode between browser tabs (@lex111)

docusaurus-theme-search-algolia

#6692 feat(search-algolia): allow disabling search page and configuring path (@lex111)

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

#6517 feat(docs,theme-classic): docs breadcrumbs (@jodyheavener)

#6519 feat(content-docs): sidebar item type "html" for rendering pure markup (@jodyheavener)

docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-utils

#6593 feat(content-blog): infer blog post date from git history (@felipecrs)

docusaurus-plugin-content-docs

#6619 feat(content-docs): add custom props front matter (@TheCatLady)

#6452 feat(content-docs): allow explicitly disabling index page for generated category (@Josh-Cena)

docusaurus-plugin-content-blog

#6603 feat(content-blog): allow customizing blog archive component through option (@Josh-Cena)

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

#6221 feat(content-blog): Allow pagination for BlogTagsPostsPage (@redhoyasa)

:boom: Breaking Change

create-docusaurus, docusaurus-mdx-loader, docusaurus-migrate, docusaurus-plugin-client-redirects, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-plugin-debug, docusaurus-plugin-ideal-image, docusaurus-plugin-pwa, docusaurus-plugin-sitemap, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-theme-live-codeblock, docusaurus-theme-search-algolia, docusaurus-theme-translations, docusaurus-utils, docusaurus, stylelint-copyright

#6752 chore: upgrade docsearch-react to v3 stable, bump dependencies (@Josh-Cena)

docusaurus-mdx-loader, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-types

#6729 refactor: make MDX export a flat TOC list instead of tree (@Josh-Cena)

docusaurus-types, docusaurus-utils-validation, docusaurus

#6740 refactor: remove deprecated Webpack utils & validation escape hatch (@Josh-Cena)

docusaurus-theme-classic, docusaurus-theme-search-algolia

#6707 refactor(theme-classic): bias again search metadata toward Algolia DocSearch (@slorber)

docusaurus-module-type-aliases, docusaurus-theme-common, docusaurus

#6651 refactor: reduce exported members of docusaurus router (@Josh-Cena)

:bug: Bug Fix

docusaurus-theme-common

#6758 fix(theme-common): isSamePath should be case-insensitive (@slorber)

#6748 fix(theme-classic): temporarily disable toc heading autoscrolling (@slorber)

#6696 fix(theme-common): do not run useLocationChange when hot reloading (@lex111)

#6490 fix(theme-classic): do not switch color modes when printing (@Josh-Cena)

docusaurus-module-type-aliases, docusaurus-theme-classic, docusaurus-theme-common

#6749 fix(theme-classic): fix breadcrumb home link bug with new useHomePageRoute() hook (@slorber)

docusaurus-plugin-content-docs

#6720 fix(content-docs): create assets for frontmatter images (@lebalz)

#6592 fix(content-docs): read last update from inner git repositories (@felipecrs)

#6477 fix(content-docs): export versioning utils (@milesj)

docusaurus-mdx-loader

#6712 fix(mdx-loader): make headings containing links properly formatted in ToC (@Josh-Cena)

docusaurus

#6701 fix(cli): disable directory listing in serve (@Josh-Cena)

#6607 fix(cli): log error itself on unhandled rejection (@Josh-Cena)

#6500 fix(cli): allow passing a list of file names to write-heading-ids (@Josh-Cena)

#6496 fix(core): configValidation should allow inline theme functions (@slorber)

docusaurus-theme-classic

#6652 fix(theme-classic): minor BTT button fixes (@lex111)

#6612 fix(theme-classic): make Prism additional languages properly server-side rendered (@Josh-Cena)

#6599 fix(theme-classic): add docSidebar as allowed item in dropdown (@homotechsual)

#6531 fix(theme-classic): highlight active collapsible doc category properly (@lex111)

#6515 fix(theme-classic): add key prop for SimpleLinks map (@kgajera)

#6508 fix(theme-classic): apply width/height for footer logos without href (@kgajera)

docusaurus-utils

#6617 fix(utils): convert Markdown links in reference-style links with multiple spaces (@Josh-Cena)

#6489 fix(utils): do not resolve Markdown paths with @site prefix (@Josh-Cena)

#6478 fix(utils): Markdown linkification match local paths beginning with http (@Josh-Cena)

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

#6495 fix(content-docs): render category with no subitems as a normal link (@Josh-Cena)

:nail_care: Polish

docusaurus-mdx-loader, docusaurus-migrate, docusaurus-plugin-client-redirects, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-theme-common, docusaurus-theme-search-algolia, docusaurus-utils, docusaurus, lqip-loader

#6755 refactor: unify error handling behavior (@Josh-Cena)

create-docusaurus

#6679 feat(create): better detection of package manager preference (@lex111)

#6481 refactor(init): promote good practices; use site alias (@Josh-Cena)

docusaurus-plugin-content-docs

#6745 fix(content-docs): improve sidebar shorthand normalization error message (@Josh-Cena)

#6602 feat(content-docs): allow omitting enclosing array consistently for category shorthand (@Josh-Cena)

#6596 refactor(content-docs): clean up sidebars logic; validate generator returns (@Josh-Cena)

#6586 refactor(content-docs): read category metadata files before autogenerating (@Josh-Cena)

docusaurus-module-type-aliases, docusaurus-plugin-ideal-image, docusaurus-plugin-pwa, docusaurus-theme-classic, docusaurus

#6730 refactor: declare all props as interfaces (@Josh-Cena)

docusaurus-theme-translations

#6711 chore(theme-translations): complete Korean translations (@revi)

#6686 fix(theme-translations): improve Korean translations (@winterlood)

#6635 refactor(theme-translation): improve Traditional Chinese translation quality (@toto6038)

docusaurus-theme-classic, docusaurus-theme-translations

#6674 fix(theme-classic): improve aria label of color mode toggle (@Josh-Cena)

create-docusaurus, docusaurus-theme-classic

#6668 refactor: recommend using data-theme without html element selector (@Josh-Cena)

docusaurus-theme-classic

#6622 refactor(theme-classic): clean up CSS of doc sidebar item (@lex111)

docusaurus

#6644 fix(core): forward ref to Link's anchor element (@koistya)

#6646 fix(cli): make docusaurus clear also remove .yarn/.cache folder (@Josh-Cena)

#6306 feat(core): use react-helmet-async (@seyoon20087)

docusaurus-utils-validation

#6656 feat: allow numbers in plugin ID (@cdemonchy-pro)

docusaurus-mdx-loader, docusaurus-utils, lqip-loader

#6650 refactor(utils): replace hash with contenthash for file loader (@Josh-Cena)

create-docusaurus, docusaurus-mdx-loader, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-plugin-debug, docusaurus-plugin-google-analytics, docusaurus-plugin-google-gtag, docusaurus-plugin-ideal-image, docusaurus-plugin-pwa, docusaurus-plugin-sitemap, docusaurus-preset-classic, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-theme-search-algolia, docusaurus-utils-validation, docusaurus-utils

#6615 fix: remove more peer dependency warnings (@Josh-Cena)

docusaurus-mdx-loader

#6598 feat: make Markdown images lazy loaded (@johnnyreilly)

docusaurus-theme-classic, docusaurus-theme-common

#6505 fix(theme-classic): make focused link outlined with JS disabled (@Josh-Cena)

docusaurus-plugin-content-docs, docusaurus-theme-common, docusaurus-theme-search-algolia, docusaurus-types, docusaurus-utils, docusaurus

#6507 refactor: improve internal typing (@Josh-Cena)

docusaurus-mdx-loader, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-plugin-debug, docusaurus-plugin-google-analytics, docusaurus-plugin-google-gtag, docusaurus-plugin-sitemap, docusaurus-preset-classic, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-theme-search-algolia, docusaurus-utils-validation, docusaurus-utils

#6498 fix: updating peerDependency fields for yarn berry (@vidarc)

docusaurus-theme-classic, docusaurus-theme-search-algolia, docusaurus-theme-translations

#6482 feat: mark some text labels as translatable (@Josh-Cena)

:memo: Documentation

Other

#6727 docs: add Blog Matheus Brunelli site to showcase (@mrbrunelli)

#6721 docs: add Butterfly Documentation to showcase (@CodeDoctorDE)

#6710 docs(website): Add techharvesting to showcase (@NaseelNiyas)

#6708 docs: add doc for generated-index keyword/image metadata (@slorber)

#6709 docs(website): fix video responsiveness (@lex111)

#6687 docs: add deep dive video for Docusaurus (@dmitryvinn)

#6704 docs(website): search doc typo searchParameters (@slorber)

#6682 docs: add redux-cool site to showcase (@Ruben-Arushanyan)

#6677 docs: add Rivalis to showcase (@kalevski)

#6676 docs: add SmartCookieWeb site to showcase (@CookieJarApps)

#6675 docs: mention that all official themes are TypeScript-covered (@Josh-Cena)

#6673 docs: mention about blog date in front matter (@Josh-Cena)

#6672 refactor(website): extract homepage data from UI; feature text updates (@Josh-Cena)

#6670 docs: add CyberDrain Improved Partner Portal (CIPP) to showcase (@homotechsual)

#6667 fix(website): make YT iframe responsive (@lex111)

#6659 docs: add eli5 video to home page (@dmitryvinn-fb)

#6633 docs: improve wording of using Markdown file paths (@BigDataWriter)

#6624 docs: add Resoto & Some Engineering Inc. to showcase (@TheCatLady)

#6611 docs: fix bad anchor link syntax (@Josh-Cena)

#6591 docs: improve Github Actions example jobs (@ebarojas)

#6426 feat(website): add Tweets section (@yangshun)

#6532 docs: add SAP Cloud SDK to showcase (@artemkovalyov)

#6513 docs: clean up CONTRIBUTING (@Josh-Cena)

#6501 docs: add Cloudflare pages deployment guide (@apidev234)

#6499 docs: mention how env vars can be read (@Josh-Cena)

#6492 docs: mention where to find the sitemap (@tamalweb)

#6491 docs: add developers.verida to showcase (@nick-verida)

#6414 feat(website): new plugin to load CHANGELOG and render as blog (@Josh-Cena)

#6404 docs: elaborate on Markdown asset linking; document pathname:// protocol (@Josh-Cena)

#6484 docs: remove mention that CDN resources are cached cross-domain (@Josh-Cena)

#6429 refactor: self-host KaTeX assets (@pranabdas)

#6483 docs: mark a lot of website texts as translatable (@Josh-Cena)

docusaurus-preset-classic

#6627 docs: fix presets documentation link (@thedanielhanke)

:house: Internal

docusaurus-theme-classic

#6759 refactor(theme-classic): merge CSS files for Heading (@slorber)

#6584 misc: enable jsx-key eslint rule (@Josh-Cena)

docusaurus-migrate

#6756 test: sort migration test FS mock calls (@Josh-Cena)

#6609 refactor(migrate): change internal methods' parameter style (@Josh-Cena)

#6476 chore: fix Stylelint globs for editor support (@nschonni)

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

#6744 fix(content-docs): properly display collocated social card image (@Josh-Cena)

docusaurus-module-type-aliases, docusaurus-types, docusaurus

#6742 refactor: improve client modules types (@Josh-Cena)

docusaurus-module-type-aliases

#6741 chore(module-type-aliases): add react as peer dependency (@Josh-Cena)

#6658 refactor(module-aliases): remove react-helmet dependency (@Josh-Cena)

Other

#6726 misc: improve bug report template (@Josh-Cena)

#6512 misc: configure linguist behavior to show better language stats (@Josh-Cena)

#6487 chore: fix codesandbox example link + mention npm publish recovery (@slorber)

#6486 chore: update examples for beta.15 (@slorber)

#6485 fix(website): bad translate tags without default translation (@slorber)

docusaurus-plugin-client-redirects, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-theme-search-algolia, docusaurus-theme-translations, docusaurus-utils, docusaurus, lqip-loader

#6716 refactor: ensure lodash is default-imported (@Josh-Cena)

create-docusaurus, docusaurus-logger, docusaurus-migrate, docusaurus

#6661 refactor: convert CLI entry points to ESM; migrate create-docusaurus to ESM (@Josh-Cena)

docusaurus-module-type-aliases, docusaurus-theme-common, docusaurus

#6651 refactor: reduce exported members of docusaurus router (@Josh-Cena)

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

#6629 refactor: move module declarations for non-route components to theme-classic (@Josh-Cena)

docusaurus-plugin-pwa, docusaurus-theme-classic

#6614 refactor: remove Babel plugins that are included in preset-env (@Josh-Cena)

docusaurus-module-type-aliases, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-theme-live-codeblock, docusaurus-theme-translations, docusaurus-utils-validation, docusaurus-utils, docusaurus

#6605 chore: fix ESLint warnings, restrict export all syntax (@Josh-Cena)

docusaurus-theme-live-codeblock, docusaurus-theme-search-algolia

#6583 refactor(live-codeblock): migrate theme to TS (@Josh-Cena)

docusaurus-migrate, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-plugin-ideal-image, docusaurus-plugin-pwa, docusaurus-theme-common, docusaurus-utils, docusaurus, lqip-loader

#6524 refactor: enforce named capture groups; clean up regexes (@Josh-Cena)

docusaurus-migrate, docusaurus-plugin-content-docs, docusaurus

#6521 refactor: mark all functions that import external modules as async (@Josh-Cena)

create-docusaurus, docusaurus-cssnano-preset, docusaurus-logger, docusaurus-mdx-loader, docusaurus-migrate, docusaurus-module-type-aliases, docusaurus-plugin-client-redirects, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-plugin-debug, docusaurus-plugin-google-analytics, docusaurus-plugin-google-gtag, docusaurus-plugin-ideal-image, docusaurus-plugin-pwa, docusaurus-remark-plugin-npm2yarn, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-theme-search-algolia, docusaurus-theme-translations, docusaurus-types, docusaurus-utils-common, docusaurus-utils-validation, docusaurus-utils, docusaurus, stylelint-copyright

#6514 chore: clean up ESLint config, enable a few rules (@Josh-Cena)

docusaurus-types, docusaurus

#6511 refactor(core): convert theme-fallback to TS (@Josh-Cena)

create-docusaurus, docusaurus-utils

#6506 test: add test for readOutputHTMLFile (@Josh-Cena)

docusaurus-migrate, docusaurus-theme-common

#6502 refactor: fix all eslint warnings (@Josh-Cena)

docusaurus-mdx-loader, docusaurus-remark-plugin-npm2yarn, docusaurus

#6474 test: rename 'fixtures' to 'fixtures' (@nschonni)

:running_woman: Performance

create-docusaurus, docusaurus-mdx-loader, docusaurus-migrate, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-theme-search-algolia, docusaurus-theme-translations, docusaurus-utils, docusaurus

#6725 refactor: convert all fs methods to async (@Josh-Cena)

Committers: 38

Alexey Pyltsyn (@lex111)

Artem Kovalov (@artemkovalyov)

Balthasar Hofer (@lebalz)

Clement Demonchy (@cdemonchy-pro)

CodeDoctor (@CodeDoctorDE)

Daniel Hanke (@thedanielhanke)

Daniel Kalevski (@kalevski)

Dmitry Vinnik (@dmitryvinn)

Dmitry Vinnik | Meta (@dmitryvinn-fb)

Erick Zhao (@erickzhao)

Everardo J. Barojas M. (@ebarojas)

Felipe Santos (@felipecrs)

Gaurish (@apidev234)

Hong Yongmin (@revi)

Jody Heavener (@jodyheavener)

John Reilly (@johnnyreilly)

Joshua Chen (@Josh-Cena)

Kishan Gajera (@kgajera)

Konstantin Tarkus (@koistya)

Matheus Ricardo Brunelli (@mrbrunelli)

Matthew Ailes (@vidarc)

Mikey O'Toole (@homotechsual)

Miles Johnson (@milesj)

Muhammad Redho Ayassa (@redhoyasa)

Naseel Niyas (@NaseelNiyas)

Nick Schonning (@nschonni)

Pranab Das (@pranabdas)

Ruben Arushanyan (@Ruben-Arushanyan)

Sébastien Lorber (@slorber)

Tamal Web (@tamalweb)

Yangshun Tay (@yangshun)

@BigDataWriter

@CookieJarApps

@TheCatLady

@nick-verida

@seyoon20087

@toto6038

이정환 (@winterlood)

Source code(tar.gz)
Source code(zip)
v2.0.0-beta.15(Jan 26, 2022)
2.0.0-beta.15 (2022-01-26)

Highlights on Twitter

:rocket: New Feature

docusaurus-plugin-content-docs

#6451 feat(content-docs): expose isCategoryIndex matcher to customize conventions (@Josh-Cena)

#5782 feat(content-docs): displayed_sidebar front matter (@Josh-Cena)

docusaurus-theme-classic, docusaurus-theme-common

#6466 feat(theme-classic): add stable class for DocSidebarContainer (@homotechsual)

#3811 feat(theme-classic): auto-collapse sibling categories in doc sidebar (@josephriosIO)

#6216 feat(theme-classic): usable CodeBlock outside markdown (@Josh-Cena)

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

#6416 feat(content-blog): allow authors list to contain images only (@Josh-Cena)

docusaurus-plugin-content-blog

#6415 feat(content-blog): allow disabling generating archive (@Josh-Cena)

#6245 feat(content-blog): parse date from middle of file path (@Josh-Cena)

#6388 feat(content-blog): include tags in feed (@Josh-Cena)

docusaurus-module-type-aliases, docusaurus-theme-classic, docusaurus-types, docusaurus

#6371 feat(core, theme-classic): allow overriding htmlLang (@noomorph)

docusaurus-mdx-loader

#6323 feat(mdx-loader): preserve hash in image src; support GH themed images (@Josh-Cena)

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

#6139 feat(theme-classic): new navbar item linking to a sidebar (@lmpham1)

#6239 feat(content-docs): allow SEO metadata for category index pages (@Josh-Cena)

docusaurus-plugin-sitemap

#6248 feat(sitemap): remove trailingSlash option; respect noIndex config (@Josh-Cena)

docusaurus-plugin-ideal-image, docusaurus-theme-translations

#6173 feat(ideal-image): allow translating status messages (@Josh-Cena)

docusaurus-plugin-ideal-image

#6155 feat(ideal-image): new option disableInDev (@Josh-Cena)

docusaurus-theme-translations

#6169 feat(theme-translations): add Italian translations (@mcallisto)

docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-types, docusaurus

#6166 feat: async plugin creator functions (@slorber)

docusaurus

#6165 feat(core): async docusaurus.config.js creator function (@slorber)

:boom: Breaking Change

docusaurus-theme-search-algolia

#6407 feat(search): enable contextual search by default (@slorber)

docusaurus-theme-classic, docusaurus-theme-common, docusaurus-theme-live-codeblock, docusaurus-theme-search-algolia

#6289 refactor: move @theme/hooks to @docusaurus/theme-common (@slorber)

docusaurus-theme-classic

#6283 refactor(theme-classic): apply import/no-named-export eslint rule (@slorber)

docusaurus-plugin-sitemap

#6248 feat(sitemap): remove trailingSlash option; respect noIndex config (@Josh-Cena)

:bug: Bug Fix

docusaurus-plugin-content-blog, docusaurus-theme-classic, docusaurus-types, docusaurus-utils-common, docusaurus-utils, docusaurus

#6454 fix(content-blog): generate feed by reading build output (@Josh-Cena)

create-docusaurus

#6468 fix(init): cd to correct path when installing (@gabrielcsapo)

docusaurus-mdx-loader

#4827 fix: allow links to JSON in .md files to be transformed as asset links (@antmcc49)

docusaurus-plugin-content-docs

#6435 fix(content-docs): make getActivePlugin match plugin paths more exactly (@Josh-Cena)

#6310 fix: highlight appropriate navItem when browsing generated category index (@tapanchudasama)

#6202 fix(content-docs): quotify path when retrieving git history (@Josh-Cena)

docusaurus

#6424 fix(core): fix css url("image.png"), use css-loader v6 with esModules: false (@slorber)

#6378 fix(core): do not coerce webpack warning to string (@Josh-Cena)

#6197 fix(cli): quotify temp path in deploy command (@Josh-Cena)

#6168 fix(core): update webpack-dev-server + fix deprecation warning (@slorber)

docusaurus-logger, docusaurus-utils

#6384 fix(logger): properly stringify objects for logging (@Josh-Cena)

docusaurus-module-type-aliases, docusaurus-theme-classic, docusaurus

#6338 fix(core): error boundary should allow no children (@slorber)

docusaurus-theme-classic

#6314 fix(theme-classic): fix mobile version dropdown label with only one version (@Josh-Cena)

#6288 fix(theme-classic): add missing role=region to SkipToContent (@JoshuaKGoldberg)

#6213 refactor(theme-classic): extract common PaginatorNavLink component (@Josh-Cena)

#6177 fix(theme-classic): make React elements in pre render correctly (@Josh-Cena)

docusaurus-plugin-client-redirects, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-preset-classic, docusaurus-theme-classic, docusaurus-theme-search-algolia

#6300 refactor: move exported type definitions to declaration file (@Josh-Cena)

docusaurus-migrate

#6276 fix(migrate): migration CLI should correctly migrate gtag options (@Josh-Cena)

docusaurus-plugin-content-blog

#6244 fix(content-blog): always convert front matter date as UTC (@Josh-Cena)

docusaurus-mdx-loader, docusaurus-utils, docusaurus

#6190 fix(utils): properly escape Windows paths (@Josh-Cena)

:nail_care: Polish

docusaurus-module-type-aliases

#6469 fix(module-type-aliases): fix type def for translate params (@Josh-Cena)

docusaurus-theme-search-algolia

#6407 feat(search): enable contextual search by default (@slorber)

docusaurus-mdx-loader

#6443 refactor(mdx-loader): use vfile.path to access Markdown file path (@Josh-Cena)

docusaurus-theme-classic

#6427 feat(theme-classic): add aria-current to sidebar category link (@Josh-Cena)

#6391 refactor(theme-classic): add comments to Prism setup; minor refactor (@Josh-Cena)

#6240 refactor(theme-classic): use front matter from metadata for BlogPostPage (@Josh-Cena)

docusaurus

#6419 feat(core): warn users about hand-modifying generated files (@Josh-Cena)

#6405 feat(core): check imported API name when extracting translations (@Josh-Cena)

#6291 feat(core): improve error message for BrowserOnly; better docs (@Josh-Cena)

create-docusaurus

#5822 feat: update website & init template palette to pass WCAG test; include contrast check in ColorGenerator (@Josh-Cena)

#6368 fix(create-docusaurus): add useBaseUrl for image URLs (@alias-mac)

docusaurus-plugin-content-pages, docusaurus-theme-classic

#6400 feat(content-pages): front matter validation, include front matter in metadata (@Josh-Cena)

docusaurus-mdx-loader, docusaurus-theme-classic

#6339 feat(mdx-loader): read image dimensions when processing Markdown (@Josh-Cena)

docusaurus-plugin-content-blog

#6388 feat(content-blog): include tags in feed (@Josh-Cena)

#6189 feat(content-blog): include front matter in loaded content metadata (@Josh-Cena)

docusaurus-theme-common

#6317 feat(theme-classic): autoscroll TOC with active link (@cerkiewny)

docusaurus-mdx-loader, docusaurus-plugin-client-redirects, docusaurus-plugin-content-blog, docusaurus-theme-search-algolia, docusaurus-utils-validation, docusaurus-utils, docusaurus

#6303 test(utils, mdx-loader, core): improve coverage (@Josh-Cena)

docusaurus-plugin-google-analytics, docusaurus-plugin-google-gtag, docusaurus-preset-classic

#6284 fix(preset-classic): throw if preset finds GA options in theme config (@Josh-Cena)

create-docusaurus, docusaurus

#6186 refactor: print trailing new line when outputting JSON (@Josh-Cena)

:memo: Documentation

Other

#6296 docs: add advanced guides (@Josh-Cena)

#6459 docs: add replicad to showcase (@sgenoud)

#6334 docs: 2021 recap blog post (@Josh-Cena)

#6458 docs: add Kuizuo's Personal Website to showcase (@kuizuo)

#6431 docs: add Koyeb as a deployment option (@edouardb)

#6455 docs: add Sass Fairy to showcase (@roydukkey)

#6453 docs: document embedding generated index in doc page (@Josh-Cena)

#6450 docs: split sidebar documentation into sections (@Josh-Cena)

#6449 docs: multiple doc improvements (@Josh-Cena)

#6448 fix(website): update colors correctly when palette is only customized in one color mode (@Josh-Cena)

#6385 chore: add height/width for front page images (@nschonni)

#6445 docs: update showcase data of InfraQL (@jeffreyaven)

#6433 docs: add kube-green to showcase (@davidebianchi)

#6428 docs: elaborate on i18n tutorial (@Josh-Cena)

#6422 docs: add 404Lab wiki to showcase (@HiChen404)

#6420 fix(website): restore some site CSS in light mode (@Josh-Cena)

#6410 docs: add SODA for SPARC to showcase (@megasanjay)

#6417 docs: fix accessibility of search modal (@Josh-Cena)

#6406 docs(i18n): add docs for htmlLang config (@noomorph)

#6393 docs: update Algolia docs for new DocSearch infra (@Josh-Cena)

#6383 docs: elaborate on different CSS class names (@Josh-Cena)

#6348 docs: add KaustubhK24's site to showcase (@kaustubhk24)

#6333 feat(website): search in showcase (@Josh-Cena)

#6344 fix(website): make ColorGenerator functional (@shwaka)

#6340 docs: minor fix in the sample config for ESM (@pranabdas)

#6336 docs: make upgrade guide always show the latest version (@Josh-Cena)

#6320 chore: upgrade rehype-katex with ESM support, update docs (@pranabdas)

#6335 docs: add Pglet website to showcase (@FeodorFitsner)

#6327 docs: remove typo bracket (@MorookaKotaro)

#6316 docs: add bandwidth.com to showcase (@ajrice6713)

#6313 docs: add Refine site to showcase (@omeraplak)

#6318 fix(website): various anchor link fixes (@Josh-Cena)

#6308 fix(website): wrap details in mdx-code-block (@Josh-Cena)

#6307 docs: document MD and JSX interoperability issues (@Josh-Cena)

#6299 docs: add icodex to showcase (@wood3n)

#6297 docs: mention setup in monorepo (@PatelN123)

#6293 docs: remove GraphQL mesh from showcase (@Josh-Cena)

#6231 docs: update showcase images; remove GraphQL Code Generator site (@PatelN123)

#6285 refactor(website): further optimize showcase images (@Josh-Cena)

#6281 docs: Add kwatch to showcase (@abahmed)

#6280 docs: elaborate on doc versioning (@Josh-Cena)

#6043 fix(website): resize showcase images, tighten CI check (@armano2)

#6274 docs: add dyte docs to showcase (@vaibhavshn)

#6278 docs: add Khyron Realm to showcase (@alexgrigoras)

#6271 docs: add FlatifyCSS to showcase (@amir2mi)

#6275 fix(website): fix config-tabs breaking after translation (@Josh-Cena)

#6269 docs: add Ionic to showcase (@ltm)

#6272 docs: make tsconfig work OOTB in typescript guide (@Josh-Cena)

#6265 docs: add Eric JiuRan's blog to showcase (@1084350607)

#6242 docs(showcase): update oxidizer website url (@vandreleal)

#6226 docs: update showcase data for digital support notes (@PatelN123)

#6224 docs: add TalentBrick to showcase (@Josh-Cena)

#6223 docs: normalize CodeBlock highlighting (@Josh-Cena)

#6214 feat(website): improve prism themes (@Josh-Cena)

#6215 docs: use BrowserWindow for Markdown demos (@Josh-Cena)

#6193 docs: normalize plugin API documentation (@Josh-Cena)

#6209 docs: elaborate on static asset resolution (@Josh-Cena)

#6207 docs: add default value for BrowserWindow URL field (@Josh-Cena)

#6206 docs: fix highlighting of YAML front matter (@Josh-Cena)

#6191 docs: fix react live scope button color in dark mode (@Josh-Cena)

#6188 docs: add Layer0 to deployment guide (@rishi-raj-jain)

#6184 docs: remove mention of 'UA-' in gtag (@johnnyreilly)

#6181 docs: add GTFS-to-HTML to showcase (@brendannee)

#6178 docs: add Digital Support Notes to showcase (@PatelN123)

#6170 docs: add LabVIEW coding experience to showcase (@ruanqizhen)

#6164 docs: fix import module name of theme/Admonition (@Josh-Cena)

#6158 docs: add Astronomer to showcase (@jwitz)

create-docusaurus

#5822 feat: update website & init template palette to pass WCAG test; include contrast check in ColorGenerator (@Josh-Cena)

#6187 docs: make installation guide more beginner-friendly (@PatelN123)

docusaurus-utils

#6204 docs: recommend highlighting with comments than number range (@Josh-Cena)

create-docusaurus, docusaurus-theme-classic

#6203 docs: audit grammar issues (@Josh-Cena)

:house: Internal

docusaurus-mdx-loader, docusaurus-migrate, docusaurus-plugin-client-redirects, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-theme-search-algolia, docusaurus-utils-validation, docusaurus-utils, docusaurus

#6456 chore: add cSpell for spell checking (@nschonni)

Other

#6444 misc: update nvmrc to 14.17.0 to meet dependency requirements (@jodyheavener)

#6441 misc: fix stylelint erroring when lint-staged passed ignored file (@Josh-Cena)

#6421 chore: fix yarn build:website:fast (@slorber)

#6381 chore(website): set cache-control for static assets (@nschonni)

#6364 chore: remove Intl polyfills for Jest (@Josh-Cena)

#6325 chore: add Dependabot for dependency updates (@nschonni)

#6328 chore(ci): upgrade actions/github-script to v5 (@nschonni)

#6332 chore(deps): bump follow-redirects from 1.14.5 to 1.14.7 (@dependabot[bot])

#6326 misc(ci): remove redundant "CI: true" env (@nschonni)

#6304 chore: upgrade to Husky 7 (@nschonni)

#6222 test: ensure consistent CSS ordering (@slorber)

#6159 docs: remove useless comment (@slorber)

#6148 chore(examples): update examples to 2.0.0-beta.14 (@slorber)

docusaurus-plugin-debug, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-theme-live-codeblock, docusaurus-theme-search-algolia, docusaurus

#6442 chore: enable stylelint standard config (@Josh-Cena)

docusaurus-mdx-loader, docusaurus-plugin-client-redirects, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-ideal-image, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-theme-live-codeblock, docusaurus

#6440 chore: remove some unused dependencies from package.json (@Josh-Cena)

docusaurus-theme-classic

#6436 refactor(theme-classic): render BlogPostItem as one JSX element (@Josh-Cena)

#6283 refactor(theme-classic): apply import/no-named-export eslint rule (@slorber)

docusaurus-plugin-content-pages

#6413 fix(content-pages): declare hide_table_of_contents as boolean (@Josh-Cena)

docusaurus-migrate, docusaurus-module-type-aliases, docusaurus-theme-classic, docusaurus

#6399 refactor: clean up TODO comments (@Josh-Cena)

docusaurus-cssnano-preset, docusaurus-plugin-client-redirects, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-theme-common, docusaurus-theme-translations, docusaurus

#6387 test: improve test coverage (@Josh-Cena)

docusaurus-utils

#6380 chore: enable a few fixable ESLint rules (@nschonni)

docusaurus-mdx-loader, docusaurus-plugin-content-docs, docusaurus-utils, docusaurus

#6377 refactor: use findAsyncSequential in a few places (@Josh-Cena)

docusaurus-mdx-loader, docusaurus-migrate, docusaurus-plugin-client-redirects, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-theme-classic, docusaurus-theme-search-algolia, docusaurus-utils-common, docusaurus-utils, docusaurus, stylelint-copyright

#6375 chore: enable eslint-plugin-jest (@Josh-Cena)

create-docusaurus

#6373 chore: enable react/jsx-closing-bracket-location (@nschonni)

docusaurus-theme-classic, stylelint-copyright

#6374 feat(stylelint-copyright): autofix, stricter config (@Josh-Cena)

docusaurus-cssnano-preset, docusaurus-theme-classic

#6372 chore: add baseline stylelint rules (@nschonni)

create-docusaurus, docusaurus-plugin-debug, docusaurus-theme-classic

#6369 chore: upgrade lint-staged and globs (@nschonni)

docusaurus-theme-search-algolia, docusaurus-utils-validation, docusaurus

#6341 chore: regenerate yarn.lock (@slorber)

docusaurus-mdx-loader, docusaurus-plugin-client-redirects, docusaurus-plugin-content-blog, docusaurus-plugin-content-pages, docusaurus-remark-plugin-npm2yarn, docusaurus-theme-classic, docusaurus-theme-common, docusaurus

#6324 chore: minor typo cleanup (@nschonni)

create-docusaurus, docusaurus-logger, docusaurus-mdx-loader, docusaurus-migrate, docusaurus-plugin-client-redirects, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-plugin-debug, docusaurus-plugin-google-analytics, docusaurus-plugin-google-gtag, docusaurus-plugin-ideal-image, docusaurus-plugin-pwa, docusaurus-plugin-sitemap, docusaurus-preset-classic, docusaurus-remark-plugin-npm2yarn, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-theme-live-codeblock, docusaurus-theme-search-algolia, docusaurus-theme-translations, docusaurus-utils-common, docusaurus-utils-validation, docusaurus-utils, docusaurus, lqip-loader, stylelint-copyright

#6286 misc: convert all internal scripts to ESM (@Josh-Cena)

docusaurus-theme-classic, docusaurus-theme-common, docusaurus-theme-live-codeblock, docusaurus-theme-search-algolia

#6289 refactor: move @theme/hooks to @docusaurus/theme-common (@slorber)

docusaurus-plugin-content-docs, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-theme-search-algolia

#6287 refactor: new @docusaurus/plugin-content-docs/client interface (@slorber)

docusaurus

#6279 refactor(core): use native types from webpack-dev-server (@RDIL)

docusaurus-plugin-content-docs

#6277 refactor(content-docs): make readVersionsMetadata async (@Josh-Cena)

docusaurus-types, docusaurus

#6237 refactor(core): convert serverEntry.js to TS (@Josh-Cena)

create-docusaurus, docusaurus-logger, docusaurus-mdx-loader, docusaurus-migrate, docusaurus-module-type-aliases, docusaurus-plugin-client-redirects, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-plugin-debug, docusaurus-plugin-pwa, docusaurus-plugin-sitemap, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-theme-live-codeblock, docusaurus-utils-common, docusaurus-utils-validation, docusaurus-utils, docusaurus, lqip-loader

#6230 refactor: enforce type import specifiers (@Josh-Cena)

create-docusaurus, docusaurus-plugin-content-blog, docusaurus-utils, docusaurus

#6229 refactor(utils): reorganize functions; move authors file resolution to utils (@Josh-Cena)

docusaurus-theme-translations

#6225 refactor(theme-translations): improve typing for update script (@Josh-Cena)

#6174 misc(theme-translations): multiple improvements to the update CLI (@Josh-Cena)

Committers: 46

AJ Rice (@ajrice6713)

Abdelrahman Ahmed (@abahmed)

Alexandru Grigoras (@alexgrigoras)

Amir M. Mohamadi (@amir2mi)

Anthony McCaigue (@antmcc49)

Armano (@armano2)

Brendan Nee (@brendannee)

Chen (@HiChen404)

Davide Bianchi (@davidebianchi)

Devtato (@cerkiewny)

Edouard Bonlieu (@edouardb)

Feodor Fitsner (@FeodorFitsner)

Filipe Guerra (@alias-mac)

Gabriel Csapo (@gabrielcsapo)

Jake Witz (@jwitz)

Jeffrey Aven (@jeffreyaven)

Jody Heavener (@jodyheavener)

John Reilly (@johnnyreilly)

Joseph (@josephriosIO)

Josh Goldberg (@JoshuaKGoldberg)

Joshua Chen (@Josh-Cena)

Kaustubh Kulkarni (@kaustubhk24)

Lars Mikkelsen (@ltm)

Mikey O'Toole (@homotechsual)

Minh Pham (@lmpham1)

Morooka Kotaro (@MorookaKotaro)

Nayan Patel (@PatelN123)

Nick Schonning (@nschonni)

Pranab Das (@pranabdas)

Reece Dunham (@RDIL)

Rishi Raj Jain (@rishi-raj-jain)

Sanjay Soundarajan (@megasanjay)

Shun Wakatsuki (@shwaka)

Sébastien Lorber (@slorber)

Tapan Chudasama (@tapanchudasama)

Vaibhav Shinde (@vaibhavshn)

Vandré Leal (@vandreleal)

Yaroslav Serhieiev (@noomorph)

@mcallisto

@ruanqizhen

@wood3n

kuizuo (@kuizuo)

sgenoud (@sgenoud)

trent (@roydukkey)

Ömer Faruk APLAK (@omeraplak)

久染 | JiuRan (@1084350607)

Source code(tar.gz)
Source code(zip)
v2.0.0-beta.14(Dec 21, 2021)
2.0.0-beta.14 (2021-12-21)

:rocket: New Feature

docusaurus-theme-classic, docusaurus-theme-common

#6132 feat(theme-classic): new configuration syntax for a simple footer (@christopherklint97)

#6125 feat(theme-common): stable classname for code blocks (@Josh-Cena)

docusaurus-theme-classic

#5848 feat(theme-classic): standalone Admonition component (@Josh-Cena)

#6082 feat(theme-classic): allow passing additional attributes to tab headings (@Drylozu)

docusaurus-plugin-content-blog

#6126 feat(content-blog): support json feed (@notzheng)

docusaurus

#6107 feat(core): allow plugins to customize/override Webpack devServer config (@slorber)

:bug: Bug Fix

docusaurus-migrate

#6146 fix(migrate): do not modify non-MD files (@Josh-Cena)

docusaurus-theme-classic

#6128 fix: do not use aria-hidden in heading anchor links (@lex111)

docusaurus-plugin-content-docs

#6124 fix(content-docs): restore behavior when pagination front matter is null (@Josh-Cena)

#6085 fix(content-docs): getMainDocId should return doc with both versioned or unversioned id (@slorber)

docusaurus-theme-classic, docusaurus-utils-validation

#6097 fix: declare missing dependencies (@merceyz)

docusaurus-plugin-google-analytics, docusaurus-plugin-google-gtag, docusaurus-plugin-pwa, docusaurus-remark-plugin-npm2yarn, docusaurus-theme-live-codeblock, docusaurus-theme-search-algolia, lqip-loader

#6094 fix: add missing dependencies on tslib (@Josh-Cena)

docusaurus-theme-translations

#6088 fix(theme-translations): publish theme-translation lib, including typedef (@slorber)

:nail_care: Polish

docusaurus-theme-classic

#6053 feat(theme-classic): allow stylizing doc paginator arrows (@noomorph)

#6121 fix(theme-classic): add outline to focused code blocks (@christopherklint97)

#6118 refactor: remove some useless code (@lex111)

create-docusaurus, docusaurus-logger, docusaurus-mdx-loader, docusaurus-migrate, docusaurus-plugin-client-redirects, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-theme-classic, docusaurus-theme-search-algolia, docusaurus-theme-translations, docusaurus-utils-validation, docusaurus-utils, docusaurus

#5994 refactor: unify log format with new logger utility (@Josh-Cena)

create-docusaurus

#6119 fix(create-docusaurus): make initial editUrl functional (@Josh-Cena)

#6095 fix(create-docusaurus): give a clearer message when installation failed (@Josh-Cena)

:memo: Documentation

#6142 docs: normalize usage of placeholders (@Josh-Cena)

#5918 docs: refactor & refine lifecycle API docs (@Josh-Cena)

#6138 docs: add Smart Docs to showcase (@wowtvds)

#6137 docs: add ToolJet to showcase (@withshubh)

#6141 docs: add WoodpeckerCI to showcase (@6543)

#6135 docs: mention admonition quirks with Prettier (@yangshun)

#6131 docs: elaborate on "docs-only" and "blog-only" (@himanshu007-creator)

#6134 docs: update link to init template README.md (@cmpadden)

#6130 docs: refactor docs sidebar doc (@Josh-Cena)

#6129 docs: refactor styling/theming docs (@Josh-Cena)

#6112 docs: mention that SEO through front matter is better than head tag (@Josh-Cena)

#6120 refactor(website): make deploy preview open next version docs by default (@Josh-Cena)

#6111 docs: add Molecule website to showcase (@wewoor)

#6089 docs: add Enarx website to showcase (@HarshCasper)

#6090 docs: add sapphire to showcase (@favna)

#6091 docs(showcase): "much more pages" => "many more pages" (@favna)

:house: Internal

docusaurus-theme-classic

#6144 fix(theme-classic): fix translation when footer has no links (@Josh-Cena)

docusaurus-plugin-content-docs

#6143 test: fix async tests resolved in random order (@Josh-Cena)

#6123 test: use snapshots for sidebar tests (@Josh-Cena)

Other

#6122 fix(website): fix yarn build:website:fast (@slorber)

#6080 chore: add NPM and PNPM to E2E tests (@Josh-Cena)

create-docusaurus, docusaurus-cssnano-preset, docusaurus-mdx-loader, docusaurus-migrate, docusaurus-plugin-client-redirects, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-plugin-debug, docusaurus-plugin-google-analytics, docusaurus-plugin-google-gtag, docusaurus-plugin-ideal-image, docusaurus-plugin-pwa, docusaurus-plugin-sitemap, docusaurus-preset-classic, docusaurus-remark-plugin-npm2yarn, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-theme-live-codeblock, docusaurus-theme-search-algolia, docusaurus-theme-translations, docusaurus-types, docusaurus-utils-common, docusaurus-utils-validation, docusaurus-utils, docusaurus, lqip-loader

#6092 misc: ignore some files during npm publish (@Josh-Cena)

Committers: 17

6543 (@6543)

Alexey Pyltsyn (@lex111)

Christopher Klint (@christopherklint97)

Harsh Mishra (@HarshCasper)

Himanshu (@himanshu007-creator)

Jeroen Claassens (@favna)

Joshua Chen (@Josh-Cena)

Kristoffer K. (@merceyz)

Shubhendra Singh Chauhan (@withshubh)

Sébastien Lorber (@slorber)

Wout Vandesompele (@wowtvds)

Yangshun Tay (@yangshun)

Yaroslav Serhieiev (@noomorph)

Ziv (@wewoor)

@Drylozu

colton (@cmpadden)

不郑 (@notzheng)

Source code(tar.gz)
Source code(zip)
v2.0.0-beta.13(Dec 10, 2021)

2.0.0-beta.13 (2021-12-10)

Release to fix a bad npm publish in beta.12 and mitigate today's npm issues (https://status.npmjs.org/incidents/n4s34mwsdsp2)

Same code as beta.11, please refer to beta.11 changelog and release: https://github.com/facebook/docusaurus/releases/tag/v2.0.0-beta.11
Source code(tar.gz)
Source code(zip)
v2.0.0-beta.12(Dec 10, 2021)

2.0.0-beta.12 (2021-12-10)

Bad npm publish, please use beta 13 instead

https://github.com/facebook/docusaurus/releases/tag/v2.0.0-beta.13
Source code(tar.gz)
Source code(zip)
v2.0.0-beta.11(Dec 10, 2021)
2.0.0-beta.11 (2021-12-10)

:bug: Bug Fix

docusaurus-plugin-client-redirects, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-plugin-debug, docusaurus-plugin-google-analytics, docusaurus-plugin-google-gtag, docusaurus-plugin-ideal-image, docusaurus-plugin-pwa, docusaurus-plugin-sitemap, docusaurus-preset-classic, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-theme-live-codeblock, docusaurus-theme-search-algolia

#6078 fix: move docusaurus core back to hard dependencies (@pranabdas)

Committers: 2

Pranab Das (@pranabdas)

Sébastien Lorber (@slorber)

Source code(tar.gz)
Source code(zip)
v2.0.0-beta.10(Dec 9, 2021)
2.0.0-beta.10 (2021-12-09)

:rocket: New Feature

create-docusaurus, docusaurus-types, docusaurus

#5930 feat: shorthands for themes/plugins/presets configuration (@fsmaia)

docusaurus-mdx-loader, docusaurus-plugin-content-docs, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-theme-translations, docusaurus-utils, docusaurus

#5830 feat(content-docs): sidebar category linking to document or auto-generated index page (@slorber)

docusaurus-mdx-loader, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-remark-plugin-npm2yarn, docusaurus-types, docusaurus

#4095 feat(core): allow sourcing from multiple static directories (@oriooctopus)

create-docusaurus

#3458 feat(create-docusaurus): allow using local folder as template (@afshinm)

docusaurus-plugin-content-blog

#5787 feat(content-blog): allow sorting posts in ascending order (@cerkiewny)

docusaurus-module-type-aliases, docusaurus-theme-classic, docusaurus

#3104 feat(core): Add React ErrorBoundary component + theme default boundaries (@spyke01)

:boom: Breaking Change

docusaurus-plugin-content-blog

#6061 fix(content-blog): make post ID unique (@Josh-Cena)

docusaurus-migrate, docusaurus-plugin-content-docs

#6065 refactor: remove deprecated docs homePageId option (@lex111)

docusaurus-plugin-content-docs

#6056 refactor: remove unused metadata field for homepage (@lex111)

docusaurus-mdx-loader, docusaurus-plugin-content-docs, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-theme-translations, docusaurus-utils, docusaurus

#5830 feat(content-docs): sidebar category linking to document or auto-generated index page (@slorber)

docusaurus-module-type-aliases, docusaurus-plugin-google-analytics, docusaurus-plugin-google-gtag, docusaurus-preset-classic

#5832 refactor(ganalytics, gtag): move options out of themeConfig (@Josh-Cena)

create-docusaurus, docusaurus-plugin-client-redirects, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-theme-search-algolia, docusaurus-utils

#5871 misc: replace all "Metadatas" with "Metadata" (@swalahamani)

:bug: Bug Fix

docusaurus-theme-common

#6070 fix(theme-common): useLocationChange fire un-necessarily twice (@slorber)

#6040 fix: browser storage (localStorage) is unreliable: api should fail-safe (@slorber)

create-docusaurus, docusaurus-mdx-loader, docusaurus-plugin-client-redirects, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-plugin-debug, docusaurus-plugin-google-analytics, docusaurus-plugin-google-gtag, docusaurus-plugin-ideal-image, docusaurus-plugin-pwa, docusaurus-plugin-sitemap, docusaurus-preset-classic, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-theme-live-codeblock, docusaurus-theme-search-algolia, docusaurus-theme-translations, docusaurus-utils-validation, docusaurus-utils, docusaurus

#6047 fix: make Docusaurus PnP strict mode compatible (@Josh-Cena)

docusaurus-theme-classic, docusaurus

#6052 fix(core): fix error boundary import disrupting CSS order (@Josh-Cena)

docusaurus-plugin-content-blog

#6061 fix(content-blog): make post ID unique (@Josh-Cena)

docusaurus

#5983 fix(core): do not apply theme-init alias to user component (@Josh-Cena)

#5798 fix(cli): update notifier should be shown if current is less than latest (@semoal)

#5864 fix: respect base URL when serving content by webpack dev server (@lex111)

docusaurus-module-type-aliases

#5945 fix(module-type-aliases): add svg declaration (@MisterFISHUP)

docusaurus-theme-classic

#5873 fix(theme-classic): fix announcementBar css (@slorber)

:nail_care: Polish

docusaurus-theme-classic

#6003 fix(theme-classic): make nav dropdowns focusable (@robinmetral)

#6000 fix(theme-classic): make hash link in heading not selectable (@JararvisQ)

#5944 fix: translate all remaining english sentence in French (@StanKocken)

docusaurus-theme-classic, docusaurus

#6048 refactor: capitalize locales when creating i18n config (@lex111)

docusaurus-theme-translations

#5976 feat(theme-translations): add extra Korean translation, fix typo (@revi)

#6060 chore(theme-translations): complete Chinese translations (@Josh-Cena)

docusaurus-migrate, docusaurus-plugin-content-docs

#6065 refactor: remove deprecated docs homePageId option (@lex111)

docusaurus-plugin-content-docs

#6056 refactor: remove unused metadata field for homepage (@lex111)

docusaurus-theme-classic, docusaurus-theme-common

#6049 refactor: simplify Toggle component (@lex111)

docusaurus-theme-classic, docusaurus-theme-search-algolia, docusaurus-theme-translations, docusaurus-types

#5981 refactor: minor ESLint improvements (@Josh-Cena)

docusaurus-plugin-pwa

#5995 chore(plugin-pwa): change core-js version in package.json to v3 (@Josh-Cena)

docusaurus-plugin-pwa, docusaurus-theme-classic, docusaurus-theme-live-codeblock, docusaurus-theme-search-algolia, docusaurus-theme-translations, docusaurus-utils

#5849 refactor: define own translations in other themes (@lex111)

docusaurus-plugin-google-analytics, docusaurus-plugin-google-gtag, docusaurus-types

#5959 refactor(types): correct HtmlTags types (@armano2)

docusaurus

#5829 refactor: optimize clone and checkout in deploy command (@sivapalan)

#5899 feat(core): give more hints when plugins have duplicate IDs (@Josh-Cena)

docusaurus-module-type-aliases, docusaurus-plugin-google-analytics, docusaurus-plugin-google-gtag, docusaurus-preset-classic

#5832 refactor(ganalytics, gtag): move options out of themeConfig (@Josh-Cena)

create-docusaurus, docusaurus

#5840 feat: allow GIT_USER env var to be unset if SSH is used (@wpyoga)

create-docusaurus, docusaurus-plugin-client-redirects, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-theme-search-algolia, docusaurus-utils

#5871 misc: replace all "Metadatas" with "Metadata" (@swalahamani)

:memo: Documentation

Other

#6063 docs: add moja global to showcase (@sohamsshah)

#6069 docs: update CONTRIBUTING for website (@Josh-Cena)

#6062 refactor(website): improve wording in comments of showcase data (@sohamsshah)

#6045 docs: add "discord resources" to showcase (@dexbiobot)

#6026 docs(deployment): add cost-benefit analysis with different options (@Josh-Cena)

#5955 docs: add Pearl UI website to showcase (@agrawal-rohit)

#5989 misc: update CONTRIBUTING to reflect status quo (@Josh-Cena)

#5845 docs(admin): update repo testing instructions to reflect v2 (@wpyoga)

#6019 docs: update Netlify url config option in deployment instructions (@rsapkf)

#6015 docs: add Tremor website to showcase page (@skoech)

#5997 refactor(website): various fixes and improvements on Showcase page (@lex111)

#6008 docs: improve algolia integration instructions (@shafy)

#6006 docs: improve explanation for url config in GH Pages (@Martinsos)

#6001 docs: add Dime.Scheduler SDK to showcase (@hbulens)

#5984 docs: add PREFS website to showcase (@Patitotective)

#5967 docs(website): Add docsearch migration blog post (@slorber)

#5968 refactor(website): shadow on showcase toggle (@dsmmcken)

#5979 docs: update links to default translations dir (@lex111)

#5969 refactor(website): polish on Showcase page (@slorber)

#5966 docs: add Darklang to showcase (@pbiggar)

#5970 docs: add Remirror to showcase (@ronnyroeller)

#5971 docs: add Webiny docs to showcase page (@swapnilmmane)

#5953 docs: fix BrowserOnly return statement (@MorookaKotaro)

#5949 docs: update Signoz showcase details (@pal-sig)

#5948 fix(website): fix APITable anchor ID having extra hash (@Josh-Cena)

#5947 fix(website): fix APITable anchor link (@Josh-Cena)

#5925 docs: add Froggit site to showcase page (@cchaudier)

#5928 docs: Add Shotstack showcase user (@jeffski)

#5934 docs: fix a typo in CHANGELOG (@KonstHardy)

#5921 docs: add Signoz site to showcase site (@pal-sig)

#5891 docs: new APITable comp to render large tables (@Josh-Cena)

#5917 docs: make API sidebar partially autogenerated (@Josh-Cena)

#5903 docs: refer to deployed branch as deployment rather than target (@Josh-Cena)

#5902 fix(website): fix i18n routes for Canny board (@Josh-Cena)

#5900 docs: document global variables in MDX scope (@Josh-Cena)

#4409 docs: add example for Github Pages deployment; rewrite deployment section (@polarathene)

#5888 docs: update GitHub deployment instructions (@rootwork)

#5895 docs: Add juffalow.com to Docusaurus showcase (@juffalow)

#5881 docs: fix wrong code sample in docusaurus-core (@matthijsgroen)

#5875 docs: add patrikmasiar website showcase (@patrikmasiar)

#5876 docs: '5 minutes tutorial' -> '5-minute tutorial' (@molly)

#5759 docs: create SEO documentation page (@cerkiewny)

#5869 docs: remove duplicated appId property (@juzhiyuan)

#5868 docs: fix a typo in using-themes.md (@fishmandev)

#5862 misc: show only latest archive alpha/beta versions dropdown (@lex111)

docusaurus

#5742 feat(website): redesign of showcase page (@chimailo)

:house: Internal

create-docusaurus, docusaurus-plugin-client-redirects, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-plugin-ideal-image, docusaurus-plugin-pwa, docusaurus-theme-common, docusaurus-theme-translations, docusaurus-utils-validation, docusaurus

#6071 refactor: add blank lines below all copyright headers (@Josh-Cena)

Other

#6068 chore: add prefix to needs triage label; separate Windows test workflow (@Josh-Cena)

#6031 chore: upgrade netlify-cli (@Josh-Cena)

#6012 chore(website): enable strict compiler option (@Josh-Cena)

#6002 chore(ci): add GitHub action for showcase testing (@Josh-Cena)

#5977 chore: generate dogfooding test for long pathname during CI (@Josh-Cena)

#5950 misc(codeowners): add @Josh-Cena to CODEOWNERS (@Josh-Cena)

#5919 misc(workflow): E2E tests should not be run with website changes (@Josh-Cena)

#5907 chore(workflow): merge jobs into one workflow & give each job a name (@Josh-Cena)

#5889 chore(website): enable eslint in website (@Josh-Cena)

#5870 chore(README): fix broken Github Actions Workflow Status icon (@HemantSachdeva)

docusaurus-module-type-aliases, docusaurus-types, docusaurus

#6064 refactor(core): fix types for client code (@Josh-Cena)

create-docusaurus, docusaurus-mdx-loader, docusaurus-migrate, docusaurus-plugin-client-redirects, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-ideal-image, docusaurus-plugin-pwa, docusaurus-plugin-sitemap, docusaurus-theme-translations, docusaurus-utils, docusaurus

#6055 chore: clean up dev dependency declarations (@Josh-Cena)

create-docusaurus, docusaurus-plugin-ideal-image, docusaurus-theme-classic

#6010 chore: upgrade prettier; rename prettier scripts as format (@Josh-Cena)

create-docusaurus, docusaurus

#5958 chore: update @svgr/webpack to version 6 (@ludofischer)

docusaurus

#5998 chore: upgrade webpack-dev-server to v4.5.0 (@lex111)

#5965 fix(core): apply staticDirectories to base webpack config (@Josh-Cena)

docusaurus-mdx-loader, docusaurus-plugin-client-redirects, docusaurus-plugin-content-pages, docusaurus-plugin-debug, docusaurus-plugin-ideal-image, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-utils-common, docusaurus-utils, docusaurus

#5985 chore: cleanup dependency declaration in package.json (@armano2)

create-docusaurus, docusaurus-migrate, docusaurus-plugin-client-redirects, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-plugin-debug, docusaurus-plugin-google-gtag, docusaurus-plugin-sitemap, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-theme-live-codeblock, docusaurus-theme-search-algolia, docusaurus-utils, docusaurus, lqip-loader, stylelint-copyright

#5963 chore: upgrade TypeScript & other ESLint related deps (@Josh-Cena)

docusaurus-plugin-content-docs

#5962 refactor(content-docs): move isCategoriesShorthand to utils (@armano2)

#5906 fix(content-docs): do not echo git history to console (@Josh-Cena)

#5905 misc(plugin-docs): fix Windows test snapshot for git history retrieval (@Josh-Cena)

#5904 refactor(content-docs): use shelljs instead of execa (@Josh-Cena)

docusaurus-plugin-ideal-image

#5940 refactor(plugin-ideal-image): migrate package to TS (@armano2)

docusaurus-plugin-pwa, docusaurus-theme-classic

#5941 refactor(plugin-pwa): migrate package to TS (@armano2)

docusaurus-plugin-ideal-image, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-theme-search-algolia

#5935 refactor(theme-search-algolia): migrate package to TS (@armano2)

docusaurus-mdx-loader, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages

#5946 refactor: move deps declarations into src (@Josh-Cena)

docusaurus-mdx-loader, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-debug, docusaurus-plugin-google-gtag, docusaurus-plugin-ideal-image, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-theme-live-codeblock, docusaurus-utils-common, docusaurus-utils, docusaurus

#5914 refactor: improve setup of type declaration files (@Josh-Cena)

docusaurus-theme-classic, docusaurus-theme-common

#5922 refactor(theme-classic): move some logic of CodeBlock to theme-common (@Josh-Cena)

docusaurus-remark-plugin-npm2yarn

#5931 refactor(remark-plugin-npm2yarn): migrate package to TS (@duanwilliam)

docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-theme-classic, docusaurus-utils

#5806 refactor: use js-yaml to parse both JSON and YAML (@Josh-Cena)

Committers: 48

Afshin Mehrabani (@afshinm)

Alexey Pyltsyn (@lex111)

Armano (@armano2)

Brennan Kinney (@polarathene)

Can Olcer (@shafy)

Christophe Chaudier (@cchaudier)

Devtato (@cerkiewny)

Dmitriy Fishman (@fishmandev)

Don (@dsmmcken)

FISH UP (@MisterFISHUP)

Fernando Maia (@fsmaia)

Hemant Sachdeva (@HemantSachdeva)

Hendrik Bulens (@hbulens)

Ivan Boothe (@rootwork)

Jarar (@JararvisQ)

Jeff Shillitto (@jeffski)

Joshua Chen (@Josh-Cena)

Konstantin Popov (@KonstHardy)

Ludovico Fischer (@ludofischer)

Martin Šošić (@Martinsos)

Matej Jellus (@juffalow)

Matthijs Groen (@matthijsgroen)

Molly White (@molly)

Morooka Kotaro (@MorookaKotaro)

Oliver Ullman (@oriooctopus)

Paden Clayton (@spyke01)

Patitotective (@Patitotective)

Patrik Mäsiar (@patrikmasiar)

Paul Biggar (@pbiggar)

Rey (@rsapkf)

Robin Métral (@robinmetral)

Rohit Agrawal (@agrawal-rohit)

Ronny Roeller (@ronnyroeller)

Sergio Moreno (@semoal)

Sharon Koech (@skoech)

Shoaib Sajid (@dexbiobot)

Soham Shah (@sohamsshah)

Stan Kocken (@StanKocken)

Swalah Amani (@swalahamani)

Swapnil M Mane (@swapnilmmane)

Sébastien Lorber (@slorber)

Varun Sivapalan (@sivapalan)

William Poetra Yoga (@wpyoga)

Yongmin Hong (@revi)

@duanwilliam

@pal-sig

chima ilo (@chimailo)

琚致远 (@juzhiyuan)

Source code(tar.gz)
Source code(zip)
v2.0.0-beta.9(Nov 2, 2021)
2.0.0-beta.9 (2021-11-02)

:rocket: New Feature

docusaurus-theme-classic, docusaurus-theme-common

#5770 feat(theme-classic): allow specifying width/height in logo (@cerkiewny)

docusaurus-types, docusaurus

#5841 feat: allow user to specify deploymentBranch property in docusaurus.config.js (@wpyoga)

docusaurus-theme-classic, docusaurus-theme-common, docusaurus-theme-search-algolia

#5795 feat(search-algolia): algolia externalUrl regex to navigate with window.href (@semoal)

docusaurus-mdx-loader, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-plugin-ideal-image, docusaurus-plugin-pwa, docusaurus-types, docusaurus

#5814 feat: Support Node 17 (@slorber)

#5420 feat(core): upgrade to webpack-dev-server@4 (@AviVahl)

docusaurus-theme-classic

#5791 feat(theme-classic): add Serbian Cyrillic translation (@utajum)

:boom: Breaking Change

create-docusaurus, docusaurus-mdx-loader, docusaurus-migrate, docusaurus-plugin-client-redirects, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-plugin-debug, docusaurus-plugin-google-analytics, docusaurus-plugin-google-gtag, docusaurus-plugin-ideal-image, docusaurus-plugin-sitemap, docusaurus-preset-classic, docusaurus-remark-plugin-npm2yarn, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-theme-live-codeblock, docusaurus-theme-search-algolia, docusaurus-utils-common, docusaurus-utils-validation, docusaurus-utils, docusaurus, lqip-loader

#5812 chore: require Node 14 (@slorber)

:bug: Bug Fix

docusaurus-plugin-content-blog

#5835 fix(content-blog): Fix blog feeds not generated (@slorber)

docusaurus

#5828 fix: include all branch tips for shallow clone in deploy command (@sivapalan)

#5824 fix: baseUrl passed to sortConfig (@semoal)

#5813 fix: handle SIGTERM in build command (@slorber)

docusaurus-module-type-aliases, docusaurus

#5819 fix: use @docusaurus/react-loadable as package alias + include types (@slorber)

:nail_care: Polish

docusaurus-preset-classic

#5831 feat(preset-classic): guard against unknown keys in options (@Josh-Cena)

docusaurus

#5815 refactor: some improvements for webpack-dev-server (@lex111)

docusaurus-theme-classic, docusaurus-theme-common, docusaurus-utils, docusaurus

#5788 refactor: fix a few type inconsistencies (@Josh-Cena)

docusaurus-theme-classic

#5781 refactor: Vietnamese translations (@datlechin)

:memo: Documentation

Other

#5853 docs: Fix a typo in CONTRIBUTING.md (@fishmandev)

#5852 docs: Fix a typo in versioning.md (@fishmandev)

#5847 docs: add InfraQL product docs website to showcase (@jeffreyaven)

#5843 docs: fix i18n routes to feature requests (@Josh-Cena)

#5766 docs: elaborate on the usage of MDX plugins (@cerkiewny)

#5826 docs: fix lint issue (@slorber)

#5801 docs: Update Drone Deployment docs (@gabrielfalcao)

#5821 docs: include navbar item type in the API table (@Josh-Cena)

#5820 docs: add @Josh-Cena to the team (@Josh-Cena)

#5818 doc: fix typo in "create a doc" (@dominikmeyersap)

#5797 docs: use "npx create-docusaurus" for init (@slorber)

#5771 docs: Minor update to grammar in plugins overview page (@robbieaverill)

#5774 docs: update ssrTemplate (@juzhiyuan)

#5784 docs: fix link for apply to DocSearch program (@lex111)

create-docusaurus

#5792 docs: fix typo (@wingclover)

:house: Internal

Other

#5842 misc: add "name" field for root package.json (@wpyoga)

#5836 chore: switch to GitHub issue forms (@lex111)

#5834 chore(issue templ): add "self service" section in templates (@Josh-Cena)

#5833 chore(workflow): remove v2 prefix from titles (@Josh-Cena)

#5697 chore(workflow): add cache to workflows using actions/setup-node (@oscard0m)

#5825 chore: fix Crowdin again (@slorber)

#5823 chore: replace doc sample .pdf file by .xlsx to solve Crowdin issue (@slorber)

#5763 chore: update examples for beta.8 (@slorber)

create-docusaurus, docusaurus-mdx-loader, docusaurus-migrate, docusaurus-plugin-client-redirects, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-plugin-debug, docusaurus-plugin-google-analytics, docusaurus-plugin-google-gtag, docusaurus-plugin-ideal-image, docusaurus-plugin-sitemap, docusaurus-preset-classic, docusaurus-remark-plugin-npm2yarn, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-theme-live-codeblock, docusaurus-theme-search-algolia, docusaurus-utils-common, docusaurus-utils-validation, docusaurus-utils, docusaurus, lqip-loader

#5812 chore: require Node 14 (@slorber)

docusaurus-plugin-client-redirects, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-theme-classic, docusaurus

#5807 refactor: remove a few Lodash usages & ESLint enforcement (@Josh-Cena)

docusaurus-module-type-aliases, docusaurus-plugin-client-redirects, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-utils, docusaurus

#5808 refactor: clear a few ESLint warnings (@Josh-Cena)

docusaurus-mdx-loader, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, lqip-loader

#5779 refactor: migrate lqip-loader to TS, fix typing for Webpack Loaders (@Josh-Cena)

Committers: 18

Alexey Pyltsyn (@lex111)

Avi Vahl (@AviVahl)

Devtato (@cerkiewny)

Dmitriy Fishman (@fishmandev)

Dominik Meyer (@dominikmeyersap)

Gabriel Falcão (@gabrielfalcao)

Jeffrey Aven (@jeffreyaven)

Joshua Chen (@Josh-Cena)

Ngô Quốc Đạt (@datlechin)

Oscar Dominguez (@oscard0m)

Robbie Averill (@robbieaverill)

Sergio Moreno (@semoal)

Sébastien Lorber (@slorber)

Varun Sivapalan (@sivapalan)

Vladimir Tasic (@utajum)

William Poetra Yoga (@wpyoga)

Ying Wang (@wingclover)

琚致远 (@juzhiyuan)

Source code(tar.gz)
Source code(zip)
v2.0.0-beta.8(Oct 21, 2021)
2.0.0-beta.8 (2021-10-21)

:rocket: New Feature

docusaurus-plugin-content-blog

#5702 feat(content-blog): new readingTime plugin option (@Josh-Cena)

docusaurus

#5740 feat(core): write-heading-ids options maintainCasing, overwrite (@Josh-Cena)

docusaurus-plugin-content-docs

#5705 feat(content-docs): new front matter options to customize pagination (@Josh-Cena)

:boom: Breaking Change

docusaurus-theme-search-algolia

#5751 fix: stable callbacks in useSearchQuery + refactor (@slorber)

:bug: Bug Fix

docusaurus-plugin-ideal-image

#5760 fix(ideal-image): fix IdealImage in dev not handling ES import images properly (@slorber)

docusaurus-theme-classic

#5732 fix(theme-classic): allow tabs with number as value (@Josh-Cena)

#5721 fix: handle rubber band scrolling in hideable navbar (@lex111)

docusaurus-theme-search-algolia

#5751 fix: stable callbacks in useSearchQuery + refactor (@slorber)

:nail_care: Polish

docusaurus-theme-classic

#5717 refactor: Polish de translation (@philipp985)

#5725 refactor: add missing Turkish translations to theme-classic (@canercanbaz)

#5723 refactor(v2): update Vietnamese translations (@datlechin)

docusaurus-module-type-aliases, docusaurus-plugin-ideal-image, docusaurus-theme-classic, docusaurus

#5726 refactor(module-type-aliases): remove fallback aliases (@Josh-Cena)

:memo: Documentation

Other

#5755 docs: rename docusaurus.config.js route + redirects cleanup (@slorber)

#5750 docs(v2): Fix typo in using-plugins.md (@thanasis00)

#5727 docs(v2): Add Fenghua Frontend Developer site to showcase page (@zxuqian)

#5746 docs: Add plugin-image-zoom (@ataft)

#5728 docs: add h4 into toc on certain pages (@Josh-Cena)

#5737 docs: Add Apex FP to showcase (@ipavlic)

docusaurus-plugin-content-blog

#5753 fix(content-blog): temporarily swallow feed mdxToHtml errors + feed refactor (@slorber)

:house: Internal

docusaurus

#5761 chore: upgrade html-webpack-plugin, remove terser 4 (@slorber)

docusaurus-theme-classic, docusaurus-theme-common, docusaurus-theme-search-algolia, docusaurus

#5714 chore: Enable ESLint rules of hooks + fix new lint errors (@slorber)

Other

#5722 chore: fix gen script to support TS template (@lex111)

#5730 chore: fix typos / casing in issue template (@johnnyreilly)

#5720 chore: regenerate beta.7 examples (@lex111)

#5719 chore: remove beta.5 docs (@lex111)

:running_woman: Performance

docusaurus

#5748 refactor: perform shallow clone during deploy (@nlfurniss)

Committers: 13

Alexey Pyltsyn (@lex111)

Andrew Taft (@ataft)

Caner Canbaz (@canercanbaz)

Dimi Mikadze (@DimiMikadze)

Ilija Pavlic (@ipavlic)

John Reilly (@johnnyreilly)

Joshua Chen (@Josh-Cena)

Nathaniel Furniss (@nlfurniss)

Ngô Quốc Đạt (@datlechin)

Sébastien Lorber (@slorber)

Thanasis Katsadas (@thanasis00)

Xuqian (@zxuqian)

@philipp985

Source code(tar.gz)
Source code(zip)
v2.0.0-beta.7(Oct 15, 2021)
2.0.0-beta.7 (2021-10-15)

:rocket: New Feature

docusaurus-module-type-aliases, docusaurus

#5683 feat: make Translate children optional (@lex111)

docusaurus-theme-classic, docusaurus-theme-common

#5674 polish(theme-classic): guard against potential definition mistakes in Tabs (@Josh-Cena)

#5618 feat: maintain page position for clicked grouped tabs (@Shrugsy)

docusaurus-plugin-content-blog, docusaurus-utils

#4330 feat(content-blog): add full blog post html into RSS/Atom feeds (@moonrailgun)

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

#5642 feat(theme-classic, plugin-docs): sidebar item level-specific className + allow customization (@Josh-Cena)

create-docusaurus

#5635 feat: npm init docusaurus, yarn create docusaurus (@slorber)

docusaurus-init, docusaurus-mdx-loader, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-plugin-sitemap, docusaurus-preset-classic, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-types

#5589 feat: properly type-check the Docusaurus config of new sites (@bmiddha)

docusaurus-mdx-loader, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-types, docusaurus-utils-validation

#5578 feat(v2): allow specifying TOC max depth (themeConfig + frontMatter) (@erickzhao)

docusaurus

#5498 feat: make Webpack url-loader limit configurable (env variable) (@stnor)

docusaurus-plugin-content-blog, docusaurus-plugin-content-docs

#5545 feat: make tags route path configurable (@lex111)

:boom: Breaking Change

docusaurus-theme-classic, docusaurus-theme-common

#5674 polish(theme-classic): guard against potential definition mistakes in Tabs (@Josh-Cena)

#5618 feat: maintain page position for clicked grouped tabs (@Shrugsy)

docusaurus-init, docusaurus-preset-bootstrap, docusaurus-theme-bootstrap

#5634 chore: remove unused Bootstrap theme (@slorber)

docusaurus-mdx-loader, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-types, docusaurus-utils-validation

#5578 feat(v2): allow specifying TOC max depth (themeConfig + frontMatter) (@erickzhao)

docusaurus-theme-classic

#5592 refactor: use CSS Modules for toggle styles (@lex111)

:bug: Bug Fix

docusaurus-theme-common

#5694 fix: proper collapsing of long element (@lex111)

docusaurus

#5684 fix: use realpath for site dir to resolve symlink (@lex111)

#5645 fix: place root route at the end (@lex111)

#5629 fix: text/link hydration bug (@slorber)

docusaurus-theme-classic, docusaurus-theme-common

#5699 fix: apply announcement bar class if only needed (@lex111)

docusaurus-theme-classic

#5667 fix: expand tag column on truncated post (@lex111)

#5668 fix: preserve line breaks when copy code in Firefox (@lex111)

#5647 feat(theme-classic): make first tab the default tab (@Josh-Cena)

#5652 fix: restore duplicate Tabs rendering to fix hydration issue (@slorber)

#5643 fix(theme-classic): reset default style for task lists (@EkaterinaMozheiko)

#5571 fix: highlight active item in recent post list (@lex111)

#5481 fix: use heading itself as anchor for better crawling (@lex111)

docusaurus-theme-live-codeblock

#5677 fix: Don't ignore options.transforms for buble (@ntucker)

#5556 fix: pin react-live due to possible mismatch React (@lex111)

docusaurus-mdx-loader

#5690 fix: preserve hash in asset link (@lex111)

docusaurus-plugin-ideal-image

#5540 fix: do not use ideal image plugin in dev env (@lex111)

docusaurus-plugin-content-docs

#5606 fix(docs): create tags route if only tags exists (@lex111)

docusaurus-init, docusaurus-module-type-aliases, docusaurus-types

#5601 fix(module-type-aliases): move type packages to dependencies (@Josh-Cena)

docusaurus-utils

#5495 fix: ignore code block lines when creating excerpt (@lex111)

docusaurus-init

#5490 fix: install deps for new project via Yarn on Windows properly (@lex111)

docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-utils-validation

#5479 fix: add docs tag validation to solve #5478 (@sw-yx)

:nail_care: Polish

docusaurus-theme-classic, docusaurus-theme-common

#5709 refactor: cleanup scroll handlers (@lex111)

#5627 refactor: various TOC improvements (@lex111)

#5469 refactor: Adjust styling of back top top button (@dsmmcken)

docusaurus-theme-classic

#5708 refactor: hide hash link from crawlers (@lex111)

#5649 refactor: improve pt-BR translation for classic theme (@printf-ana)

#5646 refactor: complete missing and fix ES translations (@caleeli)

#5640 style: update Persian language translations (@MrTechHunter)

#5630 refactor: standardize using media queries (@lex111)

#5487 refactor: use only one close SVG icon (@lex111)

#5592 refactor: use CSS Modules for toggle styles (@lex111)

#5485 polish: prevent pop navigation on back if navbar sidebar is open (@slorber)

#5472 polish(theme-classic): add Chinese translations (@Josh-Cena)

docusaurus-module-type-aliases, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-plugin-debug, docusaurus-theme-classic, docusaurus-types, docusaurus

#5636 refactor: make all Props defined as interface + readonly (@Josh-Cena)

docusaurus-mdx-loader, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-remark-plugin-npm2yarn, docusaurus-theme-bootstrap, docusaurus-theme-classic, docusaurus-theme-common, docusaurus

#5560 polish: remove unused eslint-disable (@Josh-Cena)

docusaurus

#5580 refactor(core): type improvements for PendingNavigation (@Josh-Cena)

docusaurus-theme-classic, docusaurus

#5496 refactor: remove deprecated createRequireFromPath (@lex111)

:memo: Documentation

#5681 docs(v2): Add CountryStateCityAPI site to showcase page (@dr5hn)

#5661 docs: updated cloudywithachanceofbigdata.com blog showcase (@jeffreyaven)

#5658 docs: Algolia plugin must be enabled before crawling the site (@slorber)

#5654 docs: Add Warrant Docs site to showcase page (@akajla09)

#5655 docs: Added cloudywithachanceofbigdata.com showcase blog (@jeffreyaven)

#5648 docs: add ory documentation to showcase (@vinckr)

#5644 docs: add djamaile blog to site showcase (@djamaile)

#5641 docs: add Lux Algo to showcase (@Josh-Cena)

#5638 docs: add nanos world docs to showcase (@gtnardy)

#5610 docs: Add IOTA wiki to showcase (@Dr-Electron)

#5489 docs: add additional search options, typesense and local search (@jasonbosco)

#5590 docs(website): document npm2yarn plugin + use new Tabs API everywhere (@Josh-Cena)

#5591 docs: Add whirl.codes to showcase (@Whirl21)

#5574 docs: add Pipeline UI to showcase (@headline-design)

#5585 docs: fix more references to Discord channels (@Josh-Cena)

#5572 docs: add Blogasaurus to showcase (@BattleOfPlassey)

#5575 docs: clarify MDX version used (@lex111)

#5581 docs(website): update all Discord links (@Josh-Cena)

#5566 docs: fix code example (@ChrisChinchilla)

#5559 docs: minor grammatical correction (@jkhaui)

#5543 docs: add note about files being ignored when prefixed with an unders… (@KyrietS)

#5549 docs: Add Mint Metrics site to the Showcase (@kingo55)

#5546 docs: add unleash to showcase (@ivarconr)

#5539 docs: improve escape pipe in Markdown tables (@forresst)

#5486 docs: mention Netlify ignore build setting (@slorber)

#5482 docs: update docusaurus-plugin-relative-paths description (@ohkimur)

:house: Internal

create-docusaurus, docusaurus-plugin-content-docs

#5678 refactor(content-docs): refactor sidebars, Joi validation, generator rework, expose config types (@Josh-Cena)

docusaurus-theme-classic

#5666 chore: upgrade Infima to alpha.34 (@lex111)

#5639 misc: update base translation + remove extra char (@lex111)

Other

#5669 fix: allow ColorGenerator to parse colors with prefix # (@Andrewnt219)

#5632 chore: prepare Algolia migration (@slorber)

#5628 chore: fix warning after build (@lex111)

#5573 misc: fix ungrammatical sentence about 5-min tutorial (@hughlilly)

#5499 chore: set up CodeQL (@zpao)

#5474 chore: remove beta.4 docs (already archived) (@slorber)

docusaurus-init, docusaurus-preset-bootstrap, docusaurus-theme-bootstrap

#5634 chore: remove unused Bootstrap theme (@slorber)

docusaurus-init, docusaurus-mdx-loader, docusaurus-migrate, docusaurus-module-type-aliases, docusaurus-plugin-client-redirects, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-pwa, docusaurus-plugin-sitemap, docusaurus-preset-classic, docusaurus-theme-bootstrap, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-types, docusaurus-utils, docusaurus, lqip-loader

#5611 chore: upgrade Prettier + regenerate lock file (@Josh-Cena)

docusaurus-plugin-pwa, docusaurus

#5609 chore: upgrade Terser-related dependencies (@lex111)

docusaurus-cssnano-preset, docusaurus-init, docusaurus-mdx-loader, docusaurus-migrate, docusaurus-plugin-client-redirects, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-plugin-debug, docusaurus-plugin-ideal-image, docusaurus-plugin-pwa, docusaurus-plugin-sitemap, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-theme-live-codeblock, docusaurus-theme-search-algolia, docusaurus-types, docusaurus-utils-common, docusaurus-utils-validation, docusaurus-utils, docusaurus, lqip-loader

#5608 chore: upgrade dependencies (@lex111)

docusaurus

#5605 refactor(core): enforce noImplicitAny (@Josh-Cena)

docusaurus-preset-classic

#5603 fix(preset-classic): fix TS build issue (@slorber)

docusaurus-plugin-google-analytics, docusaurus-plugin-google-gtag, docusaurus-preset-classic

#5561 refactor(plugin-google-gtag, plugin-google-analytics): migrate packages to TS (@Josh-Cena)

docusaurus-mdx-loader, docusaurus-plugin-content-blog, docusaurus-plugin-content-pages, docusaurus-plugin-sitemap, docusaurus-preset-classic

#5579 refactor(preset-classic): migrate preset-classic to TypeScript (@Josh-Cena)

docusaurus-init

#5484 chore: regenerate beta.6 examples + fix regen script (@slorber)

Committers: 36

Aditya Kajla (@akajla09)

Alexey Pyltsyn (@lex111)

Ana Carolina (@printf-ana)

Andrew Nguyen (@Andrewnt219)

Bharat Middha (@bmiddha)

Chris Chinchilla (@ChrisChinchilla)

Daniel Costrasel (@ohkimur)

Darshan Gada (@dr5hn)

David Callizaya (@caleeli)

Don (@dsmmcken)

Ekaterina Mozheiko (@EkaterinaMozheiko)

Erick Zhao (@erickzhao)

Forresst (@forresst)

Gabriel T. Nardy (@gtnardy)

Hugh Lilly (@hughlilly)

Ivar Conradi Østhus (@ivarconr)

Jason Bosco (@jasonbosco)

Jeffrey Aven (@jeffreyaven)

Jordan Lee (@jkhaui)

Joshua Chen (@Josh-Cena)

Kyriet (@KyrietS)

Mahdi Hamldar (@MrTechHunter)

Nathaniel Tucker (@ntucker)

Palash Shrivastava (@BattleOfPlassey)

Paul O’Shannessy (@zpao)

Robert Kingston (@kingo55)

Stefan Norberg (@stnor)

Sébastien Lorber (@slorber)

Vincent (@vinckr)

Whirl (@Whirl21)

@Dr-Electron

@Shrugsy

@djamaile

@headline-design

moonrailgun (@moonrailgun)

swyx (@sw-yx)

Source code(tar.gz)
Source code(zip)
v2.0.0-beta.6(Sep 2, 2021)
2.0.0-beta.6 (2021-09-02)

:rocket: New Feature

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

#5428 feat: adds blog archive route (@gabrielcsapo)

docusaurus-theme-classic, docusaurus-theme-common

#5462 feat: on back navigation, close mobile sidebar (@slorber)

#5445 feat: Add docs-related stable classnames (@slorber)

docusaurus-theme-classic

#5460 feat: infima 33 + navbar-sidebar close button (@slorber)

#5442 feat(theme-classic): allow passing tab label and default value through TabItem (@Josh-Cena)

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

#5454 feat: new docs options: versions.{badge,className} (@slorber)

:bug: Bug Fix

docusaurus-theme-classic

#5444 fix: fix some theme UI issues (blockquotes, navbar-sidebar font) with Infima alpha.32 (@slorber)

#5431 fix: some beta.5 bugfixes (@slorber)

docusaurus-init, docusaurus-mdx-loader, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-theme-classic

#5437 fix: fix a few TS errors (@Josh-Cena)

:nail_care: Polish

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

#5459 refactor(theme-classic): completely migrate package to TypeScript (@Josh-Cena)

docusaurus-theme-classic

#5453 refactor: use SVG for closable button in announcement bar (@lex111)

#5430 refactor: switch to Flexbox in announcement bar (@lex111)

#5434 refactor: update Arabic and Persian translations (@3alisaki)

#5410 refactor: add missing translations in fa.json (@farshidinanloo)

:memo: Documentation

#5471 docs: Add docusaurus-plugin-relative-paths (@ohkimur)

#5464 docs: add mapillary-js to showcase (@oscarlorentzon)

#5433 docs: document doc tags + refinements (@Josh-Cena)

#5435 docs: Add netboot.xyz to site showcase (@antonym)

#5436 docs: add Redocusaurus in community plugin list (@rohit-gohri)

:house: Internal

#5455 fix: website bad version name in docusaurus.config.js (@slorber)

Committers: 10

Alexey Pyltsyn (@lex111)

Ali Saki (@3alisaki)

Antony Messerli (@antonym)

Daniel Costrasel (@ohkimur)

Gabriel Csapo (@gabrielcsapo)

Joshua Chen (@Josh-Cena)

Oscar Lorentzon (@oscarlorentzon)

Rohit Gohri (@rohit-gohri)

Sébastien Lorber (@slorber)

farshid (@farshidinanloo)

Source code(tar.gz)
Source code(zip)
v2.0.0-beta.5(Aug 26, 2021)
2.0.0-beta.5 (2021-08-26)

:rocket: New Feature

docusaurus-init, docusaurus-mdx-loader, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-theme-bootstrap, docusaurus-theme-classic, docusaurus-utils-validation

#5396 feat(plugin-blog): multi-authors support + authors.yml global configuration (@Josh-Cena)

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

#5371 feat: make blog config options and navbar versions dropdown label translatable (@Josh-Cena)

docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-theme-bootstrap, docusaurus-theme-classic, docusaurus-theme-common

#5375 feat: add metatags support for seo / blogposts #5373 (@johnnyreilly)

docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-theme-bootstrap, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-utils-validation, docusaurus-utils

#3646 feat: doc tags (same as blog tags) (@isaac-philip)

docusaurus-plugin-content-blog

#5354 feat(plugin-blog): allow 'ALL' as postsPerPage option value (@Josh-Cena)

docusaurus-theme-classic

#5330 feat: Markdown page-specific head metadatas (@slorber)

#5322 feat: structured data for blog posts (@johnnyreilly)

#5314 feat(v2): add cs (Czech) translations for docusaurus-theme-classic (@michalsanger)

docusaurus-init

#5233 feat: new init template classic-typescript (@Josh-Cena)

docusaurus-mdx-loader, docusaurus-plugin-content-blog, docusaurus-theme-classic

#5309 feat: blog posts support /YYYY/MM/DD/blog-post/index.md pattern + blog frontmatter can reference relative images (@slorber)

docusaurus-mdx-loader, docusaurus

#5299 feat: mdx loader fallback, allow importing mdx docs from anywhere (@slorber)

:boom: Breaking Change

docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-theme-bootstrap, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-utils-validation, docusaurus-utils

#3646 feat: doc tags (same as blog tags) (@isaac-philip)

docusaurus-init, docusaurus-migrate, docusaurus-plugin-content-docs, docusaurus-theme-bootstrap, docusaurus-theme-classic, docusaurus

#5345 refactor: rename Git master branch to main (@zpao)

docusaurus-module-type-aliases, docusaurus-theme-bootstrap, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-theme-live-codeblock, docusaurus-types, docusaurus

#5349 refactor(core): replace useDocusaurusContext().isClient by useIsBrowser() (@slorber)

docusaurus-theme-classic

#5264 fix: apply proper class for active doc item on mobiles + avoid duplicated classes (@lex111)

:bug: Bug Fix

docusaurus-theme-classic

#5425 fix: toc does not highlight clicked anchor + use scroll-margin-top (@slorber)

#5424 refactor: make dynamic authors layout via CSS only (@lex111)

#5422 fix: make tags wrapping properly (@lex111)

#5419 fix: various fixes back-to-top button (@lex111)

#5361 fix: refactor TOC highlighting + handle edge cases (@slorber)

#5357 fix: code blocks should scroll in RTL direction (@slorber)

#5346 fix: author/image adjustments in BlogPosting schema (@lex111)

#5240 fix: remove top margin only from directly first element (@lex111)

#5317 fix: make proper highlighting doc link if no sidebar (@hamzahamidi)

#5316 fix: avoid extra default active class on doc sidebar item (@lex111)

#5319 fix: unbreak highlighting regular navbar links (@lex111)

#5264 fix: apply proper class for active doc item on mobiles + avoid duplicated classes (@lex111)

#5275 fix: improve spanish translation (@faloi)

#5262 fix: show secondary menu if even there is no main one (@lex111)

docusaurus

#5426 fix: Make update-notifier fail-safe if no permission to read configStore (@slorber)

#5398 fix: fix write-translations warning for theme-common translations (@slorber)

#5381 fix: canary releases should ignore notifier updates (@slorber)

#5339 fix: add admonitions support to mdx partials loaded through the fallback mdx loader (@slorber)

#5311 fix: docusaurus serve logs wrong port if 3000 is taken (@wan-nyan-wan)

#5308 fix: remove unexpected whitespaces in CSS bundle (@lex111)

#5268 fix: fix wrong regex that removes extra letters from swizzled component names (@Josh-Cena)

Other

#5399 fix: fix site unlocalized 404 pages + aggressive Netlify /assets caching (@slorber)

#5249 fix: fix Crowdin mapping for pt-BR (@slorber)

docusaurus-theme-classic, docusaurus

#5383 fix: fix Locale Dropdown RTL icon + Webpack aliases ordering (@slorber)

docusaurus-init

#5370 fix(init): fix links to feature images in classic-typescript (@Josh-Cena)

docusaurus-theme-common

#5364 fix: unbreak Details component (@lex111)

#5297 fix: fix constant value import (@Josh-Cena)

docusaurus-plugin-ideal-image

#5334 fix: plugin ideal-image should generate filename with a hash even in development (@Pierre-Gilles)

docusaurus-theme-search-algolia

#5290 fix: make successful build if missing favicon (@lex111)

docusaurus-utils

#5270 fix: ability to link md files with relative paths when paths contain space (@slorber)

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

#5261 fix: fix various TS errors (@Josh-Cena)

:nail_care: Polish

docusaurus-theme-common

#5402 refactor: improve styles of Details component (@lex111)

docusaurus-theme-classic

#5386 refactor: various tags improvements (@lex111)

#5377 refactor: make main heading font size changeable via CSS var (@lex111)

#5355 refactor: add blog microdata in markup instead of use JSON-LD (@lex111)

#5365 refactor(v2): improved Farsi default translations (@massoudmaboudi)

#5280 refactor(v2): improved Farsi default translations (@massoudmaboudi)

Other

#5389 refactor: clean Canny integration + rename 'Feedback' to 'Feature Requests' + improve TS doc page (@slorber)

docusaurus-theme-classic, docusaurus-theme-common

#5242 refactor: reduce ESLint warnings / better typing (@Josh-Cena)

:memo: Documentation

#5423 docs: clarify using custom attributes for navbar link (@lex111)

#5421 docs: add Indent to showcase (@fouad)

#5405 docs: add Gotenberg to showcase (@gulien)

#5406 docs: specify proper min Node.js version for Travis CI example (@BattleOfPlassey)

#5390 docs(v2): showcase BoxyHQ (@deepakprabhakara)

#5376 docs(v2): Update Datagit site to showcase page (@massoudmaboudi)

#5372 docs: remove docusaurus-preset-name from preset doc (@slorber)

#5366 docs: Add drayman to showcase (@jansivans)

#5369 docs(v2): Add Nocalhost website to showcase page (@neaped)

#5351 docs(website): bump announcement bar + include Twitter link + refactor site colors (@slorber)

#5352 docs: update docusaurus-plugin-sass instructions (@erickzhao)

#5332 docs(v2): add mdx-mermaid to resources (@sjwall)

#5331 docs: Changelog page should display TOC with releases (@slorber)

#5329 docs: add Haochen to showcase page (@HaochenQ)

#5313 docs: try to make plugin/preset config less confusing (@slorber)

#5296 docs: update canary doc (@slorber)

#5219 docs: refactor API documentation (@Josh-Cena)

#5271 Add Plausible Analytics docs to showcase page (@metmarkosaric)

#5283 docs: fix broken link to syncing tab choices section (@lex111)

#5259 docs(v2): update Remotion website picture in showcase (@JonnyBurger)

#5260 docs(v2): add Dart Code Metrics site to showcase page (@incendial)

#5253 docs: Fix typo 2-resources.md (@forresst)

#5248 docs(v2): add docusaurus-prince-pdf to resources (@sparanoid)

#5239 docs(v2): Add unmand site to showcase page (@dbseal)

:house: Internal

Other

#5397 chore: rename docusaurus-2-website package + refactor scripts (@slorber)

#5342 chore: fix e2e yarn berry tests (@slorber)

#5328 refactor(website): convert website to TypeScript (@Josh-Cena)

#5336 chore: bump url-parse from 1.5.1 to 1.5.3 (@dependabot[bot])

#5312 fix: fix changelog page mdx import for i18n (@slorber)

#5295 fix: fix canary release versions (@slorber)

#5285 fix: fix canary version names (@slorber)

#5269 misc: enable pt-BR + archive older versions (@slorber)

#5237 chore: enable pt-BR i18n locale on staging (@slorber)

docusaurus-init, docusaurus-migrate, docusaurus-plugin-content-docs, docusaurus-theme-bootstrap, docusaurus-theme-classic, docusaurus

#5345 refactor: rename Git master branch to main (@zpao)

docusaurus-theme-classic, docusaurus-theme-common

#5341 polish: bind key listener to light/dark toggle + a11y lint fixes (@Josh-Cena)

docusaurus-mdx-loader, docusaurus-migrate, docusaurus

#5347 chore(mdx-loader): migrate package to TypeScript (@Josh-Cena)

docusaurus-migrate, docusaurus-module-type-aliases, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-theme-bootstrap, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-types, docusaurus

#5335 refactor: better typing + remove unnecessary eslint-disable (@Josh-Cena)

docusaurus-plugin-content-blog

#5338 refactor(plugin-blog): style improvements in blogUtils (@Josh-Cena)

docusaurus-theme-classic

#5256 chore: upgrade Infima to alpha.30 (@lex111)

docusaurus-init

#5315 refactor(init): share common files between templates (@Josh-Cena)

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

#5284 refactor: properly type docs version (@Josh-Cena)

:running_woman: Performance

docusaurus-module-type-aliases, docusaurus-theme-bootstrap, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-theme-live-codeblock, docusaurus-types, docusaurus

#5349 refactor(core): replace useDocusaurusContext().isClient by useIsBrowser() (@slorber)

Committers: 27

Alexey Pyltsyn (@lex111)

David Seal (@dbseal)

Deepak Prabhakara (@deepakprabhakara)

Dmitry Zhifarsky (@incendial)

Erick Zhao (@erickzhao)

Federico Aloi (@faloi)

Forresst (@forresst)

Fouad Matin (@fouad)

Garry (@neaped)

Hamza Hamidi (@hamzahamidi)

Isaac Philip (@isaac-philip)

John Reilly (@johnnyreilly)

Jonny Burger (@JonnyBurger)

Joshua Chen (@Josh-Cena)

Julien Neuhart (@gulien)

Marko Saric (@metmarkosaric)

Massoud Maboudi (@massoudmaboudi)

Michal Sänger (@michalsanger)

Palash Shrivastava (@BattleOfPlassey)

Paul O’Shannessy (@zpao)

Pierre-Gilles Leymarie (@Pierre-Gilles)

Sam Wall (@sjwall)

Sébastien Lorber (@slorber)

Tunghsiao Liu (@sparanoid)

Yan Ivan Evdokimov (@jansivans)

@HaochenQ

wan-nyan-wan (@wan-nyan-wan)

Source code(tar.gz)
Source code(zip)
v2.0.0-beta.4(Jul 28, 2021)
2.0.0-beta.4 (2021-07-28)

:rocket: New Feature

docusaurus-theme-classic

#4912 feat(v2): add back to top button (@lex111)

docusaurus-init

#5235 feat: docusaurus.new + improve StackBlitz playground integration (@slorber)

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

#5203 feat: docs plugin options sidebarCollapsible + sidebarCollapsed (@Josh-Cena)

docusaurus

#5207 feat: multiple playground choices (@slorber)

docusaurus-plugin-content-docs, docusaurus-theme-bootstrap, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-types, docusaurus

#4273 feat(v2): redesign mobile UX: inline TOC + doc sidebar in main menu (@lex111)

:boom: Breaking Change

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

#5203 feat: docs plugin options sidebarCollapsible + sidebarCollapsed (@Josh-Cena)

docusaurus-mdx-loader, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-utils, docusaurus

#5173 feat(v2): generalize usage of _ prefix convention to exclude content files/folders (@slorber)

docusaurus-plugin-content-docs, docusaurus-theme-bootstrap, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-types, docusaurus

#4273 feat(v2): redesign mobile UX: inline TOC + doc sidebar in main menu (@lex111)

:bug: Bug Fix

docusaurus-plugin-content-blog

#5232 fix(v2): blog should parse frontMatter.date even when time is present (@wenerme)

docusaurus-theme-classic

#5230 fix(v2): remove top margin from first element inside doc article (@lex111)

#5229 fix(v2): keep mobile TOC after hydration (@lex111)

#5179 fix(v2): wrap dropdown item to missing li element + remove extra attributes (@lex111)

#5183 fix(v2): pass all props to CodeBlock component (@lex111)

#5176 fix(v2): Fix type for navlink label (@Josh-Cena)

#5172 fix(v2): hide mobile collapsible doc toc if no headings (@slorber)

#5161 fix(v2): disable default behavior when click on collapsible item (@lex111)

#5151 fix(v2): add missing french translations for mobile (@forresst)

#5104 fix(v2): fix SkipToContent programmatic focus when updating querystring (@slorber)

docusaurus-theme-search-algolia

#5214 fix: upgrade Docsearch to avoid layout shift (@slorber)

#5135 chore(v2): update @docsearch/react (@shortcuts)

docusaurus

#5204 fix: cli upgrade helper fail when no package.dependencies (@mweststrate)

#5164 fix(v2): revert webpack.resolve.symlinks = false (@slorber)

#5126 fix(v2): remove webpackConfig.resolve.symlinks: true (@slorber)

#5110 fix(v2): Fix update-notifier not run at first and not notifying consistently (@slorber)

docusaurus-mdx-loader, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-utils

#5199 fix(v2): Fix MDX docs being considered as partials when siteDir match the _ prefix convention (@slorber)

docusaurus-plugin-pwa

#5185 fix(v2): add base URL to content attribute of head tags PWA (@lex111)

#5169 refactor(v2): automatically add base URL to PWA head tags (@lex111)

docusaurus-mdx-loader, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-utils, docusaurus

#5173 feat(v2): generalize usage of _ prefix convention to exclude content files/folders (@slorber)

docusaurus-theme-common

#5159 fix(v2): Fix Collapsible hydration layout shift (@slorber)

#5146 fix(v2): improve work of useCollapsible hook with multiple clicks (@lex111)

docusaurus-types

#5129 fix(v2): fix d.ts lint error (@slorber)

docusaurus-theme-classic, docusaurus-theme-common

#5116 fix(v2): introduce useCollapsible to fix collapsible animation perf issues (@lex111)

docusaurus-plugin-client-redirects

#5102 fix(v2): fix redirect plugin when trailingSlash=false for .html extension (@slorber)

:nail_care: Polish

docusaurus-theme-classic

#5228 refactor(v2): fix small typo in Russian translation (@antonvasilev52)

#5222 chore(v2): update Infima to alpha 28 (@lex111)

#5224 refactor(v2): update Russian translation (@lex111)

#5217 refactor(v2): improved Farsi default translations (@massoudmaboudi)

#5171 refactor(v2): increase content area if blog sidebar is off (@lex111)

#5154 refactor(v2): Hindi translation for semantic doc sidebar (@pranabdas)

#5145 refactor(v2): use Collapsible for mobile nav items (@lex111)

#5138 refactor(v2): Update Hebrew translations (@nirtamir2)

#5140 refactor(v2): bn translation improvements for semantic doc sidebar (@pranabdas)

#5139 feat(v2): complete Chinese code translations (@Josh-Cena)

#5118 refactor(v2): pt-BR translations improve semantic doc sidebar and tags (@marssaljr)

docusaurus-theme-classic, docusaurus-theme-live-codeblock

#5215 refactor: make code block shadows consistent with new admonitions (@slorber)

docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-theme-classic

#5193 refactor: redesign admonitions/callouts/quotes (@slorber)

docusaurus-theme-classic, docusaurus-theme-common

#5168 refactor(v2): mobile dropdown navbar: expand when subitem become active (@slorber)

:memo: Documentation

#5236 docs: add Verdaccio.org to showcase (@semoal)

#5218 docs(v2): remove vector.dev from showcase (@lex111)

#5212 docs: mention Link can be used for external links (@slorber)

#5210 docs(v2): Elaboration of raw-loader in markdown react component (@pranabdas)

#5191 docs: user should restart docusaurus after adding prism additionalLanguage (@tohidnateghi)

#5175 docs: update API docs on navbar behavior (@Josh-Cena)

#5189 docs(v2): Add orbitjs site to showcase page (@dgeb)

#5177 docs(v2): add easyjwt to users (@dbrrt)

#5187 docs(v2): Add quickwit to user.js and png. (@fmassot)

#5184 docs(v2): Add react-complex-tree to users.js (@lukasbach)

#5178 docs(v2): Update tutorial link (@slorber)

#5158 docs(v2): Update deploy with Qovery docs for V2 (@arnaudjnn)

#5152 docs(v2): Indent code example to improve readability (@rluvaton)

#5133 docs(v2): GIF format is not suported (@NazarStreletskyi)

#5117 docs(v2): Add Prismatic docs page to showcase. (@taylorreece)

#5115 docs(v2): Add LiveKit to showcase (@davidzhao)

#5114 docs(v2): add Blink Shell Documentation to Showcase (@pcho)

#5112 docs(v2): clarify how to disable edit links entirely (@lennartkoopmann)

#5113 docs(v2): Add CryptoDevHub to Showcase (@pmuens)

:house: Internal

docusaurus-theme-classic

#5234 chore: Upgrade infima 29 (@slorber)

#5130 test(v2): dogfooding: add huge sidebar for testing purposes (@slorber)

Other

#5223 chore: fix iframe background color in dark mode (@lex111)

#5206 misc: add script to keep starters branch/repos up-to-date (@slorber)

#5167 fix(v2): fix website PWA icon hrefs (@slorber)

#5166 fix(v2): fix yarn clear command (@slorber)

#5137 chore: upgrade crowdin (@slorber)

#5111 misc: monitor site global data with build size bot (@slorber)

:running_woman: Performance

docusaurus-theme-classic, docusaurus-theme-common

#5136 perf(v2): lazy sidebar categories / collapsibles, reduce html output / build times (@slorber)

docusaurus-theme-classic

#5130 test(v2): dogfooding: add huge sidebar for testing purposes (@slorber)

Committers: 28

Alexey Pyltsyn (@lex111)

Arijit Kundu (@covalentbond)

Arnaud Jeannin (@arnaudjnn)

Christian Flach (@cmfcmf)

Clément Vannicatte (@shortcuts)

Dan Gebhardt (@dgeb)

David Barrat (@dbrrt)

David Zhao (@davidzhao)

Forresst (@forresst)

François Massot (@fmassot)

Joshua Chen (@Josh-Cena)

Lennart Koopmann (@lennartkoopmann)

Lukas Bach (@lukasbach)

Marçal Junior (@marssaljr)

Massoud Maboudi (@massoudmaboudi)

Michel Weststrate (@mweststrate)

Nazar (@NazarStreletskyi)

Philipp Muens (@pmuens)

Pranab Das (@pranabdas)

Przemysław Chojecki (@pcho)

Raz Luvaton (@rluvaton)

Sergio Moreno (@semoal)

Sébastien Lorber (@slorber)

Taylor Reece (@taylorreece)

@antonvasilev52

@nirtamir2

tohid nateghi (@tohidnateghi)

陈杨文 (@wenerme)

Source code(tar.gz)
Source code(zip)
v2.0.0-beta.3(Jun 30, 2021)
2.0.0-beta.3 (2021-06-30)

:rocket: New Feature

docusaurus-theme-classic

#5092 feat(v2): add icon to external footer links (@lex111)

:bug: Bug Fix

docusaurus-theme-classic

#5080 fix(v2): classic theme - semantic correct anchors links (@AuHau)

#5081 fix(v2): restore previous scroll position on back button click (@lex111)

#5063 fix(v2): restore responsive menu (@lex111)

docusaurus

#5094 fix(v2): fix typos in swizzle command (@Josh-Cena)

#5095 fix(v2): fix swizzle readComponent (@slorber)

#5059 fix(v2): fix webpack SSG plugin error thrown due to new URL() / __filename (@slorber)

docusaurus-plugin-content-docs

#5097 fix(v2): fix useEffect infinite loop in blogOnly mode (@slorber)

#5074 fix(v2): allow negative sidebar positions (@kdrag0n)

docusaurus-plugin-client-redirects

#5093 fix(v2): redirect from should work with trailingSlash: true (@slorber)

docusaurus-plugin-client-redirects, docusaurus-utils

#5085 fix(v2): redirect plugin should emit redirect files with lower precedence than redirect target (@slorber)

docusaurus-plugin-client-redirects, docusaurus-plugin-sitemap, docusaurus-types, docusaurus-utils-common, docusaurus

#5082 fix(v2): never remove trailing slash from site root like '/baseUrl/' (@slorber)

docusaurus-plugin-sitemap

#5068 fix(v2): sitemap should respect the global trailingSlash config option. (@taylorreece)

docusaurus-types

#5058 fix(v2): fix bad @docusaurus/types Plugin type generics (@jsamr)

:memo: Documentation

#5064 docs(v2): Rewrite markdown images section (@ramiy)

#5086 docs(v2): Add SQL Frames to the showcase (@dirslashls)

#5073 docs(v2): update installation docs (@iamayushdas)

#5061 docs(v2:) Divide markdown-features/code-blocks to smaller sections (@ramiy)

#5066 docs(v2): correct typo (@bperlmutter)

:house: Internal

docusaurus-types

#5067 chore: unstable yarn.lock (@slorber)

Other

#5057 chore(v2): upgrade examples to beta.2 (@slorber)

Committers: 11

Adam Uhlíř (@AuHau)

Alexey Pyltsyn (@lex111)

Ayush das (@iamayushdas)

Danny Lin (@kdrag0n)

Joshua Chen (@Josh-Cena)

Jules Sam. Randolph (@jsamr)

Rami Yushuvaev (@ramiy)

Sébastien Lorber (@slorber)

Taylor Reece (@taylorreece)

@bperlmutter

@dirslashls

Source code(tar.gz)
Source code(zip)
v2.0.0-beta.2(Jun 24, 2021)
:rocket: New Feature

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

#5052 feat(v2): docs version banner configuration option (@slorber)

docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-types, docusaurus

#5037 feat(v2): plugins injectHtmlTags + configureWebpack should receive content loaded (@slorber)

:boom: Breaking Change

docusaurus-plugin-content-docs

#5053 refactor(v2): remove deprecated docs option excludeNextVersionDocs (@slorber)

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

#5052 feat(v2): docs version banner configuration option (@slorber)

:bug: Bug Fix

docusaurus-plugin-content-blog, docusaurus-types, docusaurus

#5054 fix(v2): allow undefined favicon (@slorber)

docusaurus-plugin-content-docs

#5048 fix(v2): read last update from inner git repositories (@felipecrs)

docusaurus-theme-classic

#5050 fix(v2): add shadow to skip link on focus only (@lex111)

#5035 fix(v2): fix some docs container/sidebar layout issues (@slorber)

docusaurus-mdx-loader, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-plugin-ideal-image, docusaurus-plugin-pwa, docusaurus-types, docusaurus-utils, docusaurus

#5047 fix(v2): Fix Webpack persistent caching (evict on swizzle/alias/config change) (@slorber)

docusaurus-theme-classic, docusaurus-theme-common

#5040 fix(v2): Fix announcementBar layout shifts (@slorber)

docusaurus

#5034 fix(v2): dev css modules classnames should include filename (@slorber)

#5016 fix(v2): add missing quote in build command output (@manuelmeurer)

docusaurus-module-type-aliases, docusaurus-theme-classic, docusaurus-theme-common

#5023 fix(v2): ignore hash changes in useChangeRoute hook (@lex111)

docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-utils-validation

#5032 fix(v2): less strict blog/docs uri frontmatter validation (@slorber)

:nail_care: Polish

docusaurus-plugin-content-docs

#5053 refactor(v2): remove deprecated docs option excludeNextVersionDocs (@slorber)

docusaurus-plugin-content-docs, docusaurus-plugin-ideal-image, docusaurus-theme-bootstrap, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-utils-common, docusaurus-utils-validation, docusaurus-utils, docusaurus

#4993 style(v2): reduce number of ESLint warnings (@Josh-Cena)

Other

#5017 chore(v2): remove badge for v1 tests (@loozhengyuan)

:memo: Documentation

Other

#5049 docs(v2): Fix Gatsby theme name for docs site - Docz (@ramiy)

#5030 docs(v2): typo in deployment.mdx (@eshantri)

#5022 docs(v2): Add React Native Render HTML site to showcase page (@jsamr)

#5027 docs(v2): Add Buddy to deployment doc (@tomekpapiernik)

#5021 docs(v2): fix incorrect anchor links in website (@teikjun)

#5007 docs(v2): wrap mdx usage in mdx-code-block (@slorber)

docusaurus

#5033 docs(v2): GH pages: recommend using trailingSlash (@slorber)

:house: Internal

#5005 chore: add archived versions system + archive alpha.73-75 (@slorber)

Committers: 11

Alexey Pyltsyn (@lex111)

Eshan Tripathi (@eshantri)

Felipe Santos (@felipecrs)

Joshua Chen (@Josh-Cena)

Jules Sam. Randolph (@jsamr)

Manuel Meurer (@manuelmeurer)

Rami Yushuvaev (@ramiy)

Sébastien Lorber (@slorber)

Teik Jun (@teikjun)

Tomasz Papiernik (@tomekpapiernik)

ZhengYuan Loo (@loozhengyuan)

Source code(tar.gz)
Source code(zip)
v2.0.0-beta.1(Jun 18, 2021)
2.0.0-beta.1 (2021-06-18)

:rocket: New Feature

docusaurus-plugin-content-docs

#4982 feat(v2): add docs pagination_label frontmatter (@slorber)

docusaurus-theme-classic

#4949 feat(v2): add icon to external navbar links (@lex111)

#4939 feat(v2): theme default translations Bengali (@Neilblaze)

#4811 feat(v2): Add hebrew translations (@slorber)

#4798 feat(v2): add theme Danish translation (@PsychTechApS)

docusaurus-init

#4968 feat(v2): add code block theming in init template (@Josh-Cena)

docusaurus-theme-classic, docusaurus-types, docusaurus

#4908 feat(v2): add trailingSlash config option (@slorber)

docusaurus-plugin-content-blog, docusaurus-plugin-content-docs

#4796 feat(v2): exhaustive docs frontmatter schema (@nam-hle)

docusaurus-types, docusaurus

#4618 feat(v2): allow config plugins as functions or [function,options] (@besemuna)

docusaurus-plugin-content-blog, docusaurus-utils-validation

#4759 feat(v2): exhaustive BlogPostFrontMatter schema validation (@nam-hle)

:bug: Bug Fix

docusaurus-theme-classic

#5001 chore(v2): update Infima to alpha 26 (@lex111)

#4986 fix(v2): fix UX for docsVersionDropdown on mobile for single version (@slorber)

#4980 fix(v2): make proper data type for prependBaseUrlToHref field (@lex111)

#4943 fix(v2): improve accessibility of code blocks (@lex111)

#4917 fix(v2): tidy up Markdown page layout (@lex111)

#4906 fix(v2): fix minor a11y issues (@lex111)

#4900 fix(v2): adjust margin after content title (@lex111)

#4855 chore(v2): update infima to alpha 24 (@lex111)

#4819 fix(v2): Amend Hebrew translations (@liorheber)

#4815 fix(v2): Fix Hebrew translations (@nirtamir2)

#4792 fix(v2): fix minor a11y issue with headings (@lex111)

#4793 fix(v2): unbreak enhanced width of doc item wrapper (@lex111)

docusaurus-theme-classic, docusaurus-utils-common

#5000 fix(v2): fix theme array deduplication bug (@slorber)

docusaurus-plugin-client-redirects, docusaurus-utils-common, docusaurus-utils, docusaurus

#4988 fix(v2): redirect plugin should use siteConfig.trailingSlash (@slorber)

docusaurus-plugin-content-blog

#4983 fix(v2): always use UTC when dealing with blog dates (@Josh-Cena)

#4962 fix(v2): respect base url in RSS feeds (@lex111)

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

#4985 fix(v2): navbar doc item fallback: search doc in lastVersion (@slorber)

docusaurus-remark-plugin-npm2yarn

#4964 fix(v2): avoid duplicated imports in npm2yarn plugin (@lex111)

docusaurus-plugin-content-docs

#4970 fix(v2): sidebar_label should be used to compute next/previous button labels (@slorber)

#4861 fix(v2): allow relative sidebar path resolution in docs:version command (@lex111)

#4859 fix(v2): use frontmatter title at first for paginated links (@lex111)

#4775 fix(v2): improve dx sidebar config, ability to have no sidebars file (@nam-hle)

docusaurus-plugin-sitemap, docusaurus-utils-common, docusaurus-utils-validation, docusaurus-utils, docusaurus

#4950 fix(v2): sitemap plugin should handle siteConfig.trailingSlash automatically (@slorber)

docusaurus

#4924 fix(v2): respect baseUrl in serving command (@lex111)

#4935 fix(v2): render children in BrowserOnly after client is ready (@lex111)

#4894 fix(v2): escape HTML entities in user tags attributes (@lex111)

#4789 fix(v2): transpile libs with too recent syntax with babel (@slorber)

#4784 fix(v2): update notifier should never suggest to downgrade (@slorber)

docusaurus-mdx-loader, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-theme-classic, docusaurus-utils

#4882 fix(v2): fix contentTitle issues when markdown h1 title contains code blocks (@slorber)

docusaurus-utils

#4862 fix(v2): remove Markdown heading id from excerpt (@lex111)

docusaurus-theme-classic, docusaurus-theme-common

#4871 fix(v2): unbreak adding of custom HTML metadatas (@lex111)

#4797 fix(v2): do not focus on skip link if page refreshed (@lex111)

docusaurus-theme-classic, docusaurus-theme-search-algolia

#4856 fix(v2): adjust padding when custom search box location (@lex111)

docusaurus-theme-classic, docusaurus-theme-common, docusaurus-theme-live-codeblock

#4830 fix(v2): pin prism-react-renderer version to 1.1.1 (@lex111)

docusaurus-plugin-ideal-image, lqip-loader

#4806 chore(v2): update sharp to 0.28.2 (@lex111)

:nail_care: Polish

docusaurus-theme-classic

#4995 refactor(v2): reduce top padding in doc content container (@lex111)

#4918 refactor(v2): readjust footer of blog item (@lex111)

#4959 refactor(v2): minor cleanups (@lex111)

#4945 refactor(v2): remove extra padding from doc item container (@lex111)

#4940 refactor(v2): improve semantic doc sidebar markup (@lex111)

#4961 refactor(v2): improve semantic blog sidebar markup (@lex111)

#4903 refactor(v2): make doc item layout more semantic (@lex111)

#4877 refactor(v2): reduce vertical space in doc content container (@lex111)

#4914 refactor(v2): use SVG for external link icon (@lex111)

#4916 refactor(v2): replace strong with b in UI components (@lex111)

#4926 refactor(v2): hide decorative SVGs from screen readers (@lex111)

#4865 refactor(v2): make little better doc update block UI (@lex111)

#4795 refactor(v2): remove transition on body element (@lex111)

docusaurus-plugin-content-blog, docusaurus-plugin-content-docs

#4989 refactor(v2): blog/docs: add more context in error messages (@slorber)

docusaurus-init, docusaurus-mdx-loader, docusaurus-migrate, docusaurus-plugin-client-redirects, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-google-analytics, docusaurus-plugin-google-gtag, docusaurus-plugin-sitemap, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-utils-validation, docusaurus-utils, docusaurus

#4979 refactor(v2): cleanup console output (@lex111)

docusaurus-utils-validation, docusaurus

#4977 polish(v2): url-subpath config validation warning (@slorber)

docusaurus-plugin-content-docs

#4969 refactor(v2): include path in error about non-existent ids (@lex111)

#4863 refactor(v2): remove sidebar_label filed from doc metadata file (@lex111)

docusaurus-theme-classic, docusaurus

#4907 refactor(v2): remove type attribute from link and script tags (@lex111)

docusaurus-theme-search-algolia

#4919 refactor(v2): improve markup and styling on search page (@lex111)

#4867 chore(v2): update @docsearch/react (@lex111)

docusaurus-plugin-content-blog

#4905 refactor(v2): do not generate RSS files for empty feed (@lex111)

#4860 refactor(v2): use aliased path for blog list sidebar file (@lex111)

docusaurus

#4870 refactor(v2): add exception handling if external command is fails (@lex111)

#4875 refactor(v2): make even better SSR error notify and add tip (@lex111)

#4866 refactor(v2): output URL to console only if it has changed (@lex111)

docusaurus-utils

#4814 refactor(v2): purify normalizeUrl (@nam-hle)

:memo: Documentation

Other

#4987 docs(v2): document canary releases (@slorber)

#4981 docs(v2): minor tweaks (@lex111)

#4976 docs(v2): mention to install the algolia package in search doc (@slorber)

#4953 docs(v2): add Flagsmith to showcase (@dabeeeenster)

#4942 docs(v2): add info about DefaultValue prop in Tabs (@ArtFlag)

#4898 docs(v2): add ClarityChallenge to showcase (@jonbarker68)

#4896 docs(v2): fix incorrect link to plugin-ideal-image (@phwt)

#4893 docs(v2): presets: fix typo in bootstrap preset (@silva-nick)

#4887 docs(v2): Add Aide Jeune website to Docusaurus site showcase (@l0u1sg)

#4821 docs(v2): New doc page for math equations (@pranabdas)

#4885 docs(v2): v2 migration guide: mention Algolia config update (@slorber)

#4876 docs(v2): update steps in the github-actions section (@wise-introvert)

#4880 docs(v2): grammar typo in migration-overview.md (@jmazin)

#4879 docs(v2): Added FireCMS to the showcase (@fgatti675)

#4849 docs(v2): fix Java syntax highlight in website (@Josh-Cena)

#4818 docs(v2): add mr-pdf to resources (@antonygibbs)

#4835 docs(v2): fix grammar typo on Creating pages (@Christopher-Hsieh)

#4837 docs(v2): fix missing closing bracket (@pmqueiroz)

#4820 docs(v2): Fix typo in doc: sidebar.md (@pranabdas)

#4813 docs(v2): fix css snipped with missing color (@slorber)

#4803 docs(v2): Add i18n tag and fix typo (@HunteRoi)

#4786 docs(v2): Add tinaeldevresse.eu to Docusaurus' gallery (@HunteRoi)

#4780 docs(v2): remove docs for alpha 71 + 72 (@slorber)

#4779 docs(v2): beta blog post edits (@slorber)

docusaurus-init

#4973 docs(v2): replace diff codeblocks with line highlight (@Josh-Cena)

#4756 docs(v2): Docusaurus 2 beta blog post (@slorber)

:house: Internal

Other

#4994 misc: more issue template improvements (@slorber)

#4951 misc: disable google-gtag plugin in Netlify deploys (@lex111)

#4901 misc: optimize showcase images (@lex111)

#4897 chore: fail CI if yarn.lock is modified on install (@slorber)

#4858 chore(v2): add external link to community sidebar (@lex111)

#4889 misc: issue template config typo (@slorber)

#4886 misc: add github issue template config (@slorber)

#4878 misc: improve bug report issue template (@lex111)

#4791 chore: fix canary version name (@slorber)

#4777 chore: regenerate examples on 2.0.0-beta.0 (@slorber)

docusaurus-init, docusaurus-migrate, docusaurus

#4944 chore: lockfile cleanup (@slorber)

docusaurus-1.x, docusaurus-init-1.x

#4902 chore: remove docusaurus v1 from master branch (moved to docusaurus-v1 branch) (@slorber)

docusaurus-plugin-ideal-image

#4915 chore(v2): bump react-waypoint from 9.0.2 to 10.1.0 (@lex111)

docusaurus-theme-classic, docusaurus-theme-common, docusaurus-theme-live-codeblock

#4834 chore(v2): unlock prism-react-renderer version (@lex111)

docusaurus-cssnano-preset, docusaurus

#4833 chore(v2): bump cssnano packages (@lex111)

docusaurus-cssnano-preset, docusaurus-init, docusaurus-mdx-loader, docusaurus-migrate, docusaurus-plugin-client-redirects, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-debug, docusaurus-plugin-sitemap, docusaurus-theme-classic, docusaurus-types, docusaurus-utils-validation, docusaurus-utils, docusaurus

#4816 chore(v2): upgrade dependencies (@lex111)

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

#4790 chore(v2): TypeScript, use isolatedModules (@slorber)

Committers: 31

Alexey Pyltsyn (@lex111)

Arthur (@ArtFlag)

Ben Rometsch (@dabeeeenster)

Christopher Hsieh (@Christopher-Hsieh)

Fardeen Panjwani (@wise-introvert)

Joel (@Joelpo)

Jon Barker (@jonbarker68)

Jonathan Mazin (@jmazin)

Joshua Chen (@Josh-Cena)

Lior Heber (@liorheber)

Louis Gallet (@l0u1sg)

Louis Grenard (@louistiti)

Lucas Correia (@tsirlucas)

Nam Hoang Le (@nam-hle)

Pablo Vidal (@limkinZero)

Pedro Queiroz (@pmqueiroz)

Pranab Das (@pranabdas)

Pratyay Banerjee (@Neilblaze)

PsychTech (@PsychTechApS)

Sam Zhou (@SamChou19815)

Sébastien Lorber (@slorber)

Tinaël Devresse (@HunteRoi)

@Massibian

@antonygibbs

@besemuna

@e271828-

@fgatti675

@nirtamir2

@silva-nick

mg (@tiny-dancer)

phwt.smwt (@phwt)

Source code(tar.gz)
Source code(zip)
v2.0.0-beta.0(May 12, 2021)
2.0.0-beta.0 (2021-05-12)

Read the 2.0.0 beta blog post!

Note: this first beta release does not contain any new major feature. We are removing the alpha label, as we are confident Docusaurus 2 is stable enough.

:rocket: New Feature

docusaurus-theme-classic

#4762 feat(v2): add es translations for docusaurus-theme-classic (@rodmoreno)

:bug: Bug Fix

docusaurus-theme-classic

#4750 fix(v2): improve french translation for theme-classic (@forresst)

docusaurus-mdx-loader, docusaurus-utils

#4736 fix(v2): fix encoding of markdown image/file inline file-loaders (@slorber)

docusaurus-utils

#4735 fix(v2): markdown title parser should ignore all forms of MDX import statements (@nam-hle)

#4729 fix(v2): optimize markdown parser regex (Closes #4726) (@nam-hle)

:memo: Documentation

#4770 docs(v2): Improve intro doc (@slorber)

#4773 docs(v2): fix i18n doc: bad i18n page plugin path in code sample (@KostyaTretyak)

#4758 docs(v2): add browsers support documentation (@Josh-Cena)

#4757 docs(v2): Add Netdata to showcase (@joelhans)

#4754 docs(v2): fix Jest showcase screenshot (@slorber)

#4747 docs(v2): Update showcase page (@slorber)

#4734 docs(v2): Added MediaMachine.io to showcase (@gianu)

#4731 docs(v2): add CodeYourFuture to showcase (@ChrisOwen101)

#4703 docs(v2): specify google-analytics and gtag plugins (@yiliansource)

#4727 docs(v2): fix doc lint (@slorber)

#4725 docs(v2): emphasize subset of markdown supported languages (@Josh-Cena)

#4711 docs(v2): showcase personal site evantay (@DigiPie)

:house: Internal

#4746 chore(v2): attempt to fix crowdin dl again (@slorber)

#4743 chore(v2): fix prod deployment due to bad image path (@slorber)

#4740 chore(v2): delay i18n-staging deployment to avoid Crowdin 409 errors (@slorber)

#4739 chore(v2): Fix Crowdin 409 issues in CI (@slorber)

Committers: 11

Chris Owen (@ChrisOwen101)

Evan (@DigiPie)

Forresst (@forresst)

Ian Hornik (@yiliansource)

Joel Hans (@joelhans)

Joshua Chen (@Josh-Cena)

Nam Hoang Le (@nam-hle)

Rodrigo Moreno (@rodmoreno)

Sergio Rafael Gianazza (@gianu)

Sébastien Lorber (@slorber)

Костя Третяк (@KostyaTretyak)

2.0.0-alpha.75 (2021-04-30)

:boom: Breaking Change

docusaurus-cssnano-preset, docusaurus-init, docusaurus-mdx-loader, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-plugin-ideal-image, docusaurus-plugin-pwa, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-types, docusaurus, lqip-loader

#4089 feat(v2): Webpack 5, PostCSS 8 (@RDIL)

:memo: Documentation

#4704 docs(v2): showcase meli (@gempain)

#4699 docs(v2): Add Kosko to showcase (@tommy351)

Committers: 4

Geoffroy Empain (@gempain)

Reece Dunham (@RDIL)

Sébastien Lorber (@slorber)

Tommy Chen (@tommy351)

Source code(tar.gz)
Source code(zip)
v2.0.0-alpha.75(Apr 30, 2021)
2.0.0-alpha.75 (2021-04-30)

:boom: Breaking Change

docusaurus-cssnano-preset, docusaurus-init, docusaurus-mdx-loader, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-plugin-ideal-image, docusaurus-plugin-pwa, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-types, docusaurus, lqip-loader

#4089 feat(v2): Webpack 5, PostCSS 8 (@RDIL)

:memo: Documentation

#4704 docs(v2): showcase meli (@gempain)

#4699 docs(v2): Add Kosko to showcase (@tommy351)

Committers: 4

Geoffroy Empain (@gempain)

Reece Dunham (@RDIL)

Sébastien Lorber (@slorber)

Tommy Chen (@tommy351)

Source code(tar.gz)
Source code(zip)
v2.0.0-alpha.74(Apr 27, 2021)
2.0.0-alpha.74 (2021-04-27)

:rocket: New Feature

Other

#4515 feat(v2): add tag filters to showcase page (@lisa761)

docusaurus-plugin-content-docs

#4658 feat(v2): allow user to customize/enhance the default sidebar items generator (@slorber)

#4655 feat(v2): docs, make numberPrefixParser configurable, better defaults, minor breaking-changes (@slorber)

:bug: Bug Fix

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

#4688 fix(v2): fix title logic (meta vs heading) + ignore fixed anchor id syntax (@slorber)

docusaurus-theme-classic

#4689 chore(v2): update infima to alpha 23 (@slorber)

#4667 fix(v2): Unbreak blog post title by handling title fallback in LayoutHead (@SamChou19815)

docusaurus-plugin-content-docs

#4687 fix(v2): accept empty/null custom_edit_url docs frontmatter for retrocompat (@slorber)

#4651 fix(v2): sidebar autogen from subfolder should read category metadata correctly (@slorber)

#4629 fix(v2): fix validation rejecting admonitions false (@kazk)

docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-utils-validation

#4654 fix(v2): fix too strict markdown frontmatter validation (@johnnyreilly)

docusaurus-utils

#4646 fix(v2): ignore imports when h1 heading parsing (@lex111)

#4641 fix(v2): parse headings directly after h1 properly (@lex111)

:nail_care: Polish

docusaurus-theme-classic

#4682 refactor(v2): align external icon on right (@lex111)

:memo: Documentation

#4496 docs(v2): Add Qovery to deployment doc (@arnaudjnn)

#4680 docs(v2): Fix urls in deployment.md (@luism3861)

#4668 docs(v2): Add Hostman to deployment doc (@alena-ko)

#4676 docs(v2): Add Daily Digest - COVID-19 IN FRANCE to showcase (@MisterFISHUP)

#4643 docs(v2): Fix typo in installation.md (@react-learner)

#4649 docs(v2): Add new showcase user (@JeremyDolle)

:house: Internal

Other

#4670 chore: add some redirects to v1.docusaurus.io (@slorber)

docusaurus-init

#4631 chore(v2): update examples to use alpha73 (@slorber)

Committers: 12

Alexey Pyltsyn (@lex111)

Arnaud Jeannin (@arnaudjnn)

DOLLE (@JeremyDolle)

John Reilly (@johnnyreilly)

Lisa Chandra (@lisa761)

Luis Medina Huerta (@luism3861)

Sam Zhou (@SamChou19815)

Sébastien Lorber (@slorber)

Tommy (@react-learner)

@MisterFISHUP

@alena-ko

kazk (@kazk)

Source code(tar.gz)
Source code(zip)

Owner

Facebook

We are working to build community through open source technology. NB: members must have two-factor auth.

GitHub https://docusaurus.io

Tina is an open source editor that brings visual editing into React websites. Tina empowers developers to give their teams a contextual and intuitive editing experience without sacrificing code quality.

Tina is an open-source toolkit for building content management directly into your website. Community Forum Getting Started Checkout the tutorial to ge

8.2k Jan 1, 2023

TryShape is an open-source platform to create shapes of your choice using a simple, easy-to-use interface. You can create banners, circles, polygonal shapes, export them as SVG, PNG, and even as CSS.

Create, Export, Share, and Use any Shapes of your choice. View Demo · Report Bug · Request Feature ?? Introducing TryShape TryShape is an opensource p

148 Dec 26, 2022

Build blazing fast, modern apps and websites with React

Gatsby v3 ⚛️ ?? ?? Fast in every way that matters Gatsby is a free and open source framework based on React that helps developers build blazing fast w

54k Jan 9, 2023

Recipe websites have too much clutter, this scrapes just the recipe

Only The Recipe Most recipes websites have videos and ads flying everywhere, on top of walls of text describing the recipe's backstory. This is an eas

46 Dec 28, 2022

CoWIN Vaccination Tracker, Below is the PRODUCTION LINK this is updated at end of each day. To see any latest Updates, please check the documentation

CoWIN Vaccination Slots Checking App. CoWIN Vaccination Slots Checking App is a user-friendly website that allow users to find vaccine in nearby avail

31 Jan 28, 2022

This simple tic-tac-toe game is created by following the react documentation. and there's some modifications on it.

Getting Started with Create React App This project was bootstrapped with Create React App. Available Scripts In the project directory, you can run: np

1 Dec 29, 2022

Documentation website of NextCitizens.

NextCitizens Documentation NextCitizens is a powerful and optimized core for your FiveM server based on RolePlay. Installation $ yarn Local Developme

9 Jul 19, 2022

Open source, production-ready animation and gesture library for React

An open source and production-ready motion library for React on the web. Framer Motion is an open source, production-ready library that's designed for

17.2k Jan 9, 2023

Open-source project which generates the Fortnite Item Shop in an image similar to the in-game design.

Fort-Shop Fort-Shop is a unique project which generates the current Fortnite Item Shop into a stylized image, similar to the new In-Game design (refer

25 Jan 5, 2023

Open-source website for the 4C

4c Repository for the 4c.rocks webiste. The Cool Community For Content Creators or 4c, is a community to connect with other like-minded creators, coll

139 Jan 4, 2023

A collection of free logos for open source projects

Libre Logos Libre Logos is a library of free logos. The logos are intended for open source projects and NGOs. Designers are invited to contribute. The

144 Nov 11, 2022

Free Open Source High Quality Dashboard based on Bootstrap 4 & React 16: http://dashboards.webkom.co/react/airframe

Airframe React High Quality Dashboard / Admin / Analytics template that works great on any smartphone, tablet or desktop. Available as Open Source as

6 Jun 5, 2022

This web application aim to produce an contest notifier utility and a modern open-source compiler.

This web application aim to produce an contest notifier utility and a modern open-source compiler. The current features of the application include : Code Runner , Upcoming and Ongoing Contests.

6 Dec 3, 2022

Your toolkit for financially sustainable open source development

Your toolkit for financially sustainable open source development. Getting Started · Why? · Plans · Documentation · Contributing Description Open sourc

4 Feb 12, 2022

Open Source Website where you can manage your information and artworks of your fursona(s)

MyFursona About this project MyFursona is an open source project where users can manage their artworks, info (such as biography and interests), and lo

23 Jan 7, 2023

Official website for the Open source community of DCRUST written in NextJS.

This is a Next.js project bootstrapped with create-next-app. Getting Started First, run the development server: npm run dev # or yarn dev Open http://

2 Apr 9, 2022

Scratch Incubator hosts a number of interesting, open-source, and arguably useful experiments and tools.

This is a Next.js project bootstrapped with create-next-app. Getting Started First, run the development server: npm run dev # or yarn dev Open http://

6 Jul 6, 2022

Webpack is an open-source JavaScript module bundler. This includes basic setup files to help me not redo all the setups for webpack when starting a new project.

Webpack Setup Webpack is an open-source JavaScript module bundler. It is made primarily for JavaScript, but it can transform front-end assets such as

14 Jun 23, 2022

JSON Hero is an open-source, beautiful JSON explorer for the web that lets you browse, search and navigate your JSON files at speed. 🚀

JSON Hero makes reading and understand JSON files easy by giving you a clean and beautiful UI packed with extra features.

7.2k Jan 9, 2023

Easy to maintain open source documentation websites.

Related tags

Overview

Docusaurus

Introduction

Installation

Contributing

Contributing guide

Beginner-friendly bugs

Contact

Contributors

Backers

Sponsors

License

Special thanks

Comments

Instructions

Pre-Migration

Migration

Post-Migration

Thank You!

Is this a bug report?

Have you read the [Contributing Guidelines on issues]

Environment

Steps to Reproduce

Expected Behavior

Actual Behavior

Reproducible Demo

Request new feature

🚀 Feature

Have you read the Contributing Guidelines on issues?

Motivation

Pitch

Changes

Motivation

Have you read the Contributing Guidelines on pull requests?

Test Plan

Loading Offline

Installing as a Chrome App

Open app in chrome://apps

Lighthouse Audit

Update Popup

Related PRs

📚 Documentation

Have you read the Contributing Guidelines on issues?

Have you read the Contributing Guidelines on issues?

Prerequisites

Description

Reproducible demo

Steps to reproduce

Expected behavior

Actual behavior

Your environment

Self-service

Update 03/19/19

D2 Design Principles

D1 Problems and Proposed Solutions

Infra

HTML/CSS

JavaScript

API

Blog

Markdown

Search

🐛 Bug Report

Have you read the Contributing Guidelines on issues?

To Reproduce

Expected behavior

Actual Behavior

Your Environment

Motivation

Have you read the Contributing Guidelines on pull requests?

Test Plan

Context

Features

User experience (UX)

Modal search

Mobile experience

Recent searches

Favorite searches

Open app in `chrome://apps`

Example of a mapping file (`i18n/<locale>/slugs.json`)