diff --git a/docs/en/installation.html b/docs/en/installation.html index 17dcc36ed7..6269a9bfbb 100644 --- a/docs/en/installation.html +++ b/docs/en/installation.html @@ -1,30 +1,38 @@ -Installation · Docusaurus

Docusaurus

Edit

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:

+
Edit

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, we have created an easy script that will get all of the infrastructure setup for you:

    -

  1. Create a website folder in the root of your GitHub repo.

    2. -

  2. cd website

    3. -

  3. Create a package.json file with the following scripts that will be used when developing documentation with Docusaurus:

    -
    {
-  "scripts": {
-    "start": "docusaurus-start",
-    "build": "docusaurus-build",
-    "publish-gh-pages": "docusaurus-publish",
-    "examples": "docusaurus-examples"
-  }
-}
-
    4. -

  4. Install Docusaurus with yarn or npm

    -
    yarn add docusaurus -dev
-
    -

    or

    -
    npm install --save-dev docusaurus
-
    5. +
  5. Go into the root of your GitHub repo directory where you will be creating the docs.
    6. +
  6. yarn global add docusaurus-init or npm install --global docusaurus-init
    7. +
  7. docusaurus-init
+

Along with previously existing files and directories, your root directory will now contain a structure similar to:

+
root-of-repo
+├── docs-examples-from-docusaurus
+│   └── doc1.md
+│   └── doc2.md
+│   └── doc3.md
+│   └── exampledoc4.md
+│   └── exampledoc5.md
+└── website
+│   └── blog-examples-from-docusaurus
+│       └── 2016-03-11-blog-post.md
+│       └── 2017-04-10-blog-post-two.md
+│   └── core
+│   └── node_modules
+│   └── package.json
+│   └── pages
+│   └── sidebars.json
+│   └── siteConfig.js
+│   └── static
+
+
+

If you do not want to install the init script globally, you can install it locally and then run it from the node_modules directory that is created via ./node_modules/.bin/docusaurus-init. You may want to remove the created package.json file and node_modules directory after you run the script.

+
Site Preparation →