From 4d25c29f0b523d6f0333d55b475fd8ddfa533548 Mon Sep 17 00:00:00 2001 From: Website Deployment Script Date: Tue, 13 Feb 2018 02:14:34 +0000 Subject: [PATCH] Deploy website Deploy website version based on ee8c802fa48b5b6c1cfef806fa668d7cea8152c9 --- docs/en/installation.html | 3 +-- docs/en/site-preparation.html | 8 +++++--- 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/docs/en/installation.html b/docs/en/installation.html index 7d9380ae9a..927ffb419d 100644 --- a/docs/en/installation.html +++ b/docs/en/installation.html @@ -9,9 +9,8 @@
  • 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
diff --git a/docs/en/site-preparation.html b/docs/en/site-preparation.html
index 3db66891c4..3f843d0537 100644
--- a/docs/en/site-preparation.html
+++ b/docs/en/site-preparation.html
@@ -1,10 +1,10 @@
-Site Preparation · Docusaurus
    Docusaurus
    Edit
    Site Preparation
    After installing Docusaurus, you now have a skeleton to work from for your specific website. The following discusses the rest of the Docusaurus structure in order for you to prepare your site.
    
 
    Directory Structure
    
 
    As shown after you installed Docusaurus, the initialization script created a directory structure similar to:
    
 
    root-of-repo
@@ -27,6 +27,9 @@
 │   └── siteConfig.js
 │   └── static
 
    
+
    
+
    You may have already renamed the example blog (website/blog-examples-from-docusaurus and document (docs-examples-from-docusaurus) directories when you verified the installation.
    
+
    
 
      
 
    • The website/core/Footer.js file is a React component that acts as the footer for the site generated by Docusaurus and should be customized by the user.
      • 
 
    • The website/blog-examples-from-docusaurus folder contains examples of blog posts written in markdown.
      • 
@@ -37,7 +40,6 @@
 
    
 
    You will need to keep the website/siteConfig.js and website/core/Footer.js files, but may edit them as you wish.
    
 
    You should keep the website/pages and website/static folders, but may change the content inside them as you wish. At the bare minimum you should have an en/index.js or en/index.html file inside website/pages and an image to use as your header icon inside website/static.
    
-
    The website/blog-examples-from-docusaurus and docs-examples-from-docusaurus folders contain example blog and document markdown files. As shown below when you verify that the example site runs correctly, if you wish to run Docusaurus with these files, you need to rename the folders to website/blog and docs, respectively.
    
 
    ← InstallationCreating your site →