๐ฆ create-docusaurus
๋ฐ๋ก ํ์ฉํ ์ ์๋ ๋ํ์ฌ์ฐ๋ฃจ์ค ์ฑ์ ์ฆ์ ์ค์ ํ๋๋ฐ ๋์์ด ๋๋ ์ค์บํด๋ฉ ์ ํธ์ ๋๋ค.
Usageโ
npx create-docusaurus@latest [name] [template] [rootDir]
The name
argument will be used as the site's path as well as the name
field in the created app's package.json. It can be an absolute path, or a path relative to rootDir
.
The template
argument can be one of the following:
classic
: Uses the classic template (recommended)facebook
: Uses the Facebook/Meta template, which contains some Meta-specific setup- A git repo URL (beginning with
https://
orgit@
), which can be cloned to the destination - ์ํ๋ ๊ณณ์ ๋ณต์ฌํ ํ์ผ์ด ํฌํจ๋ CWD์ ๋ํ ๋ก์ปฌ ํ์ผ ๊ฒฝ๋ก
The rootDir
will be used to resolve the absolute path to the site directory. ๊ธฐ๋ณธ๊ฐ์ CWD์
๋๋ค.
์ด ๋ช ๋ น์ ๋ชจ๋ ๊ธฐ๋ฅ์ ์ฌ์ฉํ ์ ์๋๋ก ๋ํํ ์์์ ์ฌ์ฉํ๋ ๊ฒ์ ๊ถ์ฅํฉ๋๋ค.
Optionsโ
-t, --typescript
โ
ํ
ํ๋ฆฟ ์ธ์๊ฐ ์ธ์๋ ์ด๋ฆ์ผ ๋ ์ฌ์ฉํฉ๋๋ค. Currently, only classic
provides a TypeScript variant.
-g, --git-strategy
โ
ํ ํ๋ฆฟ ์ธ์๊ฐ ๊น ์ ์ฅ์์ผ ๋ ์ฌ์ฉํฉ๋๋ค. ๋ค์ ์ค ํ๋๋ฅผ ์ฌ์ฉํ ์ ์์ต๋๋ค.
deep
: preserves full git historyshallow
: clones with--depth=1
copy
: does a shallow clone, but does not create a git repocustom
: enter your custom git clone command. ์ ๋ ฅ์ ์ํ ๊ฐ์ด๋๋ฅผ ์ง์ํฉ๋๋ค. You can write something likegit clone --depth 10
, and we will append the repository URL and destination directory.
-p, --package-manager
โ
Value should be one of npm
, yarn
, pnpm
, or bun
. ๋ช
์์ ์ผ๋ก ๊ฐ์ ์ค์ ํ์ง ์์ผ๋ฉด ๋ํ์ฌ์ฐ๋ฃจ์ค๋ ๋ค์ ๊ธฐ์ค์ ๋ฐ๋ผ ์ฒ๋ฆฌํฉ๋๋ค.
- CWD์ ์ด๋ฏธ ์๋ lockfile(์: ๊ธฐ์กด ํ๋ก์ ํธ์์ ์น์ฌ์ดํธ๋ฅผ ์ค์ ํ๋ ๊ฒฝ์ฐ)
- The command used to invoke
create-docusaurus
(e.g.npm init
,npx
,yarn create
,bunx
, etc.) - ์ด์ ์ ์ฌ์ฉํ ์ ์๋ ๊ฒฝ์ฐ๋ผ๋ฉด ๋ํํ ํ๋กฌํํธ
-s, --skip-install
โ
์ต์
์ ์ง์ ํ๋ฉด ๋ํ์ฌ์ฐ๋ฃจ์ค๋ ์ฑ ์์ฑ ํ ์ข
์์ฑ์ ์๋์ผ๋ก ์ค์นํ์ง ์์ต๋๋ค. The --package-manager
option is only useful when you are actually installing dependencies.