diff --git a/docs/en/next/installation.html b/docs/en/next/installation.html index c764763079..40314ddcca 100644 --- a/docs/en/next/installation.html +++ b/docs/en/next/installation.html @@ -1,4 +1,4 @@ -Installation · Docusaurus
Edit

Installation

Docusaurus was designed from the ground up to be easily installed and used to get your website up and running quickly. To install Docusaurus, we have created an easy script that will get all of the infrastructure set up for you:

+
Edit

Installation

Docusaurus was designed from the ground up to be easily installed and used to get your website up and running quickly.

+

Installing Docusaurus

+

We have created an easy script that will get all of the infrastructure set up for you:

  1. Ensure you have the latest version of Node installed. We also recommend you install Yarn as well.

    You have to be on Node >= 8.x and Yarn >= 1.5.

    2. -

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

    3. -

  3. npx docusaurus-init

    +

  4. Change directory to the root of your project's GitHub repo.

    +

    You will be creating the docs in this directory. The root directory may +contain other files. The Docusaurus installation script will create two new +directories: docs-examples-from-docusaurus and website.

    5. +

  5. Run the Docusaurus installation script: 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.

    6. @@ -83,13 +88,19 @@ ├── siteConfig.js └── static -

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

    +

    Running the example website

    +

    After running the Docusaurus initialization script, docusaurus-init as +described in the Installation section, you will have a +runnable, example website to use as your site's base. To run:

      -
    1. In your root, rename docs-examples-from-docusaurus to docs.
      2. -
    2. cd website
      3. -
    3. Rename blog-examples-from-docusaurus to blog.
      4. -
    4. Run the local webserver via yarn start or npm start.
      5. -
    5. Load the example site at http://localhost:3000. You should see the example site loaded in your web browser. There's also a LiveReload server running and any changes made to the docs and files in the website directory will cause the page to refresh.
      6. +

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

      7. +

    7. cd website

      8. +

    8. Rename blog-examples-from-docusaurus to blog.

      9. +

    9. From within the website directory, run the local webserver using +yarn start or npm start.

      10. +

    10. Load the example site at http://localhost:3000 if it did not already open +automatically.

      +

      You should see the example site loaded in your web browser. There's also a LiveReload server running and any changes made to the docs and files in the website directory will cause the page to refresh.

    Launching the server behind a proxy

    @@ -98,7 +109,7 @@ yarn start (or npm run start)

    Updating Your Docusaurus Version

    -

    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.

    +

    At any time after Docusaurus is installed, you can check your current version of Docusaurus by going into the website directory and typing yarn outdated docusaurus or npm outdated docusaurus.

    You will see something like this:

    $ yarn outdated
 Using globally installed version of Yarn
@@ -125,7 +136,7 @@ docusaurus 1.0.9   1.2.0  1.2.0  devDependencies https:temporary directory or run the Docusaurus server (e.g., yarn start) with the BABEL_DISABLE_CACHE=1 environment configuration.
    
 
-
Site Preparation →