Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →

create-docusaurus

Package Overview

Dependencies

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

create-docusaurus

Create Docusaurus apps easily.

2.0.0-beta.7
Source
npm

Version published: 3 years ago

Weekly downloads: 3.2K; increased by3.66%

Maintainers: 6

Weekly downloads

Created: 3 years ago

Source

`create-docusaurus`

Create Docusaurus apps easily with simplified commands:

npm init docusaurus

yarn create docusaurus

Usage

Please see the installation documentation.

For maintainers

For Docusaurus maintainers, templates can be tested with:

cd `git rev-parse --show-toplevel` # Back to repo root
rm -rf test-website
yarn create-docusaurus test-website classic
cd test-website
yarn start

Note: test-website is not part of the workspace and use packages from npm.

Use the following to test the templates against local packages:

cd `git rev-parse --show-toplevel` # Back to repo root
rm -rf test-website-in-workspace
yarn create-docusaurus test-website-in-workspace classic
cd test-website-in-workspace
yarn start

2.0.0-beta.7 (2021-10-15)

:rocket: New Feature

docusaurus-module-type-aliases, docusaurus
- #5683 feat: make Translate children optional (@lex111)
docusaurus-theme-classic, docusaurus-theme-common
- #5674 polish(theme-classic): guard against potential definition mistakes in Tabs (@Josh-Cena)
- #5618 feat: maintain page position for clicked grouped tabs (@Shrugsy)
docusaurus-plugin-content-blog, docusaurus-utils
- #4330 feat(content-blog): add full blog post html into RSS/Atom feeds (@moonrailgun)
docusaurus-plugin-content-docs, docusaurus-theme-classic, docusaurus-theme-common
- #5642 feat(theme-classic, plugin-docs): sidebar item level-specific className + allow customization (@Josh-Cena)
create-docusaurus
- #5635 feat: npm init docusaurus, yarn create docusaurus (@slorber)
docusaurus-init, docusaurus-mdx-loader, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-plugin-sitemap, docusaurus-preset-classic, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-types
- #5589 feat: properly type-check the Docusaurus config of new sites (@bmiddha)
docusaurus-mdx-loader, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-types, docusaurus-utils-validation
- #5578 feat(v2): allow specifying TOC max depth (themeConfig + frontMatter) (@erickzhao)
docusaurus
- #5498 feat: make Webpack url-loader limit configurable (env variable) (@stnor)
docusaurus-plugin-content-blog, docusaurus-plugin-content-docs
- #5545 feat: make tags route path configurable (@lex111)

:boom: Breaking Change

docusaurus-theme-classic, docusaurus-theme-common
- #5674 polish(theme-classic): guard against potential definition mistakes in Tabs (@Josh-Cena)
- #5618 feat: maintain page position for clicked grouped tabs (@Shrugsy)
docusaurus-init, docusaurus-preset-bootstrap, docusaurus-theme-bootstrap
- #5634 chore: remove unused Bootstrap theme (@slorber)
docusaurus-mdx-loader, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-types, docusaurus-utils-validation
- #5578 feat(v2): allow specifying TOC max depth (themeConfig + frontMatter) (@erickzhao)
docusaurus-theme-classic
- #5592 refactor: use CSS Modules for toggle styles (@lex111)

:bug: Bug Fix

docusaurus-theme-common
- #5694 fix: proper collapsing of long element (@lex111)
docusaurus
- #5684 fix: use realpath for site dir to resolve symlink (@lex111)
- #5645 fix: place root route at the end (@lex111)
- #5629 fix: text/link hydration bug (@slorber)
docusaurus-theme-classic, docusaurus-theme-common
- #5699 fix: apply announcement bar class if only needed (@lex111)
docusaurus-theme-classic
- #5667 fix: expand tag column on truncated post (@lex111)
- #5668 fix: preserve line breaks when copy code in Firefox (@lex111)
- #5647 feat(theme-classic): make first tab the default tab (@Josh-Cena)
- #5652 fix: restore duplicate Tabs rendering to fix hydration issue (@slorber)
- #5643 fix(theme-classic): reset default style for task lists (@EkaterinaMozheiko)
- #5571 fix: highlight active item in recent post list (@lex111)
- #5481 fix: use heading itself as anchor for better crawling (@lex111)
docusaurus-theme-live-codeblock
- #5677 fix: Don't ignore options.transforms for buble (@ntucker)
- #5556 fix: pin react-live due to possible mismatch React (@lex111)
docusaurus-mdx-loader
- #5690 fix: preserve hash in asset link (@lex111)
docusaurus-plugin-ideal-image
- #5540 fix: do not use ideal image plugin in dev env (@lex111)
docusaurus-plugin-content-docs
- #5606 fix(docs): create tags route if only tags exists (@lex111)
docusaurus-init, docusaurus-module-type-aliases, docusaurus-types
- #5601 fix(module-type-aliases): move @type packages to dependencies (@Josh-Cena)
docusaurus-utils
- #5495 fix: ignore code block lines when creating excerpt (@lex111)
docusaurus-init
- #5490 fix: install deps for new project via Yarn on Windows properly (@lex111)
docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-utils-validation
- #5479 fix: add docs tag validation to solve #5478 (@sw-yx)

:nail_care: Polish

docusaurus-theme-classic, docusaurus-theme-common
- #5709 refactor: cleanup scroll handlers (@lex111)
- #5627 refactor: various TOC improvements (@lex111)
- #5469 refactor: Adjust styling of back top top button (@dsmmcken)
docusaurus-theme-classic
- #5708 refactor: hide hash link from crawlers (@lex111)
- #5649 refactor: improve pt-BR translation for classic theme (@printf-ana)
- #5646 refactor: complete missing and fix ES translations (@caleeli)
- #5640 style: update Persian language translations (@MrTechHunter)
- #5630 refactor: standardize using media queries (@lex111)
- #5487 refactor: use only one close SVG icon (@lex111)
- #5592 refactor: use CSS Modules for toggle styles (@lex111)
- #5485 polish: prevent pop navigation on back if navbar sidebar is open (@slorber)
- #5472 polish(theme-classic): add Chinese translations (@Josh-Cena)
docusaurus-module-type-aliases, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-plugin-debug, docusaurus-theme-classic, docusaurus-types, docusaurus
- #5636 refactor: make all Props defined as interface + readonly (@Josh-Cena)
docusaurus-mdx-loader, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-remark-plugin-npm2yarn, docusaurus-theme-bootstrap, docusaurus-theme-classic, docusaurus-theme-common, docusaurus
- #5560 polish: remove unused eslint-disable (@Josh-Cena)
docusaurus
- #5580 refactor(core): type improvements for PendingNavigation (@Josh-Cena)
docusaurus-theme-classic, docusaurus
- #5496 refactor: remove deprecated createRequireFromPath (@lex111)

:memo: Documentation

#5681 docs(v2): Add CountryStateCityAPI site to showcase page (@dr5hn)
#5661 docs: updated cloudywithachanceofbigdata.com blog showcase (@jeffreyaven)
#5658 docs: Algolia plugin must be enabled before crawling the site (@slorber)
#5654 docs: Add Warrant Docs site to showcase page (@akajla09)
#5655 docs: Added cloudywithachanceofbigdata.com showcase blog (@jeffreyaven)
#5648 docs: add ory documentation to showcase (@vinckr)
#5644 docs: add djamaile blog to site showcase (@djamaile)
#5641 docs: add Lux Algo to showcase (@Josh-Cena)
#5638 docs: add nanos world docs to showcase (@gtnardy)
#5610 docs: Add IOTA wiki to showcase (@Dr-Electron)
#5489 docs: add additional search options, typesense and local search (@jasonbosco)
#5590 docs(website): document npm2yarn plugin + use new Tabs API everywhere (@Josh-Cena)
#5591 docs: Add whirl.codes to showcase (@Whirl21)
#5574 docs: add Pipeline UI to showcase (@headline-design)
#5585 docs: fix more references to Discord channels (@Josh-Cena)
#5572 docs: add Blogasaurus to showcase (@BattleOfPlassey)
#5575 docs: clarify MDX version used (@lex111)
#5581 docs(website): update all Discord links (@Josh-Cena)
#5566 docs: fix code example (@ChrisChinchilla)
#5559 docs: minor grammatical correction (@jkhaui)
#5543 docs: add note about files being ignored when prefixed with an unders… (@KyrietS)
#5549 docs: Add Mint Metrics site to the Showcase (@kingo55)
#5546 docs: add unleash to showcase (@ivarconr)
#5539 docs: improve escape pipe in Markdown tables (@forresst)
#5486 docs: mention Netlify ignore build setting (@slorber)
#5482 docs: update docusaurus-plugin-relative-paths description (@ohkimur)

:house: Internal

create-docusaurus, docusaurus-plugin-content-docs
- #5678 refactor(content-docs): refactor sidebars, Joi validation, generator rework, expose config types (@Josh-Cena)
docusaurus-theme-classic
- #5666 chore: upgrade Infima to alpha.34 (@lex111)
- #5639 misc: update base translation + remove extra char (@lex111)
Other
- #5669 fix: allow ColorGenerator to parse colors with prefix # (@Andrewnt219)
- #5632 chore: prepare Algolia migration (@slorber)
- #5628 chore: fix warning after build (@lex111)
- #5573 misc: fix ungrammatical sentence about 5-min tutorial (@hughlilly)
- #5499 chore: set up CodeQL (@zpao)
- #5474 chore: remove beta.4 docs (already archived) (@slorber)
docusaurus-init, docusaurus-preset-bootstrap, docusaurus-theme-bootstrap
- #5634 chore: remove unused Bootstrap theme (@slorber)
docusaurus-init, docusaurus-mdx-loader, docusaurus-migrate, docusaurus-module-type-aliases, docusaurus-plugin-client-redirects, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-pwa, docusaurus-plugin-sitemap, docusaurus-preset-classic, docusaurus-theme-bootstrap, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-types, docusaurus-utils, docusaurus, lqip-loader
- #5611 chore: upgrade Prettier + regenerate lock file (@Josh-Cena)
docusaurus-plugin-pwa, docusaurus
- #5609 chore: upgrade Terser-related dependencies (@lex111)
docusaurus-cssnano-preset, docusaurus-init, docusaurus-mdx-loader, docusaurus-migrate, docusaurus-plugin-client-redirects, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-plugin-debug, docusaurus-plugin-ideal-image, docusaurus-plugin-pwa, docusaurus-plugin-sitemap, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-theme-live-codeblock, docusaurus-theme-search-algolia, docusaurus-types, docusaurus-utils-common, docusaurus-utils-validation, docusaurus-utils, docusaurus, lqip-loader
- #5608 chore: upgrade dependencies (@lex111)
docusaurus
- #5605 refactor(core): enforce noImplicitAny (@Josh-Cena)
docusaurus-preset-classic
- #5603 fix(preset-classic): fix TS build issue (@slorber)
docusaurus-plugin-google-analytics, docusaurus-plugin-google-gtag, docusaurus-preset-classic
- #5561 refactor(plugin-google-gtag, plugin-google-analytics): migrate packages to TS (@Josh-Cena)
docusaurus-mdx-loader, docusaurus-plugin-content-blog, docusaurus-plugin-content-pages, docusaurus-plugin-sitemap, docusaurus-preset-classic
- #5579 refactor(preset-classic): migrate preset-classic to TypeScript (@Josh-Cena)
docusaurus-init
- #5484 chore: regenerate beta.6 examples + fix regen script (@slorber)

Committers: 36

Aditya Kajla (@akajla09)
Alexey Pyltsyn (@lex111)
Ana Carolina (@printf-ana)
Andrew Nguyen (@Andrewnt219)
Bharat Middha (@bmiddha)
Chris Chinchilla (@ChrisChinchilla)
Daniel Costrasel (@ohkimur)
Darshan Gada (@dr5hn)
David Callizaya (@caleeli)
Don (@dsmmcken)
Ekaterina Mozheiko (@EkaterinaMozheiko)
Erick Zhao (@erickzhao)
Forresst (@forresst)
Gabriel T. Nardy (@gtnardy)
Hugh Lilly (@hughlilly)
Ivar Conradi Østhus (@ivarconr)
Jason Bosco (@jasonbosco)
Jeffrey Aven (@jeffreyaven)
Jordan Lee (@jkhaui)
Joshua Chen (@Josh-Cena)
Kyriet (@KyrietS)
Mahdi Hamldar (@MrTechHunter)
Nathaniel Tucker (@ntucker)
Palash Shrivastava (@BattleOfPlassey)
Paul O’Shannessy (@zpao)
Robert Kingston (@kingo55)
Stefan Norberg (@stnor)
Sébastien Lorber (@slorber)
Vincent (@vinckr)
Whirl (@Whirl21)
@Dr-Electron
@Shrugsy
@djamaile
@headline-design
moonrailgun (@moonrailgun)
swyx (@sw-yx)

FAQs

What is create-docusaurus?

Is create-docusaurus popular?

Is create-docusaurus well maintained?

Package last updated on 15 Oct 2021

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install