mirror of
https://github.com/facebook/docusaurus.git
synced 2025-04-30 02:37:59 +02:00
In this tutorial we assume that the user may or may not have used Node.js. It would follow then, based on how long it takes the "Linking dependencies" step to complete—243.61s for me—that we give them a hint that it might take a minute.
2 KiB
2 KiB
id | title |
---|---|
tutorial-create-new-site | Create a New Site |
In this section we'll get our Docusaurus site up and running for local development. The process takes less than a few minutes.
Scaffold the Site
- Execute the
docusaurus-init
command in your terminal.
docusaurus-init
The
Linking dependencies...
step might take a while, but it will finish eventually.
The following contents will be created for you in the directory you are in.
├── 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
There would be some example documentation and blog pages generated.
- Run
cd website
to go into thewebsite
directory. - Run
npm start
oryarn start
.
A browser window will open up at http://localhost:3000.
Congratulations, you have just made your first Docusaurus site! Click around the pages generated for you to see what's available.