Releases: facebook/docusaurus
v2.0.0-alpha.28
2.0.0-alpha.28
- BREAKING
withBaseUrl
is renamed touseBaseUrl
because its a React Hooks. Make sure you import/rename it correctly. Eg:import useBaseUrl from '@docusaurus/useBaseUrl
; - Further reduce memory usage to avoid heap memory allocation failure.
- Fix
keywords
frontmatter for SEO not working properly. - Fix
swizzle
command not passing context properly to theme packages. - Add
extendCli
api for plugins. This will allow plugin to further extend Docusaurus CLI. - Fix
swizzle
command not being able to swizzle single js file. - Fix logo URL in footer to be appended with baseUrl automatically.
- Add the option
--no-open
forstart
command. - Set
@babel/env
useBuiltins tousage
. This will automatically use browserlist and import polyfills required. - Modified TerserWebpackPlugin
terserOptions
for better cross-browser compatibility. - Fix potential security vulnerability because we're exposing the directory structure of the host machine.
- Upgrade dependencies.
v1.14.0
v2.0.0-alpha.27
- Add
@theme/Tabs
which can be used to implement multi-language code tabs. - Implement
custom_edit_url
andhide_title
markdown header for docusaurus v1 feature parity. - Reduce memory usage and slightly faster production build.
- Misc dependency upgrades.
v2.0.0-alpha.26
2.0.0-alpha.26
- 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
editUrl
option (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
showLastUpdateTime
andshowLastUpdateAuthor
options 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
scripts
andstylesheets
field to docusaurus.config. - More documentation on https://v2.docusaurus.io
See CHANGELOG for more info.
v2.0.0-alpha.25
v2.0.0-alpha.25
v1.13.0
v2.0.0-alpha.24
v2.0.0-alpha.24
v1.12.0
In this release we have a few features that enable more semantic use cases for v1:
- Enable hiding blog posts in production from the sidebar and the feeds by adding an
unlisted: true
header option (#1396, thanks @olafurpg) - Replace apostrophe with empty string in header slugification (#1618, thanks @parthpp)
- Use primary color for highlighted items in table of contents (#1628, thanks @parvezakkas)
And we have a number of fixes including bootstrapped footer social links (#1647), PostCSS warning on build
command (#1664, thanks @ybiquitous), and properly render meta description (#1672). We've also upgraded a lot of dependencies to fix vulnerability issues (#1668).
We're constantly improving our docs! Check out #1649 (thanks @mesaugat) and #1615 (thanks @anurag).
In case you are not aware, you can check out Docusaurus 2 alpha at https://v2.docusaurus.io. Meanwhile, we're also welcoming PRs for v2 docs in an umbrella issue #1640. Check it out if you're interested in contributing.
Finally, welcoming new users onboard:
- CodeceptJS
- Type Route
- Substrate
- Apify SDK
- Paynow
- Libra
- Bitcoin-S
- Almond
- moleculerjs-boilerplate and next-boilerplate
And our very first v2 users:
See CHANGELOG.md for more details.
v1.11.1
v1.11.0
We added a new feature of highlighting the table of contents on the right side as you scroll the docs pages with the great work by @tusharf5. A few bugs affecting local development were also fixed. More notably, the blog's left sidebar will not hide the post titles when docsSideNavCollapsible
is turned on. This is a bugfix/backward-incompatible change depending on how you view it, but probably nobody wanted that collapsing behavior on the blog sidebar in the first place.
We also welcome @wgao19 to the core team! She'll be helping us with Docusaurus 2 work leveraging on her experience writing documentation and CSS!