mirror of
https://github.com/facebook/docusaurus.git
synced 2025-05-18 03:26:57 +02:00
chore(v1): move v1 docs inside website-1.x (#3504)
* move v1 docs in website-1.x * fix editUrl after moving v1 docs * update crowdin source for v1 docs * fix test after v1 config change * migration cli should support customDocsPath (fix v1->v2 integration tests) * fix migrationConfig.test.ts
This commit is contained in:
parent
85ff9bd33a
commit
41ff9a9fd0
27 changed files with 77 additions and 419 deletions
72
website-1.x/docs/tutorial-create-new-site.md
Normal file
72
website-1.x/docs/tutorial-create-new-site.md
Normal file
|
@ -0,0 +1,72 @@
|
|||
---
|
||||
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 only takes a few minutes.
|
||||
|
||||
<img alt="Docusaurus browser" src="/img/undraw_docusaurus_browser.svg" class="docImage"/>
|
||||
|
||||
## Scaffold the Site
|
||||
|
||||
1. `cd` to the directory of your local repository.
|
||||
|
||||
```sh
|
||||
cd docusaurus-tutorial
|
||||
```
|
||||
|
||||
2. Execute the `docusaurus-init` command in your terminal.
|
||||
|
||||
```sh
|
||||
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.
|
||||
|
||||
```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
|
||||
```
|
||||
|
||||
3. Run `cd website` to go into the `website` directory.
|
||||
4. 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 to get a feel for it.
|
Loading…
Add table
Add a link
Reference in a new issue