From 33ed6fc765f0b8d00cbc59dd38fbde72c042c3bf Mon Sep 17 00:00:00 2001 From: Website Deployment Script Date: Wed, 1 Nov 2017 16:50:59 +0000 Subject: [PATCH] Deploy website Deploy website version based on 4d2a889ef38b76538a22474c3361f40c4db60f8e --- docs/en/site-creation.html | 39 ++++++++++++++++++++++---------------- 1 file changed, 23 insertions(+), 16 deletions(-) diff --git a/docs/en/site-creation.html b/docs/en/site-creation.html index 53872b2378..0767c3c534 100644 --- a/docs/en/site-creation.html +++ b/docs/en/site-creation.html @@ -1,22 +1,29 @@ -Creating your site · Docusaurus

Docusaurus

Edit

Creating your site

Docusaurus' primary purpose of existence is to make it super simple for you to create documentation for your project and have a site to house those docs.

+
Edit

Creating your site

Docusaurus was created to hopefully make it super simple for you to create a site and documentation for your open source project.

After installation and preparation, much of the work to create a basic site for your docs is already complete.

-

Load the Example Site

-

Preparation created a sample site for you to see Docusaurus in action. However, it also provided the infrastructure that will be used as you are developing your own site.

Site Structure

-

After loading the example site, you should see a structure in your repo that looks similar to:

-
project-repo/
-  docs/
-    doc1.md
-  website/
-    blog/
-      2017-05-06-blog-post.md
+
Your site structure looks like the following:

+
root-of-repo
+├── docs
+└── website
+│   └── blog
+│   └── core
+│       └── Footer.js
+│   └── node_modules
+│   └── package.json
+│   └── pages
+│   └── sidebars.json
+│   └── siteConfig.js
+│   └── static
 

+

+
This assumes that you removed the example .md files that were installed with the initialization script.

+

 
All of your documentation files should be placed inside the docs folder as markdown .md files. Any blog posts should be inside the blog folder.

 

 
The blog posts must be formatted as yyyy-mm-dd-your-file-name.md

@@ -24,20 +31,20 @@
 
Create Your Basic Site

 
To create a fully functional site, you only need to do a few steps:

 
    
-
  1. Add your documentation to the /docs folder as .md files, ensuring you have the proper header in each file.
    2. 
-
  2. Add zero or more docs to the sidebars.json file so that your documentation is rendered in a sidebar, if you choose them to be.
    3. 
+
  3. Add your documentation to the /docs folder as .md files, ensuring you have the proper header in each file.
    4. 
+
  4. Add zero or more docs to the sidebars.json file so that your documentation is rendered in a sidebar, if you choose them to be.
    5. 
 

 

 
If you do not add your documentation to the sidebars.json file, the docs will be rendered, but they can only be linked to from other documentation and visited with the known URL.

 

 
    
-
  1. Modify the website/siteConfig.js file to configure your site, following the comments included in that file to guide you.
    2. 
-
  2. Customize the website/core/Footer.js file that provides the footer for your site.
    3. 
+
  3. Modify the website/siteConfig.js file to configure your site, following the comments included in the docs and the website/siteConfig.js to guide you.
    4. 
+
  4. Create any custom pages and/or customize the website/core/Footer.js file that provides the footer for your site.
    5. 
 
  5. Place assets, such as images, in the website/static/ folder.
    6. 
 
  6. Run the site to see the results of your changes.
    7. 
 

 
cd website
-yarn run start # or - npm run start
+yarn run start # or `npm run start`
 # navigate to http://localhost:3000
← Site PreparationPublishing your site →