Create a New Site
In this section, we'll get our Docusaurus site up and running for local development. The process only takes a few minutes.
{.docImage}
Scaffold the Site
cd
to the directory of your local repository.
cd docusaurus-tutorial
- 在你的终端命令行中执行
docusaurus-init
指令初始化构建。
docusaurus-init
The
Linking dependencies...
step might take a while, but it will finish eventually.
The following contents will be created in your current directory. Some example documentation pages (under docs
) and blog posts (under website/blog
) are included.
├── Dockerfile
├── docker-compose.yml
├── docs
│ ├── doc1.md
│ ├── doc2.md
│ ├── doc3.md
│ ├── exampledoc4.md
│ └── exampledoc5.md
└── website
├── README.md
├── blog
│ ├── 2016-03-11-blog-post.md
│ ├── 2017-04-10-blog-post-two.md
│ ├── 2017-09-25-testing-rss.md
│ ├── 2017-09-26-adding-rss.md
│ └── 2017-10-24-new-version-1.0.0.md
├── core
│ └── Footer.js
├── package.json
├── pages
│ └── en
│ ├── help.js
│ ├── index.js
│ └── users.js
├── sidebars.json
├── siteConfig.js
├── static
│ ├── css
│ │ └── custom.css
│ └── img
│ ├── docusaurus.svg
│ ├── favicon
│ │ └── favicon.ico
│ ├── favicon.png
│ └── oss_logo.png
└── yarn.lock
- 在终端中运行
cd website
指令进入website
目录。 - 运行
npm start
指令或者yarn start
指令。
一个浏览器窗口将在 http://localhost:3000打开。
恭喜,您刚刚完成了您的第一个Docusaurus网站! Click around the pages to get a feel for it.