Skip to content

Commit 6f62f41

Browse files
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]>
1 parent 52ccd06 commit 6f62f41

File tree

9 files changed

+45
-12
lines changed

9 files changed

+45
-12
lines changed

.github/workflows/main.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@ name: CI
44

55
# Controls when the workflow will run
66
on:
7-
# Triggers the workflow on push events but only for the master branch
7+
# Triggers the workflow on push events to the main and preview branches
88
push:
99
branches:
1010
- main
11-
# - preview
11+
- preview
1212

1313
# Allows you to run this workflow manually from the Actions tab
1414
workflow_dispatch:
@@ -26,7 +26,7 @@ jobs:
2626

2727
Build-Preview:
2828
if: ${{ github.ref == 'refs/heads/preview' }}
29-
uses: dynamsoft-docs/Docs-Template-Repo/.github/workflows/called-workflow-build-sync-testing.yml@preview
29+
uses: dynamsoft-docs/Docs-Template-Repo/.github/workflows/called-workflow-build-sync-testing.yml@main
3030
with:
3131
doc-repo: mobile-web-capture-docs
3232
doc-url: mobile-web-capture/docs/

_config.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ docHomePage: /mobile-web-capture/docs/introduction/
77
introduction: /mobile-web-capture/docs/introduction/
88
gettingstarted: /mobile-web-capture/docs/gettingstarted/
99
codegallery: /mobile-web-capture/docs/codegallery/
10+
code-gallery: /mobile-web-capture/docs/code-gallery/
1011
api: /mobile-web-capture/docs/api/
1112

1213
guides: /mobile-web-capture/docs/guides/

_data/full_tree.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
tree_file_list:
22
- sidelist-introduction.html
33
- sidelist-guides.html
4+
- sidelist-code-gallery.html
45
- sidelist-api.html
56
- sidelist-release-notes.html
67
- sidelist-full-tree.html
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
<li><a class="otherLinkColour">Code Gallery</a>
2+
<ul>
3+
<li><a href="{{ site.code-gallery }}frameworks.html" class="otherLinkColour">Frameworks</a></li>
4+
</ul>
5+
</li>
Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-introduction.html" -%}
2-
{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-gettingstarted.html" -%}
3-
{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-codegallery.html" -%}
4-
{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-apis.html" -%}
5-
{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-release-notes.html" -%}
1+
{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-introduction-v2.0.html" -%}
2+
{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-gettingstarted-v2.0.html" -%}
3+
{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-codegallery-v2.0.html" -%}
4+
{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-apis-v2.0.html" -%}
5+
{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-release-notes-v2.0.html" -%}

_includes/sidelist-full-tree.html

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-introduction.html" -%}
22
{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-guides.html" -%}
3-
<!-- {%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-gettingstarted.html" -%} -->
4-
<!-- {%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-codegallery.html" -%} -->
3+
{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-code-gallery.html" -%}
54
{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-api.html" -%}
6-
<!-- {%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-apis.html" -%} -->
75
{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-release-notes.html" -%}

code-gallery/frameworks.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
layout: default-layout
3+
# needAutoGenerateSidebar: true
4+
# needGenerateH3Content: true
5+
# noTitleIndex: false
6+
title: Mobile Web Capture - Frameworks
7+
keywords: Documentation, Mobile Web Capture, frameworks, web frameworks, angular, vue, react
8+
breadcrumbText: Frameworks
9+
description: Mobile Web Capture Framework Samples
10+
permalink: /code-gallery/frameworks.html
11+
---
12+
13+
# Frameworks
14+
15+
Dynamsoft provides samples that show how to integrate Dynamsoft Document Scanner and Mobile Web Capture in various frameworks. We recommend using our samples as references when building web applications with DDS and MWC with frameworks.
16+
17+
> [!NOTE]
18+
> Please [contact us](https://www.dynamsoft.com/company/contact/) for any inquiries about currently unsupported frameworks.
19+
20+
## Web Framework Samples
21+
22+
We host samples with Hello World implementations of DDS and MWC on GitHub, in the same repository as the source code for the SDKs. Follow the README contained in the directory of each sample for instructions to build and serve the sample:
23+
24+
### Mobile Web Capture
25+
26+
- [Angular](https://github.com/Dynamsoft/mobile-web-capture/tree/master/samples/frameworks/angular)

index.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ description: Mobile Web Capture Documentation Homepage
1212
- [Scan Single-Page Documents]({{ site.guides }}document-scanner.html)
1313
- [Scan Multi-Page Documents]({{ site.guides }}mobile-web-capture.html)
1414
- [Customize UI And Workflow]({{ site.guides }}mobile-web-capture-customization.html)
15+
- Code Gallery
16+
- [Frameworks]({{ site.code-gallery }}frameworks.html)
1517
- [API References]({{ site.api }}index.html)
1618
- [Document Scanner]({{ site.api }}document-scanner.html)
1719
- [Mobile Web Capture]({{ site.api }}mobile-web-capture.html)

introduction/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ permalink: /introduction/index.html
1212

1313
# Introduction
1414

15-
When digitizing physical documentswhether for easier storage, better accessibility, or streamlined processing — a hardware scanner is often the preferred choice. For integrating this functionality into web applications, **Dynamsoft’s** [Dynamic Web TWAIN](https://www.dynamsoft.com/web-twain/docs/introduction/index.html) is a widely popular option.
15+
When digitizing physical documentswhether for easier storage, better accessibility, or streamlined processing — a hardware scanner is often the preferred choice. For integrating this functionality into web applications, **Dynamsoft’s** [Dynamic Web TWAIN](https://www.dynamsoft.com/web-twain/docs/introduction/index.html) is a widely popular option.
1616

1717
However, when hardware scanners are not feasible or convenient, mobile device cameras can serve as effective alternatives. **Mobile Web Capture (MWC)** is a document scanning SDK specifically designed to address this need.
1818

0 commit comments

Comments
 (0)