Merge pull request #61 from dynamsoft-docs/preview

Preview

Author: Dynamsoft-Henry

.github/workflows/full-site-build.yml

@@ -31,11 +31,14 @@ jobs:
         run: |
           cd /home/ubuntu
           [ -d DDNDoc ] && rm -rf DDNDoc
+          [ -d document-normalizer-docs ] && rm -rf document-normalizer-docs
+          [ -d Docs-Template-Repo-Preview ] && rm -rf Docs-Template-Repo-Preview
           [ ! -d DDNDoc ] && mkdir -p DDNDoc
-          cd document-normalizer-docs && git pull && cd .. && cp -rfp ./document-normalizer-docs/* ./DDNDoc/
-          cd Docs-Template-Repo-Preview && git pull && cd .. && cp -rfp ./Docs-Template-Repo-Preview/* ./DDNDoc/
-          cd DDNDoc && bundle exec jekyll build
-          #python3 /home/ubuntu/ftp.py /home/ubuntu/DDNDoc/_site/ ./www.dynamsoft.com/document-normalizer/docs/ prod
+          git clone --depth 1 https://github.com/dynamsoft-docs/document-normalizer-docs.git document-normalizer-docs
+          git clone --depth 1 --branch preview https://github.com/dynamsoft-docs/Docs-Template-Repo.git Docs-Template-Repo-Preview
+          cp -rfp ./document-normalizer-docs/* ./DDNDoc/
+          cp -rfp ./Docs-Template-Repo-Preview/* ./DDNDoc/
+          cd DDNDoc && bundle exec jekyll build --incremental
 
       - name: Sync files
         uses: SamKirkland/[email protected]
@@ -45,7 +48,7 @@ jobs:
           password: ${{ secrets.FTP_DYNAMSOFT_LOCAL_PASSWORD }}
           port: 21 
           local-dir: /home/ubuntu/DDNDoc/_site/
-          server-dir: /www.dynamsoft.com/document-normalizer/docs/        
+          server-dir: /www.dynamsoft.com/document-normalizer/docs/core/
 
   Build-Preview:
     if: ${{ github.ref == 'refs/heads/preview' }}
@@ -67,13 +70,13 @@ jobs:
         run: |
           cd /home/ubuntu
           [ ! -d DDNDocPreview ] && mkdir -p DDNDocPreview
-          [ ! -d document-normalizer-docs-preview ] && git clone --depth 1 --branch preview https://github.com/dynamsoft-docs/document-normalizer-docs.git document-normalizer-docs-preview          
-          [ ! -d Docs-Template-Repo-Preview ] && git clone --depth 1 --branch preview https://github.com/dynamsoft-docs/Docs-Template-Repo.git Docs-Template-Repo-Preview
-          cd document-normalizer-docs-preview && git pull && cd .. && cp -rfp ./document-normalizer-docs-preview/* ./DDNDocPreview/
-          cd Docs-Template-Repo-Preview && git pull && cd .. && cp -rfp ./Docs-Template-Repo-Preview/* ./DDNDocPreview/
+          git clone --depth 1 --branch preview https://${{ secrets.GIT_USER }}:${{ secrets.GIT_PAT }}@github.com/dynamsoft-docs/document-normalizer-docs.git document-normalizer-docs-preview
+          git clone --depth 1 --branch preview https://github.com/dynamsoft-docs/Docs-Template-Repo.git Docs-Template-Repo-Preview
+          cp -rfp ./document-normalizer-docs-preview/* ./DDNDocPreview/
+          cp -rfp ./Docs-Template-Repo-Preview/* ./DDNDocPreview/
           sed -i -e "1,3s/blob\/master$/blob\/preview/" \
           -e "1,3s/blob\/main$/blob\/preview/" /home/ubuntu/DDNDocPreview/_config.yml
-          cd DDNDocPreview && bundle exec jekyll build
+          cd DDNDocPreview && bundle exec jekyll build --incremental
 
       - name: Sync files
         uses: SamKirkland/[email protected]
@@ -83,6 +86,6 @@ jobs:
           password: ${{ secrets.FTP_TEST_SITE_PASSWORD }}
           port: 7500 
           local-dir: /home/ubuntu/DDNDocPreview/_site/
-          server-dir: /www.dynamsoft.com/document-normalizer/docs/
+          server-dir: /www.dynamsoft.com/document-normalizer/docs/core/
 
 

.github/workflows/main.yml

@@ -1,54 +1,47 @@
 repository: dynamsoft-docs/document-normalizer-docs
 repositoryUrl: https://github.com/dynamsoft-docs/document-normalizer-docs/blob/main
-docFullPath: https://www.dynamsoft.com/document-normalizer/docs
-firstLevelUrl: /document-normalizer/docs
-docHomePage: /document-normalizer/docs/introduction/
-
-introduction: /document-normalizer/docs/introduction/
-programming: /document-normalizer/docs/programming/
-parameters: /document-normalizer/docs/parameters/
-license: /document-normalizer/docs/license/
-
-c: /document-normalizer/docs/programming/c/
-c_api: /document-normalizer/docs/programming/c/api-reference/
-c_release_notes: /document-normalizer/docs/programming/c/release-notes/
-
-cpp: /document-normalizer/docs/programming/cplusplus/
-cpp_api: /document-normalizer/docs/programming/cplusplus/api-reference/
-cpp_release_notes: /document-normalizer/docs/programming/cplusplus/release-notes/
-
-ios: /document-normalizer/docs/programming/ios/
-ios_api: /document-normalizer/docs/programming/ios/api-reference/
-ios_release_notes: /document-normalizer/docs/programming/ios/release-notes/
-ios_camera_enhancer: /document-normalizer/docs/programming/ios/api-reference/camera-enhancer/
-
-android: /document-normalizer/docs/programming/android/
-android_api: /document-normalizer/docs/programming/android/api-reference/
-android_release_notes: /document-normalizer/docs/programming/android/release-notes/
-android_camera_enhancer: /document-normalizer/docs/programming/android/api-reference/camera-enhancer/
-
-javascript: /document-normalizer/docs/programming/javascript/
-javascript_api: /document-normalizer/docs/programming/javascript/api-reference/
-javascript_release_notes: /document-normalizer/docs/programming/javascript/release-notes/
-javascript_user_guide: /document-normalizer/docs/programming/javascript/user-guide/
-
-xamarin: /document-normalizer/docs/programming/xamarin/
-xamarin_api: /document-normalizer/docs/programming/xamarin/api-reference/
-xamarin_release_notes: /document-normalizer/docs/programming/xamarin/release-notes/
-xamarin_camera_enhancer: /document-normalizer/docs/programming/xamarin/api-reference/camera-enhancer/
-
-enumerations: /document-normalizer/docs/programming/enumerations/
-parameters_reference: /document-normalizer/docs/parameters/reference/
-release_notes: /document-normalizer/docs/release-notes/
+docFullPath: https://www.dynamsoft.com/document-normalizer/docs/core
+firstLevelUrl: /document-normalizer/docs/core
+docHomePage: /document-normalizer/docs/core/
+
+introduction: /document-normalizer/docs/core/introduction/
+
+c: /document-normalizer/docs/server/programming/c/
+c_api: /document-normalizer/docs/server/programming/c/api-reference/
+c_release_notes: /document-normalizer/docs/server/programming/c/release-notes/
+
+cpp: /document-normalizer/docs/server/programming/cplusplus/
+cpp_release_notes: /document-normalizer/docs/server/programming/cplusplus/release-notes/
+
+ios: /document-normalizer/docs/mobile/programming/ios/
+ios_release_notes: /document-normalizer/docs/mobile/programming/ios/release-notes/
+
+android: /document-normalizer/docs/mobile/programming/android/
+android_release_notes: /document-normalizer/docs/mobile/programming/android/release-notes/
+
+js: /document-normalizer/docs/web/programming/javascript/
+js_release_notes: /document-normalizer/docs/web/programming/javascript/release-notes/
+
+xamarin: /document-normalizer/docs/mobile/programming/xamarin/
+xamarin_release_notes: /document-normalizer/docs/mobile/programming/xamarin/release-notes/
+
+release_notes: /document-normalizer/docs/core/release-notes/
+
+enumerations: /capture-vision/docs/core/enums/
+dcv_parameters: /capture-vision/docs/core/parameters/
+parameters_reference: /capture-vision/docs/core/parameters/reference/
+parameters_ddn: /document-normalizer/docs/core/parameters/
+parameters_reference_ddn: /document-normalizer/docs/core/parameters/reference/
+license: /capture-vision/docs/core/license/
 
 useVersionTree: true
 
-assets: /document-normalizer/docs/assets/
-edit_icon: /document-normalizer/docs/assets/img-icon/edit-icon.png
-smile_icon: /document-normalizer/docs/assets/img-icon/icon-smile.png
-sad_icon: /document-normalizer/docs/assets/img-icon/icon-sad.png
+assets: /document-normalizer/docs/core/assets/
+edit_icon: /document-normalizer/docs/core/assets/img-icon/edit-icon.png
+smile_icon: /document-normalizer/docs/core/assets/img-icon/icon-smile.png
+sad_icon: /document-normalizer/docs/core/assets/img-icon/icon-sad.png
 
-baseurl: "/document-normalizer/docs"
+baseurl: "/document-normalizer/docs/core"
 
 download: "/document-normalizer/downloads/1000023-confirmation/"
 
@@ -65,6 +58,11 @@ defaults:
       noTitleIndex: true
       needAutoGenerateSidebar: true
       needGenerateH3Content: true
+  - scope: 
+      path: "" 
+    values: 
+      docRootName: "Document Normalizer" 
+      docHomePage: "/document-normalizer/docs/core/introduction/"
   - scope:
       path: "Hide_Tree_Page.html"
     values:

.vscode/settings.json

@@ -1,15 +1,13 @@
 tree_file_list:
     - sidelist-full-tree.html
+    - sidelist-development.html
+    - sidelist-development-v1.0.21.html
     - sidelist-introduction.html
-    - sidelist-parameters.html
-    - sidelist-programming.html
-    - sidelist-useful.html
-    - sidelist-release-notes.html
     - sidelist-license.html
-    - sidelist-programming/programming-android.html
-    - sidelist-programming/programming-ios.html
-    - sidelist-programming/programming-c.html
-    - sidelist-programming/programming-cpp.html
-    - sidelist-programming/programming-xamarin.html
-    - sidelist-programming/programming-javascript.html
-    - sidelist-parameters/parameters-reference.html
+    - sidelist-parameters-organization.html
+    - sidelist-parameters-reference.html
+    - sidelist-parameters-reference-v1.0.21.html
+    - sidelist-release-notes.html
+    - sidelist-useful.html
+    - sidelist-understanding.html
+    - sidelist-understanding-v1.0.21.html

_config.yml

@@ -1,8 +1,14 @@
+useGroupedVersion: true
+
 version_info_list:
-  - latest version
-  - 1.0.12
-  - 1.0.11
-  - 1.0.10
-  - 1.0.0
+  - value: latest version
+  - value: 1.x
+    child:
+      - 1.0.21
+      - 1.0.20
+      - 1.0.12
+      - 1.0.11
+      - 1.0.10
+      - 1.0.0