docusaurus
Easy to maintain open source documentation websites.
MIT License
Bot releases are hidden (Show)
docusaurus
- v1.14.4
Published by yangshun almost 5 years ago
Rest in Peace @endiliey
It is with great sadness to announce that our primary external Docusaurus contributor, Endilie Yacop Sucipto (@endiliey), passed away on Jan 5th after battling cancer and illnesses for years. We have written a blog post in memory of him.
π Bug Fix
π Internal
-
docusaurus-1.x- #2194 blog: tribute to Endi (@JoelMarcey)
- #2163 blog: 2019 recap (@yangshun)
- #2087 fix(v1): add key to versions.map in versions.js (@FeynmanDNA)
- #2083 refactor(v1): fix props for ProjectTitle (@FeynmanDNA)
Committers: 6
docusaurus
- v2.0.0-alpha.40
Published by endiliey almost 5 years ago
π New Feature
-
docusaurus-theme-classic
π Bug Fix
-
docusaurus -
docusaurus-mdx-loader,docusaurus-plugin-content-blog,docusaurus-plugin-content-docs -
docusaurus-theme-classic
π Polish
-
docusaurus-theme-classic -
docusaurus-theme-classic,docusaurus -
docusaurus-theme-search-algolia,docusaurus
π Documentation
- 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
π Internal
- Other
-
docusaurus-init -
docusaurus -
docusaurus-1.x,docusaurus-init,docusaurus-mdx-loader,docusaurus-plugin-content-blog,docusaurus-plugin-content-docs,docusaurus-plugin-ideal-image,docusaurus-theme-live-codeblock,docusaurus
πββοΈ Performance
-
docusaurus
Committers: 6
- Alexey Pyltsyn (@lex111)
- Endi (@endiliey)
- Janko MarohniΔ (@janko)
- Nick McCurdy (@nickmccurdy)
- Yangshun Tay (@yangshun)
- t11s (@TransmissionsDev)
docusaurus
- v2.0.0-alpha.39
Published by endiliey almost 5 years ago
π Bug Fix
-
docusaurus -
docusaurus-plugin-content-blog,docusaurus-plugin-content-docs
π Internal
- Other
-
docusaurus
Committers: 1
- Endi (@endiliey)
docusaurus
- v2.0.0-alpha.38
Published by endiliey almost 5 years ago
π₯ 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 Fix
-
docusaurus -
docusaurus-plugin-ideal-image
π Polish
-
docusaurus-mdx-loader- #2085 misc(v2): update mdx loader plugin README (@shivangna)
π 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
πββοΈ Performance
-
docusaurus-utils -
docusaurus-theme-search-algolia
Committers: 4
- Endi (@endiliey)
- KYY (@FeynmanDNA)
- Shivangna Kaistha (@shivangna)
- kaichu (@qshiwu)
docusaurus
- v2.0.0-alpha.37
Published by endiliey almost 5 years ago
π₯ 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
π New Feature
-
docusaurus-theme-classic,docusaurus -
docusaurus-plugin-content-blog -
docusaurus-plugin-content-docs,docusaurus-types,docusaurus -
docusaurus-mdx-loader,docusaurus-plugin-content-docs,docusaurus-plugin-sitemap,docusaurus-theme-classic,docusaurus -
docusaurus-plugin-content-docs,docusaurus-theme-classic,docusaurus-types,docusaurus
π Bug Fix
-
docusaurus-theme-classic,docusaurus -
docusaurus-mdx-loader -
docusaurus-theme-classic -
docusaurus
π Polish
-
docusaurus-theme-classic
π 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)
π Internal
-
docusaurus-plugin-content-blog -
docusaurus -
docusaurus-types,docusaurus -
docusaurus-mdx-loader,docusaurus-plugin-ideal-image,docusaurus-types,docusaurus -
docusaurus-init,docusaurus-mdx-loader,docusaurus-plugin-content-docs,docusaurus
πββοΈ Performance
-
docusaurus-plugin-google-analytics,docusaurus-plugin-google-gtag -
docusaurus -
docusaurus-plugin-content-docs
Committers: 5
- Alexey Pyltsyn (@lex111)
- Binary Logic (@binarylogic)
- Dongwoo Gim (@gimdongwoo)
- Endi (@endiliey)
- Wei Gao (@wgao19)
docusaurus
- v2.0.0-alpha.36
Published by endiliey almost 5 years ago
π₯ Breaking Change
-
docusaurus-init,docusaurus-plugin-content-blog,docusaurus-theme-classic
π New Feature
-
docusaurus-plugin-content-docs,docusaurus-theme-classic
π Bug Fix
-
docusaurus -
docusaurus-theme-classic
π Polish
-
docusaurus-theme-classic
π Internal
-
docusaurus -
docusaurus-mdx-loader,docusaurus-plugin-ideal-image - Other
π Documentation
Committers: 3
docusaurus
- v1.14.2
Published by endiliey almost 5 years ago
docusaurus
- v1.14.1
Published by endiliey almost 5 years ago
π Bug Fix
- #2022 fix(v1): markdown content and toc should render the same (@endiliey)
- #2020 fix(v1): docusaurus-start should work even if path contain 'pages' word (@endiliey)
- #2019 fix(v1): consistent slug & hash-link generation (@endiliey)
- #1869 fix(v1): fix page title render issue when referred by search result (@parvezakkas)
- #1895 fix(v1): mobile safari search input misalignment in header (@sarneeh)
- #1871 misc(v1): use primary color for hovered items in table of contents (@blitz137)
π Internal
- #1920 misc(v1): use Node.js lts version for docker (@gengjiawen)
π Documentation
- #1998 docs(v1): showcase user collective (@kenning)
- #1961 docs(v1): remove exclusive language (@ericcarboni)
- #1873 docs: showcase user Amphora (@xtellurian)
- #1918 docs(v1): showcase user Reactive Interaction Gateway (@mmacai)
- #1911 docs: updating configcat user link (@mr-sige)
- #1902 misc: update URLs to non-HTML versions (@ikrydev)
- #1901 docs(v1): remove broken link for user Vasern (@ikrydev)
See CHANGELOG.md for more details.
docusaurus
- v2.0.0-alpha.35
Published by endiliey almost 5 years ago
π New Feature
π Bug Fix
-
docusaurus-mdx-loader,docusaurus-theme-classic -
docusaurus-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
π Polish
-
docusaurus-theme-search-algolia -
docusaurus-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-init -
docusaurus-plugin-content-blog
π 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)
π Internal
- Other
-
docusaurus-init -
docusaurus-1.x,docusaurus-init-1.x,docusaurus-init,docusaurus-plugin-content-docs,docusaurus-plugin-ideal-image,docusaurus-types,docusaurus
πββοΈ Performance
Committers: 6
- Alexey Pyltsyn (@lex111)
- Endi (@endiliey)
- Eric Carboni (@ericcarboni)
- Jamie Davenport (@jamiedavenport)
- Nick McCormick (@kenning)
- Vincent van der Walt (@vinnytheviking)
docusaurus
- v2.0.0-alpha.34
Published by endiliey almost 5 years ago
π New Feature
π₯ Breaking Change
-
docusaurus-plugin-content-docs
π Bug Fix
-
docusaurus-theme-classic
π Polish
-
docusaurus-plugin-content-docs,docusaurus
π Documentation
π 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
πββοΈ Performance
-
docusaurus-plugin-content-docs,docusaurus-utils,docusaurus
Committers: 3
docusaurus
- v2.0.0-alpha.33
Published by endiliey almost 5 years ago
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.
Upgrading
// package.json
{
dependencies: {
+ "@docusaurus/core": "^2.0.0-alpha.33",
+ "@docusaurus/preset-classic": "^2.0.0-alpha.33",
- "@docusaurus/core": "^2.0.0-alpha.32",
- "@docusaurus/preset-classic": "^2.0.0-alpha.32",
}
}
docusaurus
- v2.0.0-alpha.32
Published by endiliey almost 5 years ago
2.0.0-alpha.32
Features
- Add
<Redirect>component for easy 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
docusaurus
- v2.0.0-alpha.31
Published by endiliey almost 5 years ago
2.0.0-alpha.31
- 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
docusaurus
- v2.0.0-alpha.30
Published by endiliey almost 5 years ago
2.0.0-alpha.30
- 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>'if your website path containsdocusaurusword in it.(#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.
docusaurus
- v2.0.0-alpha.29
Published by endiliey almost 5 years ago
2.0.0-alpha.29
HOTFIX for 2.0.0-alpha.28.
- Fix missing
core-jsdependencies on@docusaurus/core. - Fix wrong
@babel/envpreset configuration that causes build compilation error. - Improved UI for webpack compilation progress bar.
docusaurus
- v2.0.0-alpha.28
Published by endiliey almost 5 years ago
2.0.0-alpha.28
-
BREAKING
withBaseUrlis renamed touseBaseUrlbecause 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
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. - Fix potential security vulnerability because we're exposing the directory structure of the host machine.
- Upgrade dependencies.
docusaurus
- v1.14.0
Published by yangshun almost 5 years ago
docusaurus
- v2.0.0-alpha.27
Published by endiliey about 5 years ago
- 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.
docusaurus
- v2.0.0-alpha.26
Published by endiliey about 5 years ago
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
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 to docusaurus.config. - More documentation on https://v2.docusaurus.io
See CHANGELOG for more info.
Package Rankings
Top 0.26% on Npmjs.org
Top 3.58% on Proxy.golang.org
Badges
Extracted from project README
