docusaurus-init

docusaurus-init

An initialization script for Docusaurus.

What does it do?

Docusaurus was designed from the ground up to be easily installed and used to get your website up an running quickly. To install Docusaurus, we have created an easy script that will get all of the infrastructure setup for you:

1. Have Node >= 8.x installed. Yarn >= 1.5 is recommended as well.
2. Go into the root of your GitHub repo directory where you will be creating the docs.
3. npx docusaurus-init

If you don't have Node 8.2+ or if you prefer to install Docusaurus globally, run yarn global add docusaurus-init or npm install --global docusaurus-init. After that, run docusaurus-init.

Find out more in the official docs.

Changelog

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)