mirror of
https://github.com/facebook/docusaurus.git
synced 2025-08-03 16:59:06 +02:00
Add installation guide (#36)
This commit is contained in:
parent
b8af2f010d
commit
21a7fab937
2 changed files with 33 additions and 0 deletions
32
docs/getting-started-installation.md
Normal file
32
docs/getting-started-installation.md
Normal file
|
@ -0,0 +1,32 @@
|
|||
---
|
||||
id: installation
|
||||
title: Installation
|
||||
---
|
||||
|
||||
Docusaurus was designed from the ground up to be easily installed and used to get your website up an running quickly. To install Docusaurus, follow these steps:
|
||||
|
||||
1. Create a `website` folder in the root of your GitHub repo.
|
||||
1. `cd website`
|
||||
1. Create a `package.json` file with the following scripts that will be used when developing documentation with Docusaurus:
|
||||
|
||||
```json
|
||||
{
|
||||
"scripts": {
|
||||
"start": "docusaurus-start",
|
||||
"build": "docusaurus-build",
|
||||
"publish-gh-pages": "docusaurus-publish",
|
||||
"examples": "docusaurus-examples"
|
||||
}
|
||||
}
|
||||
```
|
||||
1. Install Docusaurus with `yarn` or `npm`
|
||||
|
||||
```
|
||||
yarn add docusaurus -dev
|
||||
```
|
||||
|
||||
or
|
||||
|
||||
```
|
||||
npm install --save-dev docusaurus
|
||||
```
|
|
@ -1,6 +1,7 @@
|
|||
{
|
||||
"docs": {
|
||||
"Getting Started": [
|
||||
"installation",
|
||||
"getting-started"
|
||||
],
|
||||
"Guides": [
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue