[apisix-website] branch master updated: docs: added Integrate with Projects documentations (#234)

[juzhiyuan]

This is an automated email from the ASF dual-hosted git repository.

juzhiyuan pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/apisix-website.git


The following commit(s) were added to refs/heads/master by this push:
     new f14813f  docs: added Integrate with Projects documentations (#234)
f14813f is described below

commit f14813f9cb5e491e9af5e3cb7ec8da65e187cedf
Author: Ylikj <2843773...@qq.com>
AuthorDate: Wed Mar 3 19:06:59 2021 +0800

    docs: added Integrate with Projects documentations (#234)
    
    Co-authored-by: 琚致远 <juzhiy...@apache.org>
---
 .../docs/general/integrate-with-project-docs.md    | 80 ++++++++++++++++++++++
 website/docs/general/sidebars.json                 |  3 +-
 2 files changed, 82 insertions(+), 1 deletion(-)

diff --git a/website/docs/general/integrate-with-project-docs.md 
b/website/docs/general/integrate-with-project-docs.md
new file mode 100644
index 0000000..49ecd0d
--- /dev/null
+++ b/website/docs/general/integrate-with-project-docs.md
@@ -0,0 +1,80 @@
+---
+id: integrate-with-project-docs
+title: Integrate with Project documentations
+---
+
+## Directory Structure
+
+Put all Markdown files into the latest directory
+
+```
+/docs
+├── assets
+│   ├── images
+│   │   ├── xxxxx.png
+│   └── other
+│       └── xxxxx.xxx
+├── en
+│   └── latest
+│       ├── doc1.md
+│       ├── folder
+│       │   └── doc2.md
+│       │       └── folder2
+│       │           └── doc3.md
+│       └── config.json
+├── es
+│   └── latest
+│       └── ...
+└── zh
+    └── latest
+        └── ...
+```
+
+## Configuration file
+
+This file is located in `/docs/<locale>/latest/config.json`, where locale is 
locale codes, please refer to 
https://www.science.co.il/language/Locale-codes.php, locale is all lowercase. 
Don't forget to remove the comment after copying JSON.
+
+More information about sidebar can be found at 
https://v2.docusaurus.io/docs/next/sidebar
+
+```jsonc
+{
+  "version": 2.3,
+  "sidebar": [
+    // The left sidebar of the APISIX website
+    {
+      "type": "doc",
+      "id": "doc2" // id is the filename of the md file
+    },
+    {
+      "type": "category", // category is a collapsed column, nestable
+      "label": "folder",
+      "items": [
+        {
+          "type": "doc",
+          "id": "folder/doc2"
+        },
+        {
+          "type": "category",
+          "label": "folder2",
+          "items": [
+            "folder2/doc3"
+          ]
+        }
+      ]
+    },
+    {
+      "type": "link",
+      "label": "CHANGELOG",
+      "href": "https://github.com/apache/apisix/blob/master/CHANGELOG";
+    }
+  ]
+}
+```
+
+## Markdown formatting restrictions
+
+- Use relative paths within Markdown files `../xxx/xxx`, not absolute paths 
`/docs/en/xxx/xxx`. If you want to refer to files outside the docs directory, 
please use https://github.com/apache/apisix-xxx/blob/master/xxx/xxx.xxx
+
+- You need to use Markdown syntax when introducing images, i.e. `![image 
name](./assets/xxxx.png)`. Images cannot be introduced using HTML tags, i.e. 
`<img src=". /assets/xxxx.png" />`
+
+- If the Markdown file contains HTML tags within it, be sure to make sure the 
tags are closed. For example `<br>` must be written as `<br/>`
diff --git a/website/docs/general/sidebars.json 
b/website/docs/general/sidebars.json
index 40247e0..70d4ca1 100644
--- a/website/docs/general/sidebars.json
+++ b/website/docs/general/sidebars.json
@@ -6,7 +6,8 @@
       "contributor-guide",
       "committer-guide",
       "2fa",
-      "release-guide"
+      "release-guide",
+      "integrate-with-project-docs"
     ]
   }
 }