From 6dc673e87e94b7b4febbc29343e2e71b57d3b9a0 Mon Sep 17 00:00:00 2001 From: Website Deployment Script Date: Mon, 23 Apr 2018 07:17:46 +0000 Subject: [PATCH] Deploy website Deploy website version based on 3038887df4c3d6c31a91fcd636d68853b0bc1b9b --- docs/en/next/installation.html | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/docs/en/next/installation.html b/docs/en/next/installation.html index b55ac4b0dc..ecc96f7fdf 100644 --- a/docs/en/next/installation.html +++ b/docs/en/next/installation.html @@ -11,12 +11,15 @@

While we recommend Node 8.x or greater, your Node version must at least 6.x.

  • Go into the root of your GitHub repo directory where you will be creating the docs.

  • -
  • yarn global add docusaurus-init or npm install --global docusaurus-init

  • -
  • docusaurus-init

  • +
  • npx docusaurus-init

    +
    +

    If you don't have Node 8.2+ or if you prefer to install Docusaurus globally, run yarn global add docusaurus-init or npm install --global docusaurus-init. After that, run docusaurus-init.

    +
  • -

    After docusaurus is installed, moving forward, you can check your current version of Docusaurus by going into the website directory and typing npm list docusaurus. You can update to the latest version of Docusaurus by typing npm update.

    +

    After Docusaurus is installed, moving forward, you can check your current version of Docusaurus by going into the website directory and typing yarn outdated docusaurus or npm outdated docusaurus. You can update to the latest version of Docusaurus by typing yarn upgrade docusaurus --latest or npm update docusaurus.

    +

    Verifying Installation

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

    root-of-repo
     ├── docs-examples-from-docusaurus
    @@ -38,10 +41,6 @@
     │   └── siteConfig.js
     │   └── static
     
    -
    -

    If you do not want to install the init script globally, you can install it locally and then run it via npx docusaurus-init or 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.

    -
    -

    Verifying Installation

    Running the Docusaurus initialization script, docusaurus-init, produces a runnable, example website to base your site upon.

    1. In your root, rename docs-examples-from-docusaurus to docs.