15308555518/ docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-12-26 09:43:10 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

chore(v2): tweak installation doc (#1621) 

- generated site to match what is described in the doc
- minor changes in the installation page
This commit is contained in:
Wei Gao 2019-06-24 01:32:10 +08:00 committed by Yangshun Tay
parent db44eccac3
commit d1418af5ba
3 changed files with 6 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
packages/docusaurus/templates/classic/docs/doc1.md
View File

@ -1,7 +1,7 @@
---
id: doc1
title: Latin-ish
sidebar_label: Write Markdown
title: Style Guide
sidebar_label: Style Guide
---
You can write content using [GitHub-flavored Markdown syntax](https://github.github.com/gfm/).

6
packages/docusaurus/templates/classic/docs/exampledoc4.md
View File

@ -1,6 +0,0 @@
---
id: doc4
title: Other Document
---
This is another document.

9
website/docs/installation.md
View File

@ -6,10 +6,10 @@ 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
npx @docusaurus/core@next init [name] [template]
```
It will then prompt you for the `name` and the `template` for your Docusaurus site. We recommend the `classic` template so that you can get started quickly. The `classic` template comes with standard documentation, blog and custom pages features.
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
@ -21,8 +21,7 @@ my-website
│ ├── doc1.md
│ ├── doc2.md
│ ├── doc3.md
│ ├── exampledoc4.md
│ └── exampledoc5.md
│ └── mdx.md
├── blog
│ ├── 2019-05-29-hello-world.md
│ └── 2020-05-30-welcome.md
@ -43,6 +42,6 @@ cd my-website
npm start
```
A browser window will open at http://localhost:3000.
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.