@docusaurus/types - npm Package Versions

2.0.0-alpha.44 (2020-03-08)

:rocket: New Feature

• docusaurus-theme-classic
  • #2250 feat(v2): add support specify new languages for Prism (@lex111)
  • #2344 feat(v2): allow specifying custom target for logo link (@lex111)
  • #2327 feat(v2): add ability to use HTML in footer copyright (@lex111)
• docusaurus-plugin-content-blog
  • #2335 feat(v2): add draft feature to blog posts (@lex111)
• docusaurus-init, docusaurus-theme-classic
  • #2303 docs(v2): Nav links activeBasePath (@yangshun)
• docusaurus-plugin-google-analytics, docusaurus-plugin-google-gtag, docusaurus
  • #2296 feat(v2): add ExecutionEnvironment API (@yangshun)

:bug: Bug Fix

• docusaurus
  • #2345 fix(v2): force terminate building if client bundle failed (@lex111)
  • #2310 fix(v2): add @babel/preset-typescript to babel-loader (@deniaz)
• docusaurus-theme-classic, docusaurus-theme-live-codeblock
  • #2371 fix(v2): remove line break from end of code blocks (@lex111)
• docusaurus-plugin-content-blog
  • #2326 fix(v2): linkify blog posts (@lex111)
• docusaurus-theme-classic
  • #2324 fix(v2): properly set dark mode logo on build-time prerendering (@lex111)
  • #2325 fix(v2): switch a toggle when system theme changed (@lex111)
• docusaurus-plugin-content-pages, docusaurus-utils
  • #2334 fix(v2): make proper path to pages in TS (@lex111)
• Other
  • #2316 fix(v2): properly scale logo on IE 11 (@lex111)

:nail_care: Polish

• docusaurus-theme-search-algolia
  • #2376 refactor(v2): clean up and improve Algolia styles (@lex111)
• docusaurus-theme-classic, docusaurus-theme-search-algolia
  • #2372 chore(v2): upgrade Infima and remark-admonitions (@lex111)
• docusaurus-theme-classic
  • #2367 refactor(v2): increase CSS specificity on application container (@lex111)
• docusaurus-init, stylelint-copyright
  • #2363 fix(v2): improve stylelint copyright header rule (@yangshun)
• docusaurus-types, docusaurus
  • #2342 chore(v2): mark tagline field as optional (@lex111)

:memo: Documentation

• #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)

:house: Internal

• 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
  • #2322 docs(v2): fix misc styling (@lex111)

Committers: 16

• 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

2.0.0-alpha.43 (2020-02-18)

HOTFIX for 2.0.0-alpha.41.

:bug: Bug Fix

• docusaurus-theme-classic
  • #2292 chore(v2): update Infima to 0.2.0-alpha.4 (@yangshun)
  • #2291 fix(v2): fix build and deps install (@lex111)

Committers: 2

• Alexey Pyltsyn (@lex111)
• Yangshun Tay (@yangshun)

2.0.0-alpha.41 (2020-02-16)

:rocket: New Feature

• docusaurus-init, docusaurus-preset-classic, docusaurus-theme-classic
  • #2224 feat(v2): add remark-admonitions to @docusaurus/preset-classic (@elviswolcott)
• docusaurus-theme-classic, docusaurus
  • #2263 feat(v2): pluralize posts on tag's page (@lex111)
• docusaurus-theme-classic
  • #2261 feat(v2): allow to specify different logo for dark mode (@lex111)
  • #2253 feat(v2): allow specify custom link for logo (@lex111)
  • #2255 feat(v2): add site title to meta title (@lex111)
• docusaurus-plugin-content-pages, docusaurus-utils, docusaurus
  • #2221 feat(v2): allow for TypeScript pages and components (@jonathanrdelgado)

:boom: Breaking Change

• docusaurus-theme-classic
  • #2235 fix(v2): show doc sidebar on pages with case-sensitive paths (@lex111)

:bug: Bug Fix

• 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-classic
  • #2259 fix(v2): use site title if enabled blog-only mode (@lex111)
  • #2248 fix(v2): adjust correct behavior of navbar when active anchor (@lex111)
  • #2235 fix(v2): show doc sidebar on pages with case-sensitive paths (@lex111)
  • #2162 fix(v2): unify anchor behavior (@lex111)
• docusaurus-theme-search-algolia
  • #2262 fix(v2): remove focus on search input when hovering over it (@lex111)
• docusaurus-plugin-content-blog, docusaurus-theme-classic
  • #2240 fix(v2): hide read more button on non-truncated posts (@lex111)
• docusaurus
  • #2237 fix(v2): include base url in 404 route (@lex111)
• docusaurus-mdx-loader
  • #2236 fix(v2): escape link text in TOC (@lex111)
• docusaurus-theme-live-codeblock
  • #2227 fix(v2): render correct theme for live code blocks on SSR (@lex111)

:nail_care: Polish

• docusaurus-theme-classic, docusaurus-theme-live-codeblock
  • #2254 refactor(v2): avoid to use raw theme values (@lex111)

:memo: Documentation

• #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)

:house: Internal

• 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
  • #2239 chore(eslint): require curly brackets on all blocks (@lex111)

Committers: 18

• 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

2.0.0-alpha.40 (2019-12-25)

:rocket: New Feature

• docusaurus-theme-classic
  • #2117 feat(v2): auto switch theme depending on the system theme (@lex111)
  • #2055 feat(v2): hide navbar on scroll (@lex111)

:bug: Bug Fix

• docusaurus
  • #2145 fix(v2): remove style-loader, use minicssextract in both dev & prod (@endiliey)
  • #2122 fix(v2): dont collapse whitespace in minified html (@endiliey)
• docusaurus-mdx-loader, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs
  • #2105 fix(v2): move metadata export after compiling MDX to avoid weird MDX parsing error. (@endiliey)
• docusaurus-theme-classic
  • #2113 fix(v2): set stored theme only if it exists (@lex111)

:nail_care: Polish

• docusaurus-theme-classic
  • #2129 fix(v2): disable scroll while mobile menu open (@lex111)
• docusaurus-theme-classic, docusaurus
  • #2127 refactor(v2): toggle data-theme with vanilla js instead of react helmet (@endiliey)
• docusaurus-theme-search-algolia, docusaurus
  • #2125 feat(v2): lazy load algolia css so its not render blocking (@endiliey)

:memo: 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
  • #2114 fix(v2): add syntax highlight to generated colors (@lex111)

:house: Internal

• Other
  • #2126 docs: promote Docusaurus 2 usage (@yangshun)
  • #2119 fix(v2): align GH button in vertical center (@lex111)
• docusaurus-init
  • #2124 feat(v2): add Facebook Docusaurus 2 template (@yangshun)
• docusaurus
  • #2111 feat(v2): explicit babel/runtime version (@endiliey)
• 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
  • #2102 misc: add command to run prettier on docs (@yangshun)

:running_woman: Performance

• docusaurus
  • #2118 perf(v2): reduce HTML payload by eliminating chunk-map (@endiliey)
  • #2116 feat(v2): minify html (@endiliey)

Committers: 6

• Alexey Pyltsyn (@lex111)
• Endi (@endiliey)
• Janko Marohnić (@janko)
• Nick McCurdy (@nickmccurdy)
• Yangshun Tay (@yangshun)
• t11s (@TransmissionsDev)

2.0.0-alpha.39 (2019-12-07)

:bug: Bug Fix

• docusaurus
  • #2099 fix(v2): escape import path on windows (@endiliey)
• docusaurus-plugin-content-blog, docusaurus-plugin-content-docs
  • #2095 fix(v2): metadata error if markdown does not have ending line (@endiliey)

:house: Internal

• Other
  • #2100 chore(CI): docusaurus build on Windows with GitHub actions (@endiliey)
• docusaurus
  • #2096 feat(v2): better & nice looking error overlay (@endiliey)

Committers: 1

• Endi (@endiliey)

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
  • #2088 perf(v2): smaller bundlesize by embedding metadata to content (@endiliey)

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

• docusaurus
  • #2086 fix(v2): windows compatibility regression (@endiliey)
• docusaurus-plugin-ideal-image
  • #2074 fix(v2): fix plugin-ideal-image breaking website (exports not defined) (@endiliey)

: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
  • #2081 refactor(v2): move scripts/stylesheets injection to server side (@endiliey)
  • #2080 refactor(v2): minor code refactoring on component creator (@endiliey)

:running_woman: Performance

• docusaurus-utils
  • #2089 perf(v2): improve dev build time by not overwriting file if possible (@endiliey)
• docusaurus-theme-search-algolia
  • #2079 perf(v2): algolia search result no longer cause full page refresh (@endiliey)
  • #2076 perf(v2): load algolia JS only when user interacts with search (@endiliey)

Committers: 4

• Endi (@endiliey)
• KYY (@FeynmanDNA)
• Shivangna Kaistha (@shivangna)
• kaichu (@qshiwu)

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
  • #2045 breaking(v2): minimum required nodejs version 8.9-> 8.10 so we can use es2017 (@endiliey)

:rocket: New Feature

• docusaurus-theme-classic, docusaurus
  • #2069 feat(v2): support prefers-color-scheme & fix dark mode FOUC on refresh (@endiliey)
• docusaurus-plugin-content-blog
  • #2000 feat(v2): add meta RSS/Atom feed links to head (@lex111)
• docusaurus-plugin-content-docs, docusaurus-types, docusaurus
  • #2057 feat(v2): injectHtmlTags API to inject head and/or body html tags (@endiliey)
• docusaurus-mdx-loader, docusaurus-plugin-content-docs, docusaurus-plugin-sitemap, docusaurus-theme-classic, docusaurus
  • #2032 feat(v2): allow non sidebar category to be first item of sidebar (@endiliey)
• docusaurus-plugin-content-docs, docusaurus-theme-classic, docusaurus-types, docusaurus
  • #1983 feat(v2): docs versioning ❄️🔥 (@endiliey)

:bug: Bug Fix

• docusaurus-theme-classic, docusaurus
  • #2069 feat(v2): support prefers-color-scheme & fix dark mode FOUC on refresh (@endiliey)
• docusaurus-mdx-loader
  • #2067 fix(v2): toc should not be broken for heading with html inline code (@endiliey)
• docusaurus-theme-classic
  • #2064 fix(v2): markdown reference to file should not be page not found (@endiliey)
  • #2061 fix(v2): fix docs sidebar highlighting if link is partially matched (@endiliey)
• docusaurus
  • #2042 fix(v2): remove css order warning if css imports are not sorted (@endiliey)

:nail_care: Polish

• docusaurus-theme-classic
  • #2066 refactor(v2): add title attribute to anchor link (@lex111)
  • #1990 refactor(v2): make better a11y for tabs (@lex111)
  • #2034 feat(v2): style sidebar on overflow (@endiliey)

: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-blog
  • #2072 refactor(v2): stronger typing for blog plugin (@endiliey)
• docusaurus
  • #2060 fix(v2): clean generated manifest from previous build so we dont use the wrong one (@endiliey)
  • #2033 refactor(v2): move unused generated files out from build folder (@endiliey)
• docusaurus-types, docusaurus
  • #2043 refactor(v2): stronger typing for route gen (@endiliey)
• docusaurus-mdx-loader, docusaurus-plugin-ideal-image, docusaurus-types, docusaurus
  • #2044 chore(v2): bump deps (@endiliey)
• docusaurus-init, docusaurus-mdx-loader, docusaurus-plugin-content-docs, docusaurus
  • #2029 chore(v2): bump deps and remove unused deps (@endiliey)

:running_woman: Performance

• docusaurus-plugin-google-analytics, docusaurus-plugin-google-gtag
  • #2070 perf(v2): more performant gtag and analytics plugin (@endiliey)
• docusaurus
  • #2046 perf(v2): use webpack future version of asset emitting logic to free memory (@endiliey)
  • #2039 perf(v2): replace unnecessary json stringify(string) with inline string (@endiliey)
  • #2035 perf(v2): use @babel/runtime plugin to reduce codesize (@endiliey)
• docusaurus-plugin-content-docs
  • #2054 perf(v2): unblock metadata processing when possible (@endiliey)

Committers: 5

• Alexey Pyltsyn (@lex111)
• Binary Logic (@binarylogic)
• Dongwoo Gim (@gimdongwoo)
• Endi (@endiliey)
• Wei Gao (@wgao19)