Preview (#99)

* Chores and fixes (#97)

* chore: remove VS Code config

* chore: update .gitignore for local builds

* chore: fix .gitignore

* chore: fix .gitignore

* remove ignored templates

* chore: fix whitespace and EOF newline

* chore: fix .gitignore

* chore: remove extra .editorconfig

* fix: release notes linking

* fix: rename release notes sidelist

* fix: rename release notes sidelist

---------

Co-authored-by: Tom Kent <[email protected]>

* Staging (#98)

- Clean up repo
- Fix GitHub actions
- Fix formatting and syntax
- Add MWC framework sample and link
---------

Co-authored-by: Tom Kent <[email protected]>

---------

Co-authored-by: Tom Kent <[email protected]>

Author: dynamsoft-h

.editorconfig

@@ -43,10 +43,9 @@ jobs:
           server: ${{ secrets.FTP_DYNAMSOFT_LOCAL_SERVER }}
           username: ${{ secrets.FTP_DYNAMSOFT_LOCAL_USER }}
           password: ${{ secrets.FTP_DYNAMSOFT_LOCAL_PASSWORD }}
-          port: 21 
+          port: 21
           local-dir: /home/ubuntu/MWCDoc/_site/
-          server-dir: /www.dynamsoft.com/mobile-web-capture/docs/        
-
+          server-dir: /www.dynamsoft.com/mobile-web-capture/docs/
 
   Build-Preview:
     if: ${{ github.ref == 'refs/heads/preview' }}
@@ -57,8 +56,7 @@ jobs:
     steps:
       # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
       #- uses: actions/checkout@v2
-        
-        
+
       # Runs a set of commands using the runners shell
       - name: Build the site
         run: |
@@ -72,15 +70,13 @@ jobs:
           sed -i -e "1,3s/blob\/master$/blob\/preview/" \
           -e "1,3s/blob\/main$/blob\/preview/" /home/ubuntu/MWCDocPreview/_config.yml
           cd MWCDocPreview && bundle exec jekyll build
-          
 
       - name: Sync files
         uses: SamKirkland/[email protected]
         with:
           server: ${{ secrets.FTP_TEST_SITE_SERVER }}
           username: ${{ secrets.FTP_TEST_SITE_USER }}
           password: ${{ secrets.FTP_TEST_SITE_PASSWORD }}
-          port: 7500 
+          port: 7500
           local-dir: /home/ubuntu/MWCDocPreview/_site/
           server-dir: /www.dynamsoft.com/mobile-web-capture/docs/
-

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

@@ -4,11 +4,11 @@ name: CI
 
 # Controls when the workflow will run
 on:
-  # Triggers the workflow on push events but only for the master branch
+  # Triggers the workflow on push events to the main and preview branches
   push:
-    branches: 
-    - main 
-    # - preview 
+    branches:
+    - main
+    - preview
 
   # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:
@@ -26,8 +26,8 @@ jobs:
 
   Build-Preview:
     if: ${{ github.ref == 'refs/heads/preview' }}
-    uses: dynamsoft-docs/Docs-Template-Repo/.github/workflows/called-workflow-build-sync-testing.yml@preview
+    uses: dynamsoft-docs/Docs-Template-Repo/.github/workflows/called-workflow-build-sync-testing.yml@main
     with:
       doc-repo: mobile-web-capture-docs
       doc-url: mobile-web-capture/docs/
-    secrets: inherit
+    secrets: inherit

.github/workflows/main.yml

@@ -1,5 +1,38 @@
-################################################################################
-# 此 .gitignore 文件已由 Microsoft(R) Visual Studio 自动创建。
-################################################################################
+# Layout templates
+_layouts/
 
-/.vs
+# Assets
+assets/font-face/
+assets/img-icon/
+assets/js/**
+!assets/js/setLatestVersion.js
+assets/scripts/
+assets/css/
+
+# Includes
+_includes/productNav/
+_includes/auto-version-list.html
+_includes/head.html
+_includes/liquid_autoGenerateHistoryList.html
+_includes/liquid_breadcrumb.html
+_includes/liquid_generateFullTree.html
+_includes/liquid_searchVersionTreeFile.html
+_includes/livehelp.html
+_includes/main-page-head.html
+_includes/page_footer.html
+_includes/page_header.html
+_includes/productNav_OLD.html
+_includes/productNav.html
+_includes/search-input.html
+_includes/trialLicense.html
+
+# Plugins
+_plugins/
+
+# Site resources
+_site/
+
+sitemap.xml
+Hide_Tree_Page.md
+Gemfile.lock
+Gemfile

.gitignore

@@ -1 +1 @@
-# Mobile-Web-Capture-Docs
+# Mobile-Web-Capture-Docs

.vscode/settings.json

@@ -1,46 +1,45 @@
-repository: dynamsoft-docs/mobile-web-capture-docs
-repositoryUrl: https://github.com/dynamsoft-docs/mobile-web-capture-docs/blob/main
-docFullPath: https://www.dynamsoft.com/mobile-web-capture/docs
-firstLevelUrl: /mobile-web-capture/docs
-docHomePage: /mobile-web-capture/docs/introduction/
-
-introduction: /mobile-web-capture/docs/introduction/
-gettingstarted: /mobile-web-capture/docs/gettingstarted/
-codegallery: /mobile-web-capture/docs/codegallery/
-api: /mobile-web-capture/docs/api/
-
-guides: /mobile-web-capture/docs/guides/
-
-
-releasenotes: /mobile-web-capture/docs/releasenotes/
-
-useVersionTree: true
-
-assets: /mobile-web-capture/docs/assets/
-edit_icon: /mobile-web-capture/docs/assets/img-icon/edit-icon.png
-smile_icon: /mobile-web-capture/docs/assets/img-icon/icon-smile.png
-sad_icon: /mobile-web-capture/docs/assets/img-icon/icon-sad.png
-
-baseurl: "/mobile-web-capture/docs"
-
-download: "/mobile-web-capture/downloads/"
-
-plugins:
-  - jemoji
-  - jekyll-sitemap
-
-
-defaults:
-  - scope:
-      path: ""
-    values:
-      layout: "default-layout"
-      noTitleIndex: true
-      needAutoGenerateSidebar: true
-      needGenerateH3Content: true
-  - scope:
-      path: "Hide_Tree_Page.html"
-    values:
-      sitemap: false
-
-url: "https://www.dynamsoft.com" # sitemap root
+repository: dynamsoft-docs/mobile-web-capture-docs
+repositoryUrl: https://github.com/dynamsoft-docs/mobile-web-capture-docs/blob/main
+docFullPath: https://www.dynamsoft.com/mobile-web-capture/docs
+firstLevelUrl: /mobile-web-capture/docs
+docHomePage: /mobile-web-capture/docs/introduction/
+
+introduction: /mobile-web-capture/docs/introduction/
+gettingstarted: /mobile-web-capture/docs/gettingstarted/
+codegallery: /mobile-web-capture/docs/codegallery/
+code-gallery: /mobile-web-capture/docs/code-gallery/
+api: /mobile-web-capture/docs/api/
+
+guides: /mobile-web-capture/docs/guides/
+
+release-notes: /mobile-web-capture/docs/release-notes/
+
+useVersionTree: true
+
+assets: /mobile-web-capture/docs/assets/
+edit_icon: /mobile-web-capture/docs/assets/img-icon/edit-icon.png
+smile_icon: /mobile-web-capture/docs/assets/img-icon/icon-smile.png
+sad_icon: /mobile-web-capture/docs/assets/img-icon/icon-sad.png
+
+baseurl: "/mobile-web-capture/docs"
+
+download: "/mobile-web-capture/downloads/"
+
+plugins:
+  - jemoji
+  - jekyll-sitemap
+
+defaults:
+  - scope:
+      path: ""
+    values:
+      layout: "default-layout"
+      noTitleIndex: true
+      needAutoGenerateSidebar: true
+      needGenerateH3Content: true
+  - scope:
+      path: "Hide_Tree_Page.html"
+    values:
+      sitemap: false
+
+url: "https://www.dynamsoft.com" # sitemap root

README.md

@@ -1,9 +1,10 @@
 tree_file_list:
   - sidelist-introduction.html
   - sidelist-guides.html
+  - sidelist-code-gallery.html
   - sidelist-api.html
-  - sidelist-releasenotes.html
+  - sidelist-release-notes.html
   - sidelist-full-tree.html
   - sidelist-apis-v2.0.html
   - sidelist-full-tree.v2.0.html
-  - sidelist-introduction-v2.0.html
+  - sidelist-introduction-v2.0.html

_config.yml

@@ -6,4 +6,4 @@ version_info_list:
   - value: 2.0
   - value: 1.x
     child:
-      - 1.1
+      - 1.1

_data/full_tree.yml

@@ -3,4 +3,4 @@
         <li><a href="{{ site.api }}document-scanner.html" class="otherLinkColour">Document Scanner</a></li>
         <li><a href="{{ site.api }}mobile-web-capture.html" class="otherLinkColour">Mobile Web Capture</a></li>
     </ul>
-</li>
+</li>