mirror of
https://github.com/facebook/docusaurus.git
synced 2025-05-03 04:07:32 +02:00
d1418af5ba
- generated site to match what is described in the doc - minor changes in the installation page
47 lines
1.4 KiB
Markdown
47 lines
1.4 KiB
Markdown
---
|
|
id: installation
|
|
title: Installation
|
|
---
|
|
|
|
The easiest way to install Docusaurus is to use the command line tool that helps you scaffold a Docusaurus site skeleton. You can run this command anywhere in a new empty repository or within an existing repository, it will create a new directory containing the scaffolded files.
|
|
|
|
```bash
|
|
npx @docusaurus/core@next init [name] [template]
|
|
```
|
|
|
|
If you do not specify `name` or `template`, it will prompt you for the missing inputs. We recommend the `classic` template so that you can get started quickly. The `classic` template comes with standard documentation, blog and custom pages features.
|
|
|
|
## Project Structure
|
|
|
|
Assuming you chose the classic template and named your site `my-website`, you will see the following files generated under a new directory `my-website/`:
|
|
|
|
```sh
|
|
my-website
|
|
├── docs
|
|
│ ├── doc1.md
|
|
│ ├── doc2.md
|
|
│ ├── doc3.md
|
|
│ └── mdx.md
|
|
├── blog
|
|
│ ├── 2019-05-29-hello-world.md
|
|
│ └── 2020-05-30-welcome.md
|
|
├── package.json
|
|
├── pages
|
|
│ └── index.js
|
|
├── sidebars.json
|
|
├── docusaurus.config.js
|
|
├── static
|
|
│ └── img
|
|
└── yarn.lock
|
|
```
|
|
|
|
## Running the Development Server
|
|
|
|
```bash
|
|
cd my-website
|
|
npm start
|
|
```
|
|
|
|
By default, a browser window will open at http://localhost:3000.
|
|
|
|
Congratulations! You have just created your first Docusaurus site! Browse around the site to see what's available.
|