[GitHub] [apisix-website] qier222 commented on a change in pull request #234: docs: added Integrate with Projects documentations

[GitBox <gi...@apache.org>]

qier222 commented on a change in pull request #234:
URL: https://github.com/apache/apisix-website/pull/234#discussion_r586149010



##########
File path: website/docs/general/integrate-with-project-docs.md
##########
@@ -0,0 +1,80 @@
+---
+id: integrate-with-project-docs
+title: Integrate with Project documentations
+---
+
+## docs 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.

Review comment:
       Why not wrap /docs/<locale>/latest/config.json with ``?




----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org