Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 13 additions & 5 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,22 +4,30 @@ name: CI

# Controls when the workflow will run
on:
# Triggers the workflow on push events but only for the main 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:

# A workflow run is made up of one or more jobs that can run sequentially or in parallel
jobs:
# This workflow contains jobs called "Build-Master"
# This workflow contains jobs called "Build-Main" and "Build-Preview"
Build-Main:
if: ${{ github.ref == 'refs/heads/main' }}
uses: dynamsoft-docs/Docs-Template-Repo/.github/workflows/called-workflow-build-sync-production.yml@main
with:
doc-repo: mrz-scanner-docs-js
doc-url: mrz-scanner/docs/web
secrets: inherit

Build-Preview:
if: ${{ github.ref == 'refs/heads/preview' }}
uses: dynamsoft-docs/Docs-Template-Repo/.github/workflows/called-workflow-build-sync-testing.yml@main
with:
doc-repo: mrz-scanner-docs-js
doc-url: mrz-scanner/docs/web
secrets: inherit
36 changes: 24 additions & 12 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,9 +1,19 @@
.DS_Store
/.vs
Gemfile
Hide_Tree_Page.md
sitemap.xml
_includes/productNav/*

# Layout templates
_layouts/

# 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
Expand All @@ -18,12 +28,14 @@ _includes/productNav_OLD.html
_includes/productNav.html
_includes/search-input.html
_includes/trialLicense.html
_layouts/*
_plugins/*
assets/css/*
assets/font-face/*
assets/img-icon/*
assets/js/*
assets/scripts/*
_site/*

# Plugins
_plugins/

# Site resources
_site/

sitemap.xml
Hide_Tree_Page.md
Gemfile.lock
Gemfile
2 changes: 1 addition & 1 deletion api/enums-mrz-scanner.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,4 +56,4 @@ enum EnumMRZData {
DateOfBirth = "dateOfBirth",
DateOfExpiry = "dateOfExpiry",
}
```
```
10 changes: 5 additions & 5 deletions api/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Please read through the [**full API reference**](mrz-scanner.md), but you can fi

2. MRZScannerView - Represents the main view of the MRZ Scanner where the scanning operation occurs.

3. MRZResultView - Displays the parsed MRZ result in human readable fields, along with a cropped image of the MRZ document.
3. MRZResultView - Displays the parsed MRZ result in human readable fields, along with a cropped image of the MRZ document.

## Interfaces

Expand All @@ -32,11 +32,11 @@ Please read through the [**full API reference**](mrz-scanner.md), but you can fi

4. [MRZResultViewToolbarButtonsConfig](mrz-scanner.md#mrzresultviewtoolbarbuttonsconfig) - Configures the toolbar buttons of the **MRZResultView**.

4. [MRZResult](mrz-scanner.md#mrzresult) - Represents a typical MRZ result along with all of the parsed fields that come with it.
5. [MRZResult](mrz-scanner.md#mrzresult) - Represents a typical MRZ result along with all of the parsed fields that come with it.

5. [MRZData](mrz-scanner.md#mrzdata) - Represents the parsed MRZ data that is part of the `MRZResult`.
6. [MRZData](mrz-scanner.md#mrzdata) - Represents the parsed MRZ data that is part of the `MRZResult`.

6. [MRZDate](mrz-scanner.md#mrzdate) - Represents a date in the MRZ fields - which is usually used for date of birth and the date of expiry.
7. [MRZDate](mrz-scanner.md#mrzdate) - Represents a date in the MRZ fields - which is usually used for date of birth and the date of expiry.

## Enumerations

Expand All @@ -46,4 +46,4 @@ All of the enumerations can be found [**here**](enums-mrz-scanner.md). Here is a

2. [EnumResultStatus](enums-mrz-scanner.md#enumresultstatus) - An enumeration to represent the status of a MRZ result.

3. [EnumMRZData](enums-mrz-scanner.md) - An enumeration to represent the different fields of the `MRZData` interface.
3. [EnumMRZData](enums-mrz-scanner.md) - An enumeration to represent the different fields of the `MRZData` interface.
Loading