@docusaurus/core
Advanced tools
Changelog
2.0.0-alpha.33 (2019-11-08)
prismTheme
is renamed to theme
as part new prism
object in themeConfig
field in your docusaurus.config.js
. Eg:
themeConfig: {
- prismTheme: require('prism-react-renderer/themes/dracula'),
+ prism: {
+ theme: require('prism-react-renderer/themes/dracula'),
+ },
},
prism
option defaultLanguage
that is used if the language is not specified in code blocks. #1910docusaurus start
, process.env.NODE_ENV
is now consistently set to development
.src/pages/docs.js
to create custom docs page for /docs
or even src/pages/docs/super.js
to create page for /docs/super/
;Changelog
2.0.0-alpha.32 (2019-11-04)
<Redirect>
component for client side redirect. Example Usage:import React from 'react';
import {Redirect} from '@docusaurus/router';
function Home() {
return <Redirect to="/docs/test" />;
}
CodeBlock
theme component, it is recommended to update your source code to have this feature. (#1860)@theme/Tabs
component to be able to create tabs with only one item.@theme/Heading
component. If there is no id, it should not create anchor link.themeConfig.algolia
is not defined, the custom searchbar won't appear. If you've swizzled Algolia SearchBar
component before, please update your source code otherwise CSS might break. See #1909 for reference.- <Fragment>
+ <div className="navbar__search" key="search-box">
USE_SSH
env variable during deployment to be the same as in v1.docs/
or /docs/xxxx
that does not match any existing doc page should return 404 (Not found) page, not blank page. (#1903)@docusaurus/core
dependencies/ node_modules over user's node_modules. This fix a bug whereby if user has core-js@3 on its own node_modules but docusaurus depends on core-js@2, we previously encounter Module not found: core-js/modules/xxxx
(because core-js@3 doesn't have that)./docs
route even if docs folder is empty. We also improved docs plugin test coverage to 100% for stability before working on docs versioning. (#1912)/blog/post-xxx
will request for next and prev blog post metadata too aside from target post metadata. We should only request target post metadata. (#1908)Changelog
2.0.0-alpha.31 (2019-10-26)
sidebarCollapsible
. It is on by default. If explicitly set to false
, all doc items in sidebar is expanded. Otherwise, it will still be a collapsible sidebar.Changelog
2.0.0-alpha.30 (2019-10-22)
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 https://github.com/webpack/webpack/issues/4039#issuecomment-477779322 and https://github.com/webpack/webpack/issues/4039#issuecomment-273804003 for more context.
Changelog
2.0.0-alpha.29 (2019-10-21)
HOTFIX for 2.0.0-alpha.28.
core-js
dependencies on @docusaurus/core
.@babel/env
preset configuration that causes build compilation error.Changelog
2.0.0-alpha.28 (2019-10-21)
keywords
frontmatter for SEO not working properly.swizzle
command not passing context properly to theme packages.extendCli
api for plugins. This will allow plugin to further extend Docusaurus CLI.swizzle
command not being able to swizzle single js file.--no-open
for start
command.@babel/env
useBuiltins to usage
. This will automatically use browserlist and import polyfills required.terserOptions
for better cross-browser compatibility.withBaseUrl
is renamed to useBaseUrl
because its a React Hooks. Make sure you import/rename it correctly. Eg: import useBaseUrl from '@docusaurus/useBaseUrl
;Changelog
2.0.0-alpha.27 (2019-10-14)
@theme/Tabs
which can be used to implement multi-language code tabs.custom_edit_url
and hide_title
markdown header for docusaurus v1 feature parity.Changelog
2.0.0-alpha.26 (2019-10-12)
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'showLastUpdateTime
and showLastUpdateAuthor
options to docs plugin to further achieve v1 parity of showing last update data for a particular docscripts
and stylesheets
field to docusaurus.config.js
Changelog
2.0.0-alpha.25 (2019-10-01)
date
frontMatter support for blog plugintruncateMarker
option to blog plugin, support string or regex.optimization.removeAvailableModules
is now disabled for performance gain. See https://github.com/webpack/webpack/releases/tag/v4.38.0 for more context.Changelog
2.0.0-alpha.24 (2019-07-24)
@theme/Heading