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.65 (2020-10-02)

:rocket: New Feature

• docusaurus
  • #3497 feat(v2): env variable TERSER_PARALLEL to customize TerserPlugin.parallel (@aeneasr)
  • #3446 feat(v2): new docusaurus clear command (@abadon7)
  • #3485 feat(v2): Add @theme-init components to user theme (@edno)
• docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages
  • #3467 feat(v2): add beforeDefaultRemarkPlugins/beforeDefaultRehypePlugins options to all md content plugins (@ayshiff)
• docusaurus-init, docusaurus-theme-bootstrap
  • #3496 feat(v2): migrate bootstrap components to ts (@slorber)
• docusaurus-theme-classic
  • #3474 feat(v2): allow to use array of files in customCss field (@Simek)
• docusaurus-plugin-content-pages, docusaurus-theme-classic
  • #3457 feat(v2): add optional custom wrapper class name for pages based on theme classic Layout (@Simek)

:bug: Bug Fix

• Other
  • #3517 fix(v1): v1 deploy preview should be available (@slorber)
• docusaurus
  • #3498 fix(v2): fixed props being passed to @svgr/webpack loader (@anru)
• docusaurus-theme-search-algolia
  • #3456 fix(v2): use valid value for crossorigin attribute (@lex111)
• docusaurus-utils
  • #3427 fix(v2): normalizeUrl edge cases (@ayshiff)
• docusaurus-theme-classic
  • #3472 fix(v2): Show dropdown instead of a single button when there are two versions (@SamChou19815)
• docusaurus-plugin-content-docs
  • #3441 fix(v2): fixing typo in error message (@ayonious)

:nail_care: Polish

• docusaurus-theme-classic
  • #3499 chore(v2): upgrade Infima to 0.2.0-alpha.13 (@lex111)

:memo: Documentation

• docusaurus
  • #3502 docs(v2): add doc for wrapping theme components with @theme-original and @theme-init (@slorber)
• Other
  • #3473 misc: add License to the documentation (@muskanvk)
  • #3492 docs(v2): Added drone.io publish docs #3491 (@aakhtar3)
  • #3479 docs(v2): remove redundant new line in code block (@lex111)
  • #3448 chore(v2): fix theme classic navbar style docs (@Simek)

:house: Internal

• docusaurus-1.x, docusaurus-migrate
  • #3504 chore(v1): move v1 docs inside website-1.x (@slorber)
• Other
  • #3506 chore(v2): v2 website should make it easy to contribute to upstream docs (@slorber)
  • #3511 misc: update CODEOWNERS (@yangshun)
  • #3477 chore(v2): remove alpha 58 doc (@lex111)
• docusaurus-utils-validation
  • #3453 test(v2): add protocol relative uri validation test (@moonrailgun)

Committers: 18

• Alexey Pyltsyn (@lex111)
• Andrey Rublev (@anru)
• Bartosz Kaszubowski (@Simek)
• Grégory Heitz (@edno)
• Henry Vélez (@abadon7)
• Jeremy Hager (@jeremyhager)
• Joel Marcey (@JoelMarcey)
• Long Ho (@longlho)
• Muskan Kumar (@muskanvk)
• Nahiyan Kamal (@ayonious)
• Rémi Doreau (@ayshiff)
• Sam Zhou (@SamChou19815)
• Sébastien Lorber (@slorber)
• Tim Gates (@timgates42)
• Yangshun Tay (@yangshun)
• @aakhtar3
• hackerman (@aeneasr)
• moonrailgun (@moonrailgun)