From ee8c802fa48b5b6c1cfef806fa668d7cea8152c9 Mon Sep 17 00:00:00 2001 From: Website Deployment Script Date: Tue, 13 Feb 2018 02:05:23 +0000 Subject: [PATCH] Deploy website Deploy website version based on a81d7e0b00bb8ebe18bfecbceaae39914c6ab42b --- docs/en/installation.html | 13 ++++++++++++- docs/en/site-preparation.html | 10 ---------- 2 files changed, 12 insertions(+), 11 deletions(-) diff --git a/docs/en/installation.html b/docs/en/installation.html index 3440296528..7d9380ae9a 100644 --- a/docs/en/installation.html +++ b/docs/en/installation.html @@ -9,8 +9,9 @@
  • 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
  • +
  • Verify the installation +Along with previously existing files and directories, your root directory will now contain a structure similar to:
  • -

    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
    @@ -34,6 +35,16 @@
     

    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.
    2. +
    3. cd website
    4. +
    5. Rename blog-examples-from-docusaurus to blog.
    6. +
    7. Run the local webserver via yarn start or npm start.
    8. +
    9. Load the example site at http://localhost:3000. You should see the example site loaded in your web browser.
    10. +
    +