docusaurus-plugin-content-docs,docusaurus-theme-classicdocusaurus-plugin-debug,docusaurus-preset-classic- #2928 feat(v2): Implement proof-of-concept Docusaurus Debug Dashboard (@SamChou19815)
docusaurus-init,docusaurus- #2903 feat(v2): Allow configuring babel via babel.config.js (@SamChou19815)
docusaurus-plugin-client-redirects,docusaurus-utilsdocusaurus-theme-live-codeblockdocusaurus-theme-classic,docusaurusdocusaurus-theme-classic- #2841 feat(v2): Allow swizzling prism-include-languages in theme-classic (@SamChou19815)
docusaurus-init,docusaurus-theme-classic,docusaurus-theme-live-codeblock,docusaurus-theme-search-algolia,docusaurusdocusaurus-plugin-content-docsdocusaurus-plugin-content-docs,docusaurus-theme-classic
docusaurus-plugin-content-docs,docusaurus-theme-bootstrap,docusaurus-theme-classicdocusaurus-theme-classic- #2932 fix(v2): Add hooks to detect window resize, toggle off sidebar and navbar in desktop (@guillaumejacquart)
- #2909 fix(v2): adjust anchor offset when routes switched (@lex111)
- #2896 fix(v2): set correct canonical url for docs home page (@lex111)
- #2893 fix(v2): Do not automatically change tab when a non-existing option is selected (@SamChou19815)
- #2888 fix(v2): restore styles for menu scrollbar (@lex111)
- #2857 fix(v2): treat inline code in raw HTML as native element (@lex111)
docusaurus- #2951 fix(v2): Add optional-chaining and nullish-coalescing babel plugin (@SamChou19815)
- #2921 fix(v2): upgrade react-loadable-ssr-addon (@slorber)
- #2854 fix(v2): fix broken build when swizzled NotFound component exist (@lex111)
- #2829 fix(v2): Fix plugin path resolution (@SamChou19815)
docusaurus-preset-classic- #2944 fix(v2): Declare @docusaurus-plugin-debug as dependency of preset classic (@SamChou19815)
docusaurus-initdocusaurus-theme-bootstrap- Other
docusaurus-plugin-content-docsdocusaurus-plugin-content-docs,docusaurus-theme-classicdocusaurus-theme-search-algoliadocusaurus-utilsdocusaurus-theme-live-codeblock
docusaurus-plugin-content-blog,docusaurus-plugin-content-docs,docusaurus-theme-classic,docusaurus-utils,docusaurusdocusaurus-theme-classic- #2870 refactor(v2): combine nested theme providers into one (@lex111)
- #2880 fix(v2): render as regular text uncollapsible categories (@lex111)
- #2864 refactor(v2): add aria role for doc sidebar (@lex111)
- #2859 refactor(v2): add aria label to paginators (@lex111)
- #2858 refactor(v2): add missing main landmark for needed pages (@lex111)
- Other
- #2862 Updated banner in solidarity (@JoelMarcey)
- #2946 docs(v2): add require.resolve to plugin imports on remaining pages (@teikjun)
- #2941 docs(v2): wrap all plugin imports in require.resolve() (@TomBrien)
- #2934 docs(v2): add useThemeContext note (@Drewbi)
- #2935 docs(v2): Add router implementation note (@Drewbi)
- #2933 docs(v2): add documentation for multiple blogs (@teikjun)
- #2910 docs(v2): fix GitHub action workflow in docs (@anshulrgoyal)
- #2886 docs(v2): fix typo in command on installation page (@pglezen)
- #2887 docs(v2): make .nojekyll warning more obvious (@yangshun)
- #2865 docs(v2): description field in frontmatter of blog post (@lex111)
- #2839 docs(v2): _index docs page does not show a sidebar (@aeneasr)
- #2852 misc: move runme demo in block quote about v2 (@lex111)
- #2842 docs(v2): Update ZEIT to Vercel (@Nishikoh)
docusaurus-plugin-content-blog,docusaurus-plugin-content-docsdocusaurus-init,docusaurus-plugin-client-redirects,docusaurus-plugin-content-blog,docusaurus-plugin-content-docs,docusaurus-plugin-content-pages,docusaurus-plugin-ideal-image,docusaurus-plugin-sitemap,docusaurus-utils,docusaurus- Other
- #2929 chore(v2): Run E2E tests in CI (@SamChou19815)
- #2899 chore(deps): bump websocket-extensions from 0.1.3 to 0.1.4 (@dependabot[bot])
- #2897 refactor(v2): synchronize yarn/npm command on site (@lex111)
docusaurus-theme-bootstrapdocusaurus-1.x,docusaurus-plugin-content-docsdocusaurus-theme-classic
docusaurus-plugin-content-blog,docusaurus-plugin-sitemap- #2936 perf(v2): convert synchronous filewrite to asynchronous (@moonrailgun)
docusaurus-theme-classic,docusaurus-theme-live-codeblockdocusaurus-init,docusaurus-theme-classic,docusaurus-theme-live-codeblock,docusaurus-theme-search-algolia,docusaurus
- Alexey Pyltsyn (@lex111)
- Anshul Goyal (@anshulrgoyal)
- Drew Alexander (@Drewbi)
- Fanny (@fanny)
- Guillaume Jacquart (@guillaumejacquart)
- Joe Previte (@jsjoeio)
- Joel Marcey (@JoelMarcey)
- Koki Nishihara (@Nishikoh)
- Paul Glezen (@pglezen)
- Sam Zhou (@SamChou19815)
- Sébastien Lorber (@slorber)
- Teik Jun (@teikjun)
- Tom Brien (@TomBrien)
- Yangshun Tay (@yangshun)
- @belokonm
- hackerman (@aeneasr)
- moonrailgun (@moonrailgun)
- tetunori (@tetunori)
Bad release, check ## 2.0.0-alpha.58
- If you refer to modules (plugins) in your config file in a string form, you will need to replace them with
require.resolvecalls, for example:
- plugins: ['@docusaurus/plugin-google-analytics']
+ plugins: [require.resolve('@docusaurus/plugin-google-analytics')]docusaurus-theme-classicdocusaurus-theme-classic,docusaurus-theme-search-algoliadocusaurus- #2780 feat(v2): open external links in new tab by default (@jknoxville)
docusaurus-types,docusaurusdocusaurus-theme-classic
docusaurus-theme-classicdocusaurus- #2788 fix(v2): use
require.resolvefor all webpack presets and plugins (@SamChou19815)
- #2788 fix(v2): use
docusaurus-plugin-content-docs
docusaurus-theme-classicdocusaurus-theme-search-algoliadocusaurus-initdocusaurus-theme-classic,docusaurus-theme-search-algoliadocusaurus
- Alexey Pyltsyn (@lex111)
- James McShane (@jmcshane)
- John Knox (@jknoxville)
- Kasper Bøgebjerg Pedersen (@kasperp)
- Muhammad Ali (@mrmuhammadali)
- Piotr Baran (@piotros)
- Sam Zhou (@SamChou19815)
- Sylvain Pace (@s-pace)
-
infima-
The following Infima classes have been renamed for consistency:
page-item→pagination__itempagination-nav__link--label→pagination-nav__labelpagination-nav__link--sublabel→pagination-nav__sublabeltab-item→tabs__itemtab-item--active→tabs__item--active
If you have swizzled components, you need to replace these class names.
-
-
docusaurus
docusaurusdocusaurus-theme-classic- #2690 feat(v2): allow activeBaseTest in NavLink (@nebrelbug)
- #2694 feat(v2): add canonical URL to
<head>(@jcomack)
docusaurus-plugin-content-docs,docusaurus-theme-classic,docusaurus-types,docusaurusdocusaurus-plugin-content-docs,docusaurus-theme-search-algolia,docusaurus
docusaurus-plugin-content-docs,docusaurus-utilsdocusaurus-theme-classicdocusaurus-theme-search-algolialqip-loaderdocusaurus-init
docusaurus-theme-classicdocusaurus-theme-live-codeblockdocusaurus-theme-search-algoliadocusaurus-theme-bootstrap,docusaurus-theme-classicdocusaurus-utils
- #2768 docs(v2): various improvements (@lex111)
- #2670 docs(v2): add deployment workflow manual for GitHub Actions (@artemkovalyov)
docusaurus-theme-classic,docusaurus-theme-live-codeblock,docusaurus
docusaurus- #2684 refactor(v2): replace EJS with Eta for SSR generation (@nebrelbug)
- Alexey Pyltsyn (@lex111)
- Artem Kovalov (@artemkovalyov)
- Ben Gubler (@nebrelbug)
- Fanny (@fanny)
- Jimmy (@jcomack)
- Jonny Nabors (@jonnynabors)
- Julien Deniau (@jdeniau)
- Marco Moretti (@marcosvega91)
- Rajiv Singh (@iamrajiv)
- Sébastien Lorber (@slorber)
- Taylor Reece (@taylorreece)
- Yamagishi Kazutoshi (@ykzts)
- Yangshun Tay (@yangshun)
HOTFIX for 2.0.0-alpha.53.
docusaurus-theme-classicdocusaurus-module-type-aliases- #2687 fix(v2): Add all webpack module aliases to type declaration file (@SamChou19815)
- Alexey Pyltsyn (@lex111)
- Joe Previte (@jsjoeio)
- Sam Zhou (@SamChou19815)
HOTFIX for 2.0.0-alpha.51.
- Alexey Pyltsyn (@lex111)
infima- The following infima variables have been renamed for consistency:
--ifm-font-base-color→--ifm-font-color-base--ifm-font-base-color-inverse→--ifm-font-color-base-inverse--ifm-font-color-secondary→--ifm-font-color-secondary
- The following infima variables have been renamed for consistency:
docusaurus-theme-classicdocusaurusdocusaurus-types,docusaurusdocusaurus-initdocusaurus-plugin-content-blog,docusaurus-plugin-content-docs,docusaurus-theme-classic,docusaurus-utilsdocusaurus-plugin-content-blog,docusaurus-theme-classic- #2531 feat(v2): add blog post estimated reading time (@JoseRenan)
docusaurus-theme-classic- #2672 fix(v2): add a11y support for dropdown (@lex111)
- #2649 fix(v2): hide sidebar after click on child item (@lex111)
- #2631 fix(v2): hide doc sidebar on mobiles (@lex111)
- #2626 fix(v2): make border right of doc sidebar equals doc page (@lex111)
- #2625 fix(v2): disable tab focus on collapsed doc sidebar items (@lex111)
- #2602 fix(v2): inherit color for announcement bar close icon (@lex111)
- #2582 fix(v2): remove horizontal scroll on docs page (@lex111)
docusaurus-theme-classic,docusaurus-theme-live-codeblockdocusaurus-1.x,docusaurus-init-1.x,docusaurus-init,docusaurus-plugin-content-docs,docusaurusdocusaurus-plugin-content-blog,docusaurus-plugin-content-docs,docusaurus-preset-classic,docusaurus-theme-classicdocusaurus-utilsdocusaurus-plugin-sitemap- #2616 fix(v2): don't include 404 page in sitemaps (@RDIL)
- #2530 fix(v2): Use
writeFileSyncto write generated sitemap.xml to avoid early termination (@SamChou19815)
docusaurusdocusaurus-plugin-content-blog
docusaurus-theme-classic- #2656 refactor(v2): lose focus of active sidebar item after click on it (@lex111)
- #2627 refactor(v2): extract scroll position detection into separate hook (@lex111)
- #2595 refactor(v2): make margin top on blog pages as on other pages (@lex111)
- #2588 refactor(v2): remove redundant container on docs page (@lex111)
docusaurus-theme-classic,docusaurusdocusaurusdocusaurus-theme-classic,docusaurus-theme-live-codeblockdocusaurus-plugin-content-docs
- #2659 fix(docs): mention that appID is optional (@s-pace)
- #2596 docs(v2): remove duplicated package.json in installation directory structure (@jaylees14)
- #2572 docs(v2): mention that
plugin-ideal-imageonly perform compression on a production build (@Noah-Silvera) - #2570 docs(v2): fix syntax error for @docusaurus/plugin-ideal-image example (@Noah-Silvera)
- #2566 docs(v2): be more polite (@lex111)
- #2559 doc(v2): remove legacy blog metadata (@RDIL)
- #2549 docs(v2): command for swizzling all components (@fanny)
- #2547 docs(v2): Fix typo in team page (@SamChou19815)
- #2545 docs(v2): add community pages (@yangshun)
- #2521 docs(v2): useThemeContext hook (@lex111)
docusaurus-types,docusaurus- #2578 refactor(v2): Convert docusaurus-core to TypeScript (@SamChou19815)
- Other
docusaurus-1.x,lqip-loaderlqip-loaderdocusaurus-plugin-ideal-image,lqip-loaderdocusaurus-initdocusaurus-1.x,docusaurus-init,docusaurus-mdx-loader,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-sitemap,docusaurus-preset-classic,docusaurus-theme-classic,docusaurus-theme-live-codeblock,docusaurus-theme-search-algolia,docusaurus-utils,docusaurus,stylelint-copyrightdocusaurus-utilsdocusaurus
- Alexey Pyltsyn (@lex111)
- Anayo Oleru (@AnayoOleru)
- Bartosz Kaszubowski (@Simek)
- Chris Watson (@watzon)
- Fanny (@fanny)
- Jay Lees (@jaylees14)
- Joe Previte (@jsjoeio)
- José Renan (@JoseRenan)
- Kamil Kisiela (@kamilkisiela)
- Kristóf Poduszló (@kripod)
- Mehmet Yatkı (@yatki)
- Noah Silvera (@Noah-Silvera)
- Reece Dunham (@RDIL)
- Sam Zhou (@SamChou19815)
- Sylvain Pace (@s-pace)
- Sébastien Lorber (@slorber)
- Tom Brien (@TomBrien)
- Yangshun Tay (@yangshun)
HOTFIX for 2.0.0-alpha.49.
docusaurus-theme-classic,docusaurus-theme-live-codeblockdocusaurus-theme-classicdocusaurusdocusaurus-utils- #2497 fix(v2): unbreak blog-only mode routing by deplicating starting forward slashes (@SamChou19815)
docusaurus-theme-classicdocusaurus-theme-classic,docusaurus-theme-live-codeblockdocusaurus-plugin-content-docs,docusaurus
- Alexey Pyltsyn (@lex111)
- Can Gencer (@cangencer)
- Richard Chan (@iWun)
- Sam Zhou (@SamChou19815)
- Yangshun Tay (@yangshun)
docusaurus-theme-classic- #2487 feat(v2): nav dropdown (@yangshun)
- #2456 feat(v2): support comments for code highlighting (@elviswolcott)
- #2330 feat(v2): add announcement bar (@lex111)
- #2440 feat(v2): make clickable sidebar logo (@lex111)
- #2366 feat(v2): support syncing tab choices (@SamChou19815)
docusaurus- #2323 feat(v2): add a way to exclude components from build-time prerendering (@lex111)
- #2469 feat(v2): add TypeScript support for theme components (@SamChou19815)
- #2455 feat(v2): add @theme-original alias to give access to pre-swizzled components (@yangshun)
- #2438 feat(v2): add version to page's generated meta tags (@lex111)
docusaurus-types,docusaurusdocusaurus-theme-classic,docusaurus-theme-live-codeblock- #2346 feat(v2): add filename in CodeBlock (@KohheePeace)
docusaurus-plugin-content-docs,docusaurus
docusaurus-theme-classic- #2483 fix(v2): do not render sidebar logo if used sticky navbar (@lex111)
- #2475 fix(v2): make correct Open Graph title for doc page (@lex111)
- #2436 fix(v2): update twitter:card to summary_large_image (@lex111)
- #2434 fix(v2): add support dark logo for sidebar logo (@lex111)
- #2420 fix(v2): fix external URL for og:image tag (@38elements)
docusaurus-theme-live-codeblockdocusaurus-mdx-loader,docusaurus-theme-classicdocusaurus-theme-classic,docusaurus-theme-live-codeblockdocusaurus-preset-classic,docusaurus-theme-classicdocusaurus- #2462 fix(v2): do not force terminate building when bundle analyzer is on (@lex111)
- #2393 fix(v2): normalize location for route matching (@rlamana)
- #2443 fix(v2): always exit after successful build (@mohrash92)
- #2437 fix(v2): do not force terminate building if client bundle failed in development mode (@lex111)
- #2424 fix(v2): make correct internal link check (@lex111)
docusaurus-preset-classic- #2451 fix(v2): pass options to remark-admonitions (@elviswolcott)
docusaurus-mdx-loaderdocusaurus-utils
docusaurus-theme-classicdocusaurus-plugin-content-blog- Other
- #2428 polish(v2): use npm-to-yarn for the npm2yarn remark plugin (@nebrelbug)
- Other
- #2478 docs(v2): mark that in dev server some features may not work (@lex111)
- #2472 docs(v2): fix typo in deployment docs (@GermaVinsmoke)
- #2423 docs(v2): add Sass/SCSS under the styling section (@rlamana)
- #2446 docs(v2): add docusaurus-plugin-sass to community plugins (@rlamana)
- #2408 docs(v2): suggest Surge for quick deployment (@fakela)
- #2401 docs(v2): add resources page (@yangshun)
- #2413 docs(v2): include appId key for Algolia (@TheodoreChu)
- #2411 docs:(v2): add Netlify configuration warning (@bravo-kernel)
- #2397 docs(v2):update alpha version to current version (@fakela)
- #2395 docs(v2): clarify instructions on docs-only mode (@phoqe)
docusaurus-init- #2458 fix(v2): expand broken admonitions (@elviswolcott)
docusaurus- Other
- #2450 docs(v2): Adding Motion Layout to Docusaurus users (@jeffersonlicet)
- #2450 docs(v2): Adding Motion Layout to Docusaurus users (@jeffersonlicet)
- #2439 polish(v2): add logo for dark mode (@lex111)
- #2435 fix(v2): fix aspect ratio for Open Graph image (@lex111)
- #2433 chore(v2): ignore JetBrains editors .iml files (@slorber)
- #2416 docs(v2): Add Build Tracker to Showcase page (@paularmstrong)
- #2388 docs(v1): showcase user Day.js (@iamkun)
stylelint-copyright
- Alexey Pyltsyn (@lex111)
- Bartosz Kaszubowski (@Simek)
- Ben Gubler (@nebrelbug)
- Elvis Wolcott (@elviswolcott)
- Fanny (@fanny)
- Favour Kelvin (@fakela)
- Jefferson Licet (@jeffersonlicet)
- Kohhee Peace (@KohheePeace)
- Linus Långberg (@phoqe)
- Luke Collier (@lukecollier)
- Nisar Hassan Naqvi (@nisarhassan12)
- Paul Armstrong (@paularmstrong)
- Ramón Lamana (@rlamana)
- Rémi Doreau (@ayshiff)
- Sam Zhou (@SamChou19815)
- Sébastien Lorber (@slorber)
- Theodore Chu (@TheodoreChu)
- Yangshun Tay (@yangshun)
- @38elements
- @GermaVinsmoke
- @ZachJW34
- @bravo-kernel
- @iamkun
- @mohrash92
HOTFIX for 2.0.0-alpha.44.
- Other
docusaurusdocusaurus-theme-classic
- Alexey Pyltsyn (@lex111)
docusaurus-theme-classicdocusaurus-plugin-content-blogdocusaurus-init,docusaurus-theme-classicdocusaurus-plugin-google-analytics,docusaurus-plugin-google-gtag,docusaurus
docusaurusdocusaurus-theme-classic,docusaurus-theme-live-codeblockdocusaurus-plugin-content-blogdocusaurus-theme-classicdocusaurus-plugin-content-pages,docusaurus-utils- Other
docusaurus-theme-search-algoliadocusaurus-theme-classic,docusaurus-theme-search-algoliadocusaurus-theme-classicdocusaurus-init,stylelint-copyrightdocusaurus-types,docusaurus
- #2378 docs(v2): add section for docs-only mode (@phoqe)
- #2357 docs(v2): fix getPathsToWatch() example syntax in lifecycle APIs (@rlamana)
- #2351 docs(v2): add examples to plugin usage doc (@Noah-Silvera)
- #2343 docs(v2): fix typo in remark-admonitions example (@hassanfarid)
- #2340 docs(v2): mention about disabling Jekyll when using GitHub pages (@amilajack)
- #2338 docs(v2): guide on upgrading Docusaurus within a project (@TheodoreChu)
- #2313 docs(v2): move the quotes to remark admonitions (@Zhencha0Cai)
- #2307 docs(v1): fix Windows instructions for GitHub Pages publishing (@jartuso)
- #2300 docs(v2): make blog plugin config example valid (@balloob)
- #2289 docs(v2): add instructions on Travis CI deployment (@mohamedsgap)
- Other
- #2369 misc: mention about v2 in README file (@lex111)
- #2368 misc: add note about edits in versioned docs (@lex111)
- #2333 docs: update use of npm/yarn in contributing.md (@jsjoeio)
- #2328 docs(v2): remove unwanted black line from DocSearch showcase image (@s-pace)
- #2319 docs(v2): showcase user Algolia (@scottilee)
docusaurus-init
- Alexey Pyltsyn (@lex111)
- Amila Welihinda (@amilajack)
- Hassan Farid (@hassanfarid)
- Joe Previte (@jsjoeio)
- Linus Långberg (@phoqe)
- Mohamed Abdel Nasser (@mohamedsgap)
- Noah Silvera (@Noah-Silvera)
- Paulus Schoutsen (@balloob)
- Ramón Lamana (@rlamana)
- Robert (@deniaz)
- Scott Lee (@scottilee)
- Sylvain Pace (@s-pace)
- Theodore Chu (@TheodoreChu)
- Yangshun Tay (@yangshun)
- Zhenchao Cai (@Zhencha0Cai)
- @jartuso
HOTFIX for 2.0.0-alpha.41.
docusaurus-theme-classic
docusaurus-init,docusaurus-preset-classic,docusaurus-theme-classic- #2224 feat(v2): add remark-admonitions to @docusaurus/preset-classic (@elviswolcott)
docusaurus-theme-classic,docusaurusdocusaurus-theme-classicdocusaurus-plugin-content-pages,docusaurus-utils,docusaurus- #2221 feat(v2): allow for Typescript pages and components (@jonathanrdelgado)
docusaurus-theme-classic
docusaurus-theme-classic,docusaurus-theme-live-codeblock- #2285 fix(v2): fix codeblock copy button not including blank lines (@KohheePeace)
- #2241 fix(v2): make code blocks scrollable (@lex111)
docusaurus-theme-classicdocusaurus-theme-search-algoliadocusaurus-plugin-content-blog,docusaurus-theme-classicdocusaurusdocusaurus-mdx-loaderdocusaurus-theme-live-codeblock
docusaurus-theme-classic,docusaurus-theme-live-codeblock
- #2281 docs: update windows deploy command (@OndrejNepozitek)
- #2257 docs(v2): require using JSX flavored style objects in mdx (@wgao19)
- #2251 docs(v2): collapsible categories in sidebar (@lex111)
- #2218 docs(v2): update link to available prism themes (@jsjoeio)
- #2216 docs(v2): fix plugin-content-docs config comment typo (@sdowding)
- Other
- #2256 fix(v2): add title for Feedback page (@lex111)
- #2246 docs(v2): add Benthos to showcase (@Jeffail)
- #2242 docs(v1): showcase user Jafar (@galhavivi)
- #2238 docs(v1): showcase Dime (@hbulens)
- #2233 docs(v2): showcase user supabase (@awalias)
- #2226 docs(v1): showcase user Adapt.js (@mterrel)
- #2225 docs(v1): add The Diff Podcast to users (@JoelMarcey)
- #2219 chore(v1): Updated users list, removing sites not using docusaurus (@jjwill)
docusaurus-theme-classic,docusaurus
- Alexey Pyltsyn (@lex111)
- Ashley Jeffs (@Jeffail)
- Elie Dutheil (@edwandr)
- Elvis Wolcott (@elviswolcott)
- Evan Rubinton (@erubi)
- Gal Havivi (@galhavivi)
- Hanseung Yoo (@trustyoo86)
- Hendrik Bulens (@hbulens)
- JavaScript Joe (@jsjoeio)
- Joel Marcey (@JoelMarcey)
- Jonathan Delgado (@jonathanrdelgado)
- Joshua Williams (@jjwill)
- KohheePeace (@KohheePeace)
- Mark Terrel (@mterrel)
- Ondřej Nepožitek (@OndrejNepozitek)
- Scott Dowding (@sdowding)
- Wei Gao (@wgao19)
- @awalias
docusaurus-theme-classic
docusaurusdocusaurus-mdx-loader,docusaurus-plugin-content-blog,docusaurus-plugin-content-docsdocusaurus-theme-classic
docusaurus-theme-classicdocusaurus-theme-classic,docusaurusdocusaurus-theme-search-algolia,docusaurus
- Other
- #2135 docs(v1): add space between "out" and "Docusaurus" (@TransmissionsDev)
- #2128 docs(v1): showcase user Shrine (@janko)
- #2110 docs(v2): fix pages routing inaccurate info (@endiliey)
- #2106 fix(v2): add missing hyphen in color generator (@lex111)
- #2104 feat(v2): add color generator for primary colors (@yangshun)
- #2103 docs: mention about moving docs directory into website (@yangshun)
docusaurus-theme-classic,docusaurus-theme-live-codeblock
- Other
docusaurus-initdocusaurusdocusaurus-1.x,docusaurus-init,docusaurus-mdx-loader,docusaurus-plugin-content-blog,docusaurus-plugin-content-docs,docusaurus-plugin-ideal-image,docusaurus-theme-live-codeblock,docusaurus
docusaurus
- Alexey Pyltsyn (@lex111)
- Endi (@endiliey)
- Janko Marohnić (@janko)
- Nick McCurdy (@nickmccurdy)
- Yangshun Tay (@yangshun)
- t11s (@TransmissionsDev)
docusaurusdocusaurus-plugin-content-blog,docusaurus-plugin-content-docs
- Other
docusaurus
- Endi (@endiliey)
docusaurus-plugin-content-blog,docusaurus-plugin-content-docs,docusaurus-plugin-content-pages,docusaurus-theme-classic,docusaurus-utils
If you have swizzled any Docs/Blog component that depends on metadata, you'll have to update. If you haven't, no action is needed.
For example, if you've swizzled @theme/DocItem. You'll have to update
- const {metadata, content: DocContent} = props;
+ const {content: DocContent} = props;
+ const {metadata} = DocContent;docusaurusdocusaurus-plugin-ideal-image
docusaurus-mdx-loader- #2085 misc(v2): update mdx loader plugin README (@shivangna)
docusaurus-1.x- #2087 fix(v1): add key to versions.map in versions.js (@FeynmanDNA)
- #2083 refactor(v1): fix props for ProjectTitle (@FeynmanDNA)
docusaurus
docusaurus-utilsdocusaurus-theme-search-algolia
- Endi (@endiliey)
- KYY (@FeynmanDNA)
- Shivangna Kaistha (@shivangna)
- kaichu (@qshiwu)
docusaurus-init,docusaurus-plugin-content-blog,docusaurus-plugin-content-docs,docusaurus-plugin-content-pages,docusaurus-theme-classic,docusaurus-theme-live-codeblock,docusaurus-theme-search-algolia,docusaurus-utils,docusaurus
docusaurus-theme-classic,docusaurusdocusaurus-plugin-content-blogdocusaurus-plugin-content-docs,docusaurus-types,docusaurusdocusaurus-mdx-loader,docusaurus-plugin-content-docs,docusaurus-plugin-sitemap,docusaurus-theme-classic,docusaurusdocusaurus-plugin-content-docs,docusaurus-theme-classic,docusaurus-types,docusaurus
docusaurus-theme-classic,docusaurusdocusaurus-mdx-loaderdocusaurus-theme-classicdocusaurus
docusaurus-theme-classic
- Other
- #2068 docs(v2): quick proofread docs (@endiliey)
- #2047 docs(v2): add manual migration guide for versioning (@endiliey)
- #2036 docs(v2): Reorganize migration guide (@wgao19)
- #2052 fix(v2): make proper spelling of Yarn in tabs (@lex111)
- #2040 docs(v2): showcase user vector.dev :) (@binarylogic)
- #2038 docs(v2): add documentation on versioning (@endiliey)
- #2037 docs(v2): display yarn and npm command on website (@endiliey)
- #2051 docs(v2): more examples on lifecycle apis, cleanup (@endiliey)
docusaurus-plugin-content-blogdocusaurusdocusaurus-types,docusaurusdocusaurus-mdx-loader,docusaurus-plugin-ideal-image,docusaurus-types,docusaurusdocusaurus-init,docusaurus-mdx-loader,docusaurus-plugin-content-docs,docusaurus
docusaurus-plugin-google-analytics,docusaurus-plugin-google-gtagdocusaurusdocusaurus-plugin-content-docs
- Alexey Pyltsyn (@lex111)
- Binary Logic (@binarylogic)
- Dongwoo Gim (@gimdongwoo)
- Endi (@endiliey)
- Wei Gao (@wgao19)
docusaurus-init,docusaurus-plugin-content-blog,docusaurus-theme-classic
docusaurus-plugin-content-docs,docusaurus-theme-classic
docusaurusdocusaurus-theme-classic
docusaurus-theme-classic
docusaurusdocusaurus-mdx-loader,docusaurus-plugin-ideal-image- Other
docusaurus-mdx-loader,docusaurus-theme-classicdocusaurus-theme-classic- #1999 fix(v2): remove hashbang when click on category (@lex111)
- #1962 fix(v2): make not clickable post title on post item page (@lex111)
- #1980 fix(v2): remove invalid label attribute of footer links (@lex111)
- #1978 fix(v2): use regular div instead of main tag for wrapper layout page (@lex111)
- #1975 fix(v2): move header inside article tag in doc page (@lex111)
- #1974 fix(v2): remove invalid attributes of nav links (@lex111)
- #1963 fix(v2): remove empty containers when no data in blog pages (@lex111)
- #1966 fix(v2): remove duplicate meta tags (@lex111)
docusaurus-plugin-content-docs
docusaurus-theme-search-algoliadocusaurus-theme-classic- #1991 fix(v2): remove accessible anchors via keyboard (@lex111)
- #1987 refactor(v2): replace h1 tag with h2 in blog list pages (@lex111)
- #1981 fix(v2): use tag time for showing last update of doc item (@lex111)
- #1977 feat(v2): add aria-label to read more links for a11y (@lex111)
- #1964 fix(v2): use tag time for showing post item date (@lex111)
docusaurus-plugin-content-docs- Other
docusaurus-initdocusaurus-plugin-content-blog
- Other
- #1988 docs(v2): fix syntax highlighting for YML code blocks (@lex111)
- #1976 docs(v2): Add section to blog document about feed location (@vinnytheviking)
- #1970 docs(v2): update configureWebpack utility functions (@jamiedavenport)
docusaurus-1.x- #1961 docs(v1): remove exclusive language (@ericcarboni)
- Other
docusaurus-initdocusaurus-1.x,docusaurus-init-1.x,docusaurus-init,docusaurus-plugin-content-docs,docusaurus-plugin-ideal-image,docusaurus-types,docusaurus
- Alexey Pyltsyn (@lex111)
- Endi (@endiliey)
- Eric Carboni (@ericcarboni)
- Jamie Davenport (@jamiedavenport)
- Nick McCormick (@kenning)
- Vincent van der Walt (@vinnytheviking)
docusaurus-plugin-content-docs
docusaurus-theme-classic
docusaurus-plugin-content-docs,docusaurus
docusaurus-1.x,docusaurus-plugin-content-blog,docusaurus-plugin-content-docs,docusaurus-theme-classic,docusaurus-theme-search-algolia,docusaurus-types,docusaurus-utils,docusaurus- Other
docusaurus-plugin-content-docs,docusaurus-utils,docusaurus
- Table of contents is now highlighted depending on current active headings. (thanks to awesome @SantiagoGdaR) #1896
- Official blog plugin can now generate feed for blog posts. (thanks to awesome @moozzyk) #1916
- BREAKING
prismThemeis renamed tothemeas part newprismobject inthemeConfigfield in yourdocusaurus.config.js. Eg:themeConfig: { - prismTheme: require('prism-react-renderer/themes/dracula'), + prism: { + theme: require('prism-react-renderer/themes/dracula'), + }, }, - Added new
prismoptiondefaultLanguagethat is used if the language is not specified in code blocks. #1910
- Fix babel/env not picking the correct browserslist configuration during development. When running
docusaurus start,process.env.NODE_ENVis now consistently set todevelopment. - Ensure routes config generation to be more consistent in ordering. Nested routes should be placed last in routes.js. This will allow user to create
src/pages/docs.jsto create custom docs page for/docsor evensrc/pages/docs/super.jsto create page for/docs/super/; - Fix watcher does not trigger reload on windows.
- Fix build compilation error if exists only one code tab.
- Add minor padding to docs container so that hash-link won't be cut off.
- Misc dependency upgrades.
- Stability improvement (more tests) & refactoring on docs plugin to prevent regression.
- Add
<Redirect>component for client side redirect. Example Usage:
import React from 'react';
import {Redirect} from '@docusaurus/router';
function Home() {
return <Redirect to="/docs/test" />;
}- Allow user to add custom HTML to footer items. #1905
- Added code block line highlighting feature (thanks @lex111)! If you have previously swizzled the
CodeBlocktheme component, it is recommended to update your source code to have this feature. (#1860)
- Fix
@theme/Tabscomponent to be able to create tabs with only one item. - Fix MDX
@theme/Headingcomponent. If there is no id, it should not create anchor link. - Fixed a bug in which if
themeConfig.algoliais not defined, the custom searchbar won't appear. If you've swizzled AlgoliaSearchBarcomponent before, please update your source code otherwise CSS might break. See #1909 for reference.
- <Fragment>
+ <div className="navbar__search" key="search-box">- Slightly adjust search icon position to be more aligned on small width device. (#1893)
- Fix algolia styling bug, previously search suggestion result is sometimes hidden. (#1915)
- Changed the way we read the
USE_SSHenv variable during deployment to be the same as in v1. - Fix accessing
docs/or/docs/xxxxthat does not match any existing doc page should return 404 (Not found) page, not blank page. (#1903) - Prioritize
@docusaurus/coredependencies/ node_modules over user's node_modules. This fix a bug whereby if user has core-js@3 on its own node_modules but docusaurus depends on core-js@2, we previously encounterModule not found: core-js/modules/xxxx(because core-js@3 doesn't have that). - Fix a bug where docs plugin add
/docsroute even if docs folder is empty. We also improved docs plugin test coverage to 100% for stability before working on docs versioning. (#1912)
- Reduce memory usage consumption. (#1900)
- Significantly reduce main bundle size and initial HTML payload on production build. Generated files from webpack is also shorter in name. (#1898)
- Simplify blog metadata. Previously, accessing
/blog/post-xxxwill request for next and prev blog post metadata too aside from target post metadata. We should only request target post metadata. (#1908)
- Footer is now sticky/ pinned to the bottom of the viewport in desktop browsers.
- Footer is now also displayed in docs page for consistency.
- Remove empty doc sidebar container if sidebar for a particular doc page does not exist. Otherwise, it will cause an additional empty space.
- Default PostCSS loader now only polyfills stage 3+ features (previously it was stage 2) like Create React App. Stage 2 CSS is considered relatively unstable and subject to change while Stage 3 features will likely become a standard.
- Fix search bar focus bug. When you put the focus on search input, previously the focus will remain although we have clicked to other area outside of the search input.
- New themeConfig option
sidebarCollapsible. It is on by default. If explicitly set tofalse, all doc items in sidebar is expanded. Otherwise, it will still be a collapsible sidebar. - Disable adding hashes to the generated class names of CSS modules in dev mode. Generating unique identifiers takes some time, which can be saved since including paths to files in class names is enough to avoid collisions.
- Fix showing sidebar category with empty items.
- Update infima from 0.2.0-alpha.2 to 0.2.0-alpha.3
- Fix pagination nav and right sidebar color contrast ratio
- Fix sidebar arrow color in dark mode
- Fix footer mobile issue
- Increase sidebar width
- etc
- Fix babel transpilation include/exclude logic to be more efficient. This also fix a very weird bug
TypeError: Cannot assign to read only property 'exports' of object '#<Object>'.(#1868)
If you are still encountering the error. Please check whether you use module.exports for your .js file instead of doing export (mixing CJS and ES). See webpack/webpack#4039 (comment) and webpack/webpack#4039 (comment) for more context.
HOTFIX for 2.0.0-alpha.28.
- Fix missing
core-jsdependencies on@docusaurus/core. - Fix wrong
@babel/envpreset configuration that causes build compilation error. - New UI for webpack compilation progress bar.
- Further reduce memory usage to avoid heap memory allocation failure.
- Fix
keywordsfrontmatter for SEO not working properly. - Fix
swizzlecommand not passing context properly to theme packages. - Add
extendCliapi for plugins. This will allow plugin to further extend Docusaurus CLI. - Fix
swizzlecommand not being able to swizzle single js file. - Fix logo URL in footer to be appended with baseUrl automatically.
- Add the option
--no-openforstartcommand. - Set
@babel/envuseBuiltins tousage. This will automatically use browserlist and import polyfills required. - Modified TerserWebpackPlugin
terserOptionsfor better cross-browser compatibility. - BREAKING
withBaseUrlis renamed touseBaseUrlbecause its a React Hooks. Make sure you import/rename it correctly. Eg:import useBaseUrl from '@docusaurus/useBaseUrl; - Fix potential security vulnerability because we're exposing the directory structure of the host machine.
- Upgrade dependencies.
- Add
@theme/Tabswhich can be used to implement multi-language code tabs. - Implement
custom_edit_urlandhide_titlemarkdown header for docusaurus v1 feature parity. - Reduce memory usage and slightly faster production build.
- Misc dependency upgrades.
- Docs, pages plugin is rewritten in TypeScript
- Docs improvements and tweaks
- Improved metadata which results in smaller bundle size.
- Docs sidebar can now be more than one level deep, theoretically up to infinity
- Collapsible docs sidebar!
- Make doc page title larger
- Add
editUrloption (URL for editing) to docs plugin. If this field is set, there will be an "Edit this page" link for each doc page. Example: 'https://github.com/facebook/docusaurus/edit/master/docs' - Add
showLastUpdateTimeandshowLastUpdateAuthoroptions to docs plugin to further achieve v1 parity of showing last update data for a particular doc
- Slight tweaks to the Blog components - blog title is larger now
- Code Blocks
- Change default theme from Night Owl to Palenight
- Slight tweaks to playground/preview components
- Add
scriptsandstylesheetsfield todocusaurus.config.js - More documentation...
- Blog plugin is rewritten in TypeScript and can now support CJK
- Upgrade key direct dependencies such as webpack, mdx and babel to latest
- Do not escape html and body attributes
- For devices with very small viewport width, the searchbar is replaced with a search icon. On tap of the search icon the searchbar is expanded and the text beside the logo is hidden and remains hidden while the search bar is expanded.
- Add
datefrontMatter support for blog plugin - Add
truncateMarkeroption to blog plugin, support string or regex. - Webpack
optimization.removeAvailableModulesis now disabled for performance gain. See https://github.com/webpack/webpack/releases/tag/v4.38.0 for more context.
- Remove unused metadata for pages. This minimize number of http request & smaller bundle size.
- Upgrade dependencies of css-loader from 2.x to 3.x. Css modules localIdentName hash now only use the last 4 characters instead of 8.
- Fix broken markdown linking replacement for mdx files
- Fix potential security vulnerability because we're exposing the directory structure of the host machine. Instead of absolute path, we use relative path from site directory. Resulting in shorter webpack chunk naming and smaller bundle size.
- Use contenthash instead of chunkhash for better long term caching
- Allow user to customize generated heading from MDX. Swizzle
@theme/Heading
- Fix docusaurus route config generation for certain edge case
- Add missing dependencies on
@docusaurus/preset-classic - New plugin
@docusaurus/plugin-ideal-imageto generate an almost ideal image (responsive, lazy-loading, and low quality placeholder) - Better Twitter/discord image preview. Previously the size is too zoomed
- Allow prism syntax highlighting theme customization. Refer to https://v2.docusaurus.io/docs/markdown-features#syntax-highlighting
- CSS is now autoprefixed using postcss
- Faster, lighter webpack bundle size
@docusaurus/theme-live-codeblockis now much smaller in size and no longer only load on viewport- Blog markdown files now support using the id field to specify the path
- Fix babel-loader not transpiling docusaurus package
- Add copy codeblock button
- Add Google analytics and Google gtag plugins.
- Move source components to
/src. Please create awebsite/srcdirectory and move your/pagesand/themecode into it. This is to make it easier to integrate your website with external build/static analysis tooling (you can now just pass insrc/**/*.jsas the path to process). - Adde more documentation thanks to @wgao19.
- Deprecate the current docs plugin. The docs plugin as of 2.0.0-alpha.19 is heavily based on V1 specifications and we intend to create a better one that fixes some of the inconsistencies in V1. If you have swizzled any doc components, you will have to update their names. You are highly encourages to not swizzle the legacy doc components until we have completed the new docs plugin.
- Separate v2 init command to new package @docusaurus/init
- Render 404.html page
- Improve SEO
- Clicking on the logo in the mobile sliding navigation will now bring you to the homepage.
- Performance
- Disable webpack output pathinfo. Webpack has the ability to generate path info in the output bundle. However, this puts garbage collection pressure on projects that bundle thousands of modules. Not very useful for our case
- Drop cache-loader in CI and test environment because it has an initial overhead. We always start from scratch in vm instance like CI so cache-loader is useless
- Better splitchunks and babel default webpack config
- Add a sensible default for browserslist config.
- UI
- Add sun and moon emoji to the dark mode toggle.
- Mobile responsive menu.
- Right table of contents for docs is now sticky.
- Plugins
- Change plugin definitions from classes to functions. Refer to the new plugin docs.
- Implement Clients module API.
- Change format within
docusaurus.config.jsto be like presets.
- Deps
- Infima CSS is now locked down to specific versions and not relying upon the CDN which reads from trunk.
- Update dependencies to latest
- Customize/ Override infima CSS variables by passing options into the classic preset.
presets: [
[
'@docusaurus/preset-classic',
{
theme: {
customCss: require.resolve('./css/custom.css'),
},
...
},
],
],
- Allow passing remark and rehype plugins to mdx-loader for docs and blog plugin
- Move themes component of docs and blog to be part of theme-classic
- Use composition style for prism syntax highlighting instead of doing it via rehype plugin
- Pass MDXProvider to docs and blog. To change the provided MDX components, run
docusaurus swizzle @docusaurus/theme-classic MDXComponents - Add @docusaurus/theme-livecodeblock plugin
- Better run-time code generation & webpack splitchunks optimization
- Minify css for production build
- Fix weird scrolling problem when navigating to a route with a
hashlocation
siteConfig.jsrenamed todocusaurus.config.js.- Remove the following config options:
docsUrl. Use the plugin option ondocusaurus-plugin-content-docsinstead.customDocsPath. Use the plugin option ondocusaurus-plugin-content-docsinstead.sidebars.jsonnow has to be explicitly loaded by users and passed into the the plugin option ondocusaurus-plugin-content-docs.headerLinksdoc, page, blog is deprecated and has been to moved intothemeConfigunder the namenavbar. The syntax is now:
themeConfig: {
navbar: {
title: 'Docusaurus',
logo: {
alt: 'Docusaurus Logo',
src: 'img/docusaurus.svg',
},
links: [
{to: 'docs/introduction', label: 'Docs', position: 'left'},
{to: 'blog', label: 'Blog', position: 'left'},
{to: 'feedback', label: 'Feedback', position: 'left'},
{
href: 'https://github.com/facebook/docusaurus',
label: 'GitHub',
position: 'right',
},
],
},
}Work in Progress
- Add presets for plugins that follow the Babel preset convention.