Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
@docusaurus/types
Advanced tools
@docusaurus/types - npm Package Versions
endiliey
published 2.0.0-alpha.38 • Changelog
2.0.0-alpha.38 (2019-12-06)
:boom: Breaking Change
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;
:bug: Bug Fix
docusaurusdocusaurus-plugin-ideal-image
:nail_care: Polish
docusaurus-mdx-loader- #2085 misc(v2): update mdx loader plugin README (@shivangna)
:house: Internal
docusaurus-1.x- #2087 fix(v1): add key to versions.map in versions.js (@FeynmanDNA)
- #2083 refactor(v1): fix props for ProjectTitle (@FeynmanDNA)
docusaurus
:running_woman: Performance
docusaurus-utilsdocusaurus-theme-search-algolia
Committers: 4
- Endi (@endiliey)
- KYY (@FeynmanDNA)
- Shivangna Kaistha (@shivangna)
- kaichu (@qshiwu)
endiliey
published 2.0.0-alpha.37 • Changelog
2.0.0-alpha.37 (2019-12-01)
:boom: Breaking Change
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
:rocket: New Feature
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
:bug: Bug Fix
docusaurus-theme-classic,docusaurusdocusaurus-mdx-loaderdocusaurus-theme-classicdocusaurus
:nail_care: Polish
docusaurus-theme-classic
:memo: Documentation
- 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)
:house: Internal
docusaurus-plugin-content-blogdocusaurusdocusaurus-types,docusaurusdocusaurus-mdx-loader,docusaurus-plugin-ideal-image,docusaurus-types,docusaurusdocusaurus-init,docusaurus-mdx-loader,docusaurus-plugin-content-docs,docusaurus
:running_woman: Performance
docusaurus-plugin-google-analytics,docusaurus-plugin-google-gtagdocusaurusdocusaurus-plugin-content-docs
Committers: 5
- Alexey Pyltsyn (@lex111)
- Binary Logic (@binarylogic)
- Dongwoo Gim (@gimdongwoo)
- Endi (@endiliey)
- Wei Gao (@wgao19)
endiliey
published 2.0.0-alpha.36 • Changelog
2.0.0-alpha.36 (2019-11-22)
:boom: Breaking Change
docusaurus-init,docusaurus-plugin-content-blog,docusaurus-theme-classic
:rocket: New Feature
docusaurus-plugin-content-docs,docusaurus-theme-classic
:bug: Bug Fix
docusaurusdocusaurus-theme-classic
:nail_care: Polish
docusaurus-theme-classic
:house: Internal
docusaurusdocusaurus-mdx-loader,docusaurus-plugin-ideal-image- Other
:memo: Documentation
Committers: 3
endiliey
published 2.0.0-alpha.35 • Changelog
2.0.0-alpha.35 (2019-11-17)
:rocket: New Feature
:bug: Bug Fix
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
:nail_care: Polish
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
:memo: Documentation
- 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)
:house: Internal
- Other
docusaurus-initdocusaurus-1.x,docusaurus-init-1.x,docusaurus-init,docusaurus-plugin-content-docs,docusaurus-plugin-ideal-image,docusaurus-types,docusaurus
:running_woman: Performance
Committers: 6
- Alexey Pyltsyn (@lex111)
- Endi (@endiliey)
- Eric Carboni (@ericcarboni)
- Jamie Davenport (@jamiedavenport)
- Nick McCormick (@kenning)
- Vincent van der Walt (@vinnytheviking)
endiliey
published 2.0.0-alpha.34 • Changelog
2.0.0-alpha.34 (2019-11-11)
:rocket: New Feature
:boom: Breaking Change
docusaurus-plugin-content-docs
:bug: Bug Fix
docusaurus-theme-classic
:nail_care: Polish
docusaurus-plugin-content-docs,docusaurus
:memo: Documentation
:house: Internal
docusaurus-1.x,docusaurus-plugin-content-blog,docusaurus-plugin-content-docs,docusaurus-theme-classic,docusaurus-theme-search-algolia,docusaurus-types,docusaurus-utils,docusaurus- Other
:running_woman: Performance
docusaurus-plugin-content-docs,docusaurus-utils,docusaurus
Committers: 3
endiliey
published 2.0.0-alpha.33 • Changelog
2.0.0-alpha.33 (2019-11-08)
Features
- Table of contents is now highlighted depending on current active headings. (thanks to awesome @SantiagoGdaR) #1896
- Official blog plugin can now generate feed for blog posts. (thanks to awesome @moozzyk) #1916
- BREAKING
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
Fixes
- 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.
Others
- Misc dependency upgrades.
- Stability improvement (more tests) & refactoring on docs plugin to prevent regression.
endiliey
published 2.0.0-alpha.32 • Changelog
2.0.0-alpha.32 (2019-11-04)
Features
- 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)
Bug Fixes
- 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)
Performance Improvement
- Reduce memory usage consumption. (#1900)
- Significantly reduce main bundle size and initial HTML payload on production build. Generated files from webpack is also shorter in name. (#1898)
- Simplify blog metadata. Previously, accessing
/blog/post-xxxwill request for next and prev blog post metadata too aside from target post metadata. We should only request target post metadata. (#1908)
Others
endiliey
published 2.0.0-alpha.31 • Changelog
2.0.0-alpha.31 (2019-10-26)
- 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
endiliey
published 2.0.0-alpha.30 • Changelog
2.0.0-alpha.30 (2019-10-22)
- 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 https://github.com/webpack/webpack/issues/4039#issuecomment-477779322 and https://github.com/webpack/webpack/issues/4039#issuecomment-273804003 for more context.