mirror of
https://github.com/facebook/docusaurus.git
synced 2025-05-02 03:37:48 +02:00
66 lines
1.9 KiB
Markdown
66 lines
1.9 KiB
Markdown
---
|
|
id: tutorial-create-new-site
|
|
title: 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.
|
|
|
|
<img alt="Docusaurus browser" src="/img/undraw_docusaurus_browser.svg" class="docImage"/>
|
|
|
|
## Scaffold the Site
|
|
|
|
1. Execute the `docusaurus-init` command in your terminal.
|
|
|
|
```sh
|
|
docusaurus-init
|
|
```
|
|
|
|
The following contents will be created for you in the directory you are in.
|
|
|
|
```sh
|
|
├── 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.
|
|
|
|
2. Run `cd website` to go into the `website` directory.
|
|
1. Run `npm start` or `yarn 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.
|