Skip to content

Commit a248c57

Browse files
DMGithubPublisherDMGithubPublisher
committed
update to internal commit 78ae69df
1 parent c703394 commit a248c57

File tree

13 files changed

+203
-2
lines changed

13 files changed

+203
-2
lines changed

‎.github/workflows/main.yml‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# This is a basic workflow to help you get started with Actions
2+
3+
name: CI
4+
5+
# Controls when the workflow will run
6+
on:
7+
# Triggers the workflow on push events but only for the main branch
8+
push:
9+
branches:
10+
- main
11+
#- preview
12+
13+
# Allows you to run this workflow manually from the Actions tab
14+
workflow_dispatch:
15+
16+
# A workflow run is made up of one or more jobs that can run sequentially or in parallel
17+
jobs:
18+
# This workflow contains jobs called "Build-Main"
19+
Build-Main:
20+
if: ${{ github.ref == 'refs/heads/main' }}
21+
uses: dynamsoft-docs/Docs-Template-Repo/.github/workflows/called-workflow-build-sync-production.yml@main
22+
with:
23+
doc-repo: mrz-scanner-docs
24+
doc-url: mrz-scanner/docs/core
25+
secrets: inherit

‎.gitignore‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
.DS_Store
2+
/.vs
3+
Gemfile
4+
Hide_Tree_Page.md
5+
sitemap.xml
6+
_includes/productNav/*
7+
_includes/auto-version-list.html
8+
_includes/head.html
9+
_includes/liquid_autoGenerateHistoryList.html
10+
_includes/liquid_breadcrumb.html
11+
_includes/liquid_generateFullTree.html
12+
_includes/liquid_searchVersionTreeFile.html
13+
_includes/livehelp.html
14+
_includes/main-page-head.html
15+
_includes/page_footer.html
16+
_includes/page_header.html
17+
_includes/productNav_OLD.html
18+
_includes/productNav.html
19+
_includes/search-input.html
20+
_includes/trialLicense.html
21+
_layouts/*
22+
_plugins/*
23+
assets/css/*
24+
assets/font-face/*
25+
assets/img-icon/*
26+
assets/js/*
27+
assets/scripts/*
28+
webres/wwwroot/css/*
29+
webres/wwwroot/fontawesome-free-5.13.0-web/*
30+
webres/wwwroot/images/*
31+
webres/wwwroot/js/*
32+
webres/wwwroot/lib/*
33+
_site/*
34+
Gemfile.lock

‎README.md‎

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,20 @@
1-
# MRZ Documentation Hub
1+
#Introduction
2+
TODO: Give a short introduction of your project. Let this section explain the objectives or the motivation behind this project.
23

3-
The purpose of this repo is to act as a hub to connect the MRZ docs across the editions. This hub will contain only one intro page, with links to all of the existing MRZ docs.
4+
#Getting Started
5+
TODO: Guide users through getting your code up and running on their own system. In this section you can talk about:
6+
1. Installation process
7+
2. Software dependencies
8+
3. Latest releases
9+
4. API references
10+
11+
#Build and Test
12+
TODO: Describe and show how to build your code and run the tests.
13+
14+
#Contribute
15+
TODO: Explain how other users and developers can contribute to make your code better.
16+
17+
If you want to learn more about creating good readme files then refer the following [guidelines](https://www.visualstudio.com/en-us/docs/git/create-a-readme). You can also seek inspiration from the below readme files:
18+
- [ASP.NET Core](https://github.com/aspnet/Home)
19+
- [Visual Studio Code](https://github.com/Microsoft/vscode)
20+
- [Chakra Core](https://github.com/Microsoft/ChakraCore)

‎_config.yml‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
repository: dynamsoft-docs/mrz-scanner-docs
2+
repositoryUrl: https://github.com/dynamsoft-docs/mrz-scanner-docs/blob/main
3+
docFullPath: https://www.dynamsoft.com/mrz-scanner/docs/
4+
firstLevelUrl: /mrz-scanner/docs/core/
5+
docHomePage: /mrz-scanner/docs/core/introduction/
6+
7+
introduction: /mrz-scanner/docs/web/introduction/
8+
gettingstarted: /mrz-scanner/docs/web/gettingstarted/
9+
codegallery: /mrz-scanner/docs/web/codegallery/
10+
api: /mrz-scanner/docs/web/api/
11+
releasenotes: /mrz-scanner/docs/web/releasenotes/
12+
13+
license_activation: /capture-vision/docs/core/license/
14+
15+
dcvb_js: /capture-vision/docs/web/programming/javascript/
16+
dcvb_mobile: /capture-vision/docs/mobile/
17+
dcvb_server: /capture-vision/docs/server/
18+
dcvb_root: /capture-vision/docs/core/
19+
20+
mrz_js: /mrz-scanner/docs/web/
21+
22+
useVersionTree: true
23+
24+
assets: /mrz-scanner/docs/core/assets/
25+
edit_icon: /mrz-scanner/docs/core/assets/img-icon/edit-icon.png
26+
smile_icon: /mrz-scanner/docs/core/assets/img-icon/icon-smile.png
27+
sad_icon: /mrz-scanner/docs/core/assets/img-icon/icon-sad.png
28+
29+
baseurl: "/mrz-scanner/docs/core"
30+
31+
download: "/mrz-scanner/downloads/"
32+
33+
plugins:
34+
- jemoji
35+
- jekyll-sitemap
36+
37+
38+
defaults:
39+
- scope:
40+
path: ""
41+
values:
42+
layout: "default-layout"
43+
noTitleIndex: true
44+
needAutoGenerateSidebar: true
45+
needGenerateH3Content: true
46+
- scope:
47+
path: "Hide_Tree_Page.html"
48+
values:
49+
sitemap: false
50+
51+
url: "https://www.dynamsoft.com" # sitemap root

‎_data/full_tree.yml‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
tree_file_list:
2+
- sidelist-api.html
3+
- sidelist-codegallery.html
4+
- sidelist-introduction.html
5+
- sidelist-guides.html
6+
- sidelist-releasenotes.html
7+
- sidelist-full-tree.html
8+
- sidelist-api-v1.1.html
9+
- sidelist-codegallery-v1.1.html
10+
- sidelist-introduction-v1.1.html
11+
- sidelist-guides-v1.1.html
12+
- sidelist-releasenotes-v1.1.html
13+
- sidelist-full-tree-v1.1.html

‎_data/product_version.yml‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
useGroupedVersion: true
2+
3+
version_info_list:
4+
- value: latest version
5+
- value: 1.x
6+
child:
7+
- 1.1

‎_includes/sidelist-full-tree-v1.1.html‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-introduction-v1.1.html" -%}
2+
{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-guides-v1.1.html" -%}
3+
{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-codegallery-v1.1.html" -%}
4+
{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-api-v1.1.html" -%}
5+
{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-releasenotes-v1.1.html" -%}

‎_includes/sidelist-full-tree.html‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-introduction.html" -%}

‎_includes/sidelist-introduction-v1.1.html‎

Whitespace-only changes.

‎_includes/sidelist-introduction.html‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
<li><a href="{{ site.introduction }}index.html" class="otherLinkColour">Introduction</a></li>

0 commit comments

Comments
 (0)