Skip to content

Commit 3e877e6

Browse files
Dynamsoft-HenryDynamsoft-Henry
authored
Merge pull request #81 from dynamsoft-docs/preview
Preview
2 parents 3808178 + da93100 commit 3e877e6

File tree

9 files changed

+202
-97
lines changed

9 files changed

+202
-97
lines changed

‎.github/workflows/main.yml‎

Lines changed: 10 additions & 73 deletions
Original file line numberDiff line numberDiff line change
@@ -18,79 +18,16 @@ jobs:
1818
# This workflow contains jobs called "Build-Main" and "Build-Preview"
1919
Build-Main:
2020
if: ${{ github.ref == 'refs/heads/main' }}
21-
# The type of runner that the job will run on
22-
runs-on: self-hosted
23-
24-
# Steps represent a sequence of tasks that will be executed as part of the job
25-
steps:
26-
# Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
27-
#- uses: actions/checkout@v2
28-
29-
# Runs a set of commands using the runners shell
30-
- name: Run a multi-line script
31-
run: |
32-
cd /home/ubuntu
33-
[ -d DDNDoc ] && rm -rf DDNDoc
34-
[ -d document-normalizer-docs ] && rm -rf document-normalizer-docs
35-
[ -d Docs-Template-Repo-Preview ] && rm -rf Docs-Template-Repo-Preview
36-
[ ! -d DDNDoc ] && mkdir -p DDNDoc
37-
git clone --depth 1 https://github.com/dynamsoft-docs/document-normalizer-docs.git document-normalizer-docs
38-
git clone --depth 1 --branch preview https://github.com/dynamsoft-docs/Docs-Template-Repo.git Docs-Template-Repo-Preview
39-
cp -rfp ./document-normalizer-docs/* ./DDNDoc/
40-
cp -rfp ./Docs-Template-Repo-Preview/* ./DDNDoc/
41-
cd DDNDoc && bundle install && bundle exec jekyll build
42-
43-
- name: Sync files
44-
uses: SamKirkland/FTP-Deploy-Action@4.3.0
45-
with:
46-
server: ${{ secrets.FTP_DYNAMSOFT_LOCAL_SERVER }}
47-
username: ${{ secrets.FTP_DYNAMSOFT_LOCAL_USER }}
48-
password: ${{ secrets.FTP_DYNAMSOFT_LOCAL_PASSWORD }}
49-
port: 21
50-
local-dir: /home/ubuntu/DDNDoc/_site/
51-
server-dir: /www.dynamsoft.com/document-normalizer/docs/core/
52-
53-
- name: Trigger Webhook
54-
run: |
55-
curl -X POST -H "${{ secrets.WEBHOOK_USER }}" -H "${{ secrets.WEBHOOK_TOKEN }}" -H "Content-Type: application/json" -d "[\"/document-normalizer/docs/core/*\"]" ${{ secrets.WEBHOOK_URL }}
56-
21+
uses: dynamsoft-docs/Docs-Template-Repo/.github/workflows/called-workflow-build-sync-production.yml@main
22+
with:
23+
doc-repo: document-normalizer-docs
24+
doc-url: document-normalizer/docs/core
25+
secrets: inherit
5726

5827
Build-Preview:
5928
if: ${{ github.ref == 'refs/heads/preview' }}
60-
# The type of runner that the job will run on
61-
runs-on: self-hosted
62-
63-
# Steps represent a sequence of tasks that will be executed as part of the job
64-
steps:
65-
# Runs a set of commands using the runners shell
66-
- name: clear space
67-
run: |
68-
cd /home/ubuntu
69-
[ -d DDNDocPreview ] && rm -rf DDNDocPreview
70-
[ -d document-normalizer-docs-preview ] && rm -rf document-normalizer-docs-preview
71-
[ -d Docs-Template-Repo-Preview ] && rm -rf Docs-Template-Repo-Preview
72-
cd /home/ubuntu
73-
74-
- name: Build the site
75-
run: |
76-
cd /home/ubuntu
77-
[ ! -d DDNDocPreview ] && mkdir -p DDNDocPreview
78-
git clone --depth 1 --branch preview https://github.com/dynamsoft-docs/document-normalizer-docs.git document-normalizer-docs-preview
79-
git clone --depth 1 --branch preview https://github.com/dynamsoft-docs/Docs-Template-Repo.git Docs-Template-Repo-Preview
80-
cp -rfp ./document-normalizer-docs-preview/* ./DDNDocPreview/
81-
cp -rfp ./Docs-Template-Repo-Preview/* ./DDNDocPreview/
82-
sed -i -e "1,3s/blob\/master$/blob\/preview/" \
83-
-e "1,3s/blob\/main$/blob\/preview/" /home/ubuntu/DDNDocPreview/_config.yml
84-
cd DDNDocPreview && bundle install && bundle exec jekyll build
85-
86-
- name: Sync files
87-
uses: SamKirkland/FTP-Deploy-Action@4.3.0
88-
with:
89-
server: ${{ secrets.FTP_TEST_SITE_SERVER }}
90-
username: ${{ secrets.FTP_TEST_SITE_USER }}
91-
password: ${{ secrets.FTP_TEST_SITE_PASSWORD }}
92-
port: 7500
93-
local-dir: /home/ubuntu/DDNDocPreview/_site/
94-
server-dir: /www.dynamsoft.com/document-normalizer/docs/core/
95-
96-
29+
uses: dynamsoft-docs/Docs-Template-Repo/.github/workflows/called-workflow-build-sync-testing.yml@preview
30+
with:
31+
doc-repo: document-normalizer-docs
32+
doc-url: document-normalizer/docs/core
33+
secrets: inherit

‎_data/product_version.yml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,11 @@ useGroupedVersion: true
22

33
version_info_list:
44
- value: latest version
5+
- value: 2.x
6+
child:
7+
- 2.0.11
8+
- 2.0.10
9+
- 2.0.0
510
- value: 1.x
611
child:
712
- 1.0.21

‎_includes/sidelist-parameters-reference-v2.0.11.html‎

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
<li><a href="{{ site.parameters_reference_ddn }}" class="otherLinkColour">Parameter Reference</a>
2+
<ul>
3+
<li><a class="otherLinkColour ">Capture Vision Template</a>
4+
<ul>
5+
<li><a href="{{ site.parameters_reference }}capture-vision-template/image-roi-processing-name-array.html" class="otherLinkColour">ImageROIProcessingNameArray</a></li>
6+
<li><a href="{{ site.parameters_reference }}capture-vision-template/image-source-name.html" class="otherLinkColour">ImageSourceName</a></li>
7+
<li><a href="{{ site.parameters_reference }}capture-vision-template/max-parallel-tasks.html" class="otherLinkColour">MaxParallelTasks</a></li>
8+
<li><a href="{{ site.parameters_reference }}capture-vision-template/output-original-Image.html" class="otherLinkColour">OutputOriginalImage</a></li>
9+
<li><a href="{{ site.parameters_reference }}capture-vision-template/semantic-processing-name-array.html" class="otherLinkColour">SemanticProcessingNameArray</a></li>
10+
<li><a href="{{ site.parameters_reference }}capture-vision-template/timeout.html" class="otherLinkColour">Timeout</a></li>
11+
</ul>
12+
</li>
13+
<li><a class="otherLinkColour ">Target ROI Def</a>
14+
<ul>
15+
<li><a href="{{ site.parameters_reference }}target-roi-def/base-target-roidef-name.html" class="otherLinkColour">BaseTargetROIDefName</a></li>
16+
<li><a href="{{ site.parameters_reference }}target-roi-def/location.html" class="otherLinkColour">Location</a></li>
17+
<li><a href="{{ site.parameters_reference }}target-roi-def/pause-flag.html" class="otherLinkColour">PauseFlag</a></li>
18+
<li><a href="{{ site.parameters_reference }}target-roi-def/task-setting-name-array.html" class="otherLinkColour">TaskSettingNameArray</a></li>
19+
</ul>
20+
</li>
21+
<li><a class="otherLinkColour ">Document Normalizer Task Setting</a>
22+
<ul>
23+
<li><a href="{{ site.parameters_reference }}document-normalizer-task-settings/base-document-normalizer-task-setting-name.html" class="otherLinkColour">BaseDocumentNormalizerTaskSettingName</a></li>
24+
<li><a href="{{ site.parameters_reference }}document-normalizer-task-settings/brightness.html" class="otherLinkColour">Brightness</a></li>
25+
<li><a href="{{ site.parameters_reference }}document-normalizer-task-settings/colour-mode.html" class="otherLinkColour">ColourMode</a></li>
26+
<li><a href="{{ site.parameters_reference }}document-normalizer-task-settings/content-type.html" class="otherLinkColour">ContentType</a></li>
27+
<li><a href="{{ site.parameters_reference }}document-normalizer-task-settings/contrast.html" class="otherLinkColour">Contrast</a></li>
28+
<li><a href="{{ site.parameters_reference }}document-normalizer-task-settings/corner-angle-range.html" class="otherLinkColour">CornerAngleRange</a></li>
29+
<li><a href="{{ site.parameters_reference }}document-normalizer-task-settings/deskew-mode.html" class="otherLinkColour">DeskewMode</a></li>
30+
<li><a href="{{ site.parameters_reference }}document-normalizer-task-settings/line-extraction-modes.html" class="otherLinkColour">LineExtractionModes</a></li>
31+
<li><a href="{{ site.parameters_reference }}document-normalizer-task-settings/page-size.html" class="otherLinkColour">PageSize</a></li>
32+
<li><a href="{{ site.parameters_reference }}document-normalizer-task-settings/quadrilateral-detection-modes.html" class="otherLinkColour">QuadrilateralDetectionModes</a></li>
33+
</ul>
34+
</li>
35+
<li><a class="otherLinkColour ">ImageParameter</a>
36+
<ul>
37+
<li><a href="{{ site.parameters_reference }}image-parameter/base-image-parameter-name.html" class="otherLinkColour">BaseImageParameterName</a></li>
38+
<li><a href="{{ site.parameters_reference }}image-parameter/binarization-modes.html" class="otherLinkColour">BinarizationModes</a></li>
39+
<li><a href="{{ site.parameters_reference }}image-parameter/colour-channel-usage-type.html" class="otherLinkColour">ColourChannelUsageType</a></li>
40+
<li><a href="{{ site.parameters_reference }}image-parameter/colour-conversion-modes.html" class="otherLinkColour">ColourConversionModes</a></li>
41+
<li><a href="{{ site.parameters_reference }}image-parameter/grayscale-enhancement-modes.html" class="otherLinkColour">GrayscaleEnhancementModes</a></li>
42+
<li><a href="{{ site.parameters_reference }}image-parameter/grayscale-transformation-modes.html" class="otherLinkColour">GrayscaleTransformationModes</a></li>
43+
<li><a href="{{ site.parameters_reference }}image-parameter/if-erase-text-zone.html" class="otherLinkColour">IfEraseTextZone</a></li>
44+
<li><a href="{{ site.parameters_reference }}image-parameter/region-predetection-modes.html" class="otherLinkColour">RegionPredetectionModes</a></li>
45+
<li><a href="{{ site.parameters_reference }}image-parameter/scale-down-threshold.html" class="otherLinkColour">ScaleDownThreshold</a></li>
46+
<li><a href="{{ site.parameters_reference }}image-parameter/scale-up-modes.html" class="otherLinkColour">ScaleUpModes</a></li>
47+
<li><a href="{{ site.parameters_reference }}image-parameter/text-detection-mode.html" class="otherLinkColour">TextDetectionMode</a></li>
48+
<li><a href="{{ site.parameters_reference }}image-parameter/texture-detection-modes.html" class="otherLinkColour">TextureDetectionModes</a></li>
49+
</ul>
50+
</li>
51+
<li><a class="otherLinkColour ">Image Source</a>
52+
<ul>
53+
<li><a href="{{ site.parameters_reference }}image-source-options/file-filter.html" class="otherLinkColour">FileFilter</a></li>
54+
<li><a href="{{ site.parameters_reference }}image-source-options/pdf-reading-mode.html" class="otherLinkColour">PDFReadingMode</a></li>
55+
<li><a href="{{ site.parameters_reference }}image-source-options/recursive.html" class="otherLinkColour">Recursive</a></li>
56+
<li><a href="{{ site.parameters_reference }}image-source-options/type.html" class="otherLinkColour">Type</a></li>
57+
</ul>
58+
</li>
59+
<li><a class="otherLinkColour ">Global Parameter</a>
60+
<ul>
61+
<li><a href="{{ site.parameters_reference }}global-parameter/max-total-image-dimension.html" class="otherLinkColour">MaxTotalImageDimension</a></li>
62+
</ul>
63+
</li>
64+
<li><a class="otherLinkColour ">Shared Parameter</a>
65+
<ul>
66+
<li><a href="{{ site.parameters_reference }}shared-parameter/directory-path.html" class="otherLinkColour">DirectoryPath</a></li>
67+
<li><a href="{{ site.parameters_reference }}shared-parameter/max-threads-in-one-task.html" class="otherLinkColour">MaxThreadsInOneTask</a></li>
68+
<li><a href="{{ site.parameters_reference }}shared-parameter/name.html" class="otherLinkColour">Name</a></li>
69+
<li><a href="{{ site.parameters_reference }}shared-parameter/section-image-parameter-array.html" class="otherLinkColour">SectionImageParameterArray</a></li>
70+
<li><a href="{{ site.parameters_reference }}shared-parameter/start-section.html" class="otherLinkColour">StartSection</a></li>
71+
<li><a href="{{ site.parameters_reference }}shared-parameter/terminate-setting.html" class="otherLinkColour">TerminateSetting</a></li>
72+
</ul>
73+
</li>
74+
</ul>
75+
</li>

‎_includes/sidelist-parameters-reference.html‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,19 @@
22
<ul>
33
<li><a class="otherLinkColour ">Capture Vision Template</a>
44
<ul>
5+
<li><a href="{{ site.parameters_reference }}capture-vision-template/name.html" class="otherLinkColour">Name</a></li>
56
<li><a href="{{ site.parameters_reference }}capture-vision-template/image-roi-processing-name-array.html" class="otherLinkColour">ImageROIProcessingNameArray</a></li>
67
<li><a href="{{ site.parameters_reference }}capture-vision-template/image-source-name.html" class="otherLinkColour">ImageSourceName</a></li>
78
<li><a href="{{ site.parameters_reference }}capture-vision-template/max-parallel-tasks.html" class="otherLinkColour">MaxParallelTasks</a></li>
9+
<li><a href="{{ site.parameters_reference }}capture-vision-template/min-image-capture-interval.html" class="otherLinkColour">MinImageCaptureInterval</a></li>
810
<li><a href="{{ site.parameters_reference }}capture-vision-template/output-original-Image.html" class="otherLinkColour">OutputOriginalImage</a></li>
911
<li><a href="{{ site.parameters_reference }}capture-vision-template/semantic-processing-name-array.html" class="otherLinkColour">SemanticProcessingNameArray</a></li>
1012
<li><a href="{{ site.parameters_reference }}capture-vision-template/timeout.html" class="otherLinkColour">Timeout</a></li>
1113
</ul>
1214
</li>
1315
<li><a class="otherLinkColour ">Target ROI Def</a>
1416
<ul>
17+
<li><a href="{{ site.parameters_reference }}target-roi-def/name.html" class="otherLinkColour">Name</a></li>
1518
<li><a href="{{ site.parameters_reference }}target-roi-def/base-target-roidef-name.html" class="otherLinkColour">BaseTargetROIDefName</a></li>
1619
<li><a href="{{ site.parameters_reference }}target-roi-def/location.html" class="otherLinkColour">Location</a></li>
1720
<li><a href="{{ site.parameters_reference }}target-roi-def/pause-flag.html" class="otherLinkColour">PauseFlag</a></li>
@@ -20,6 +23,7 @@
2023
</li>
2124
<li><a class="otherLinkColour ">Document Normalizer Task Setting</a>
2225
<ul>
26+
<li><a href="{{ site.parameters_reference }}target-roi-def/name.html" class="otherLinkColour">Name</a></li>
2327
<li><a href="{{ site.parameters_reference }}document-normalizer-task-settings/base-document-normalizer-task-setting-name.html" class="otherLinkColour">BaseDocumentNormalizerTaskSettingName</a></li>
2428
<li><a href="{{ site.parameters_reference }}document-normalizer-task-settings/brightness.html" class="otherLinkColour">Brightness</a></li>
2529
<li><a href="{{ site.parameters_reference }}document-normalizer-task-settings/colour-mode.html" class="otherLinkColour">ColourMode</a></li>
@@ -30,10 +34,15 @@
3034
<li><a href="{{ site.parameters_reference }}document-normalizer-task-settings/line-extraction-modes.html" class="otherLinkColour">LineExtractionModes</a></li>
3135
<li><a href="{{ site.parameters_reference }}document-normalizer-task-settings/page-size.html" class="otherLinkColour">PageSize</a></li>
3236
<li><a href="{{ site.parameters_reference }}document-normalizer-task-settings/quadrilateral-detection-modes.html" class="otherLinkColour">QuadrilateralDetectionModes</a></li>
37+
<li><a href="{{ site.parameters_reference }}shared-parameter/max-threads-in-one-task.html" class="otherLinkColour">MaxThreadsInOneTask</a></li>
38+
<li><a href="{{ site.parameters_reference }}shared-parameter/section-image-parameter-array.html" class="otherLinkColour">SectionImageParameterArray</a></li>
39+
<li><a href="{{ site.parameters_reference }}shared-parameter/start-section.html" class="otherLinkColour">StartSection</a></li>
40+
<li><a href="{{ site.parameters_reference }}shared-parameter/terminate-setting.html" class="otherLinkColour">TerminateSetting</a></li>
3341
</ul>
3442
</li>
3543
<li><a class="otherLinkColour ">ImageParameter</a>
3644
<ul>
45+
<li><a href="{{ site.parameters_reference }}target-roi-def/name.html" class="otherLinkColour">Name</a></li>
3746
<li><a href="{{ site.parameters_reference }}image-parameter/base-image-parameter-name.html" class="otherLinkColour">BaseImageParameterName</a></li>
3847
<li><a href="{{ site.parameters_reference }}image-parameter/binarization-modes.html" class="otherLinkColour">BinarizationModes</a></li>
3948
<li><a href="{{ site.parameters_reference }}image-parameter/colour-channel-usage-type.html" class="otherLinkColour">ColourChannelUsageType</a></li>
@@ -50,6 +59,7 @@
5059
</li>
5160
<li><a class="otherLinkColour ">Image Source</a>
5261
<ul>
62+
<li><a href="{{ site.parameters_reference }}target-roi-def/name.html" class="otherLinkColour">Name</a></li>
5363
<li><a href="{{ site.parameters_reference }}image-source-options/file-filter.html" class="otherLinkColour">FileFilter</a></li>
5464
<li><a href="{{ site.parameters_reference }}image-source-options/pdf-reading-mode.html" class="otherLinkColour">PDFReadingMode</a></li>
5565
<li><a href="{{ site.parameters_reference }}image-source-options/recursive.html" class="otherLinkColour">Recursive</a></li>
@@ -61,15 +71,5 @@
6171
<li><a href="{{ site.parameters_reference }}global-parameter/max-total-image-dimension.html" class="otherLinkColour">MaxTotalImageDimension</a></li>
6272
</ul>
6373
</li>
64-
<li><a class="otherLinkColour ">Shared Parameter</a>
65-
<ul>
66-
<li><a href="{{ site.parameters_reference }}shared-parameter/directory-path.html" class="otherLinkColour">DirectoryPath</a></li>
67-
<li><a href="{{ site.parameters_reference }}shared-parameter/max-threads-in-one-task.html" class="otherLinkColour">MaxThreadsInOneTask</a></li>
68-
<li><a href="{{ site.parameters_reference }}shared-parameter/name.html" class="otherLinkColour">Name</a></li>
69-
<li><a href="{{ site.parameters_reference }}shared-parameter/section-image-parameter-array.html" class="otherLinkColour">SectionImageParameterArray</a></li>
70-
<li><a href="{{ site.parameters_reference }}shared-parameter/start-section.html" class="otherLinkColour">StartSection</a></li>
71-
<li><a href="{{ site.parameters_reference }}shared-parameter/terminate-setting.html" class="otherLinkColour">TerminateSetting</a></li>
72-
</ul>
73-
</li>
7474
</ul>
7575
</li>

‎_layouts/search-page.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -199,7 +199,7 @@ <h1>Search</h1>
199199

200200
$('#txtSearch').keydown(function(e) {
201201
if (e.keyCode == 13) {
202-
window.location.href = '/document-normalizer/docs/search.html?q=' + $('#txtSearch').val()
202+
window.location.href = '/document-normalizer/docs/core/search.html?q=' + $('#txtSearch').val()
203203
}
204204
})
205205

‎parameters-new/reference/index-v2.0.0.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Dynamsoft Document Normalizer Parameter Reference - Main Page
33
description: Dynamsoft Document Normalizer Parameter Reference - Main Page
44
keywords: parameter reference, parameters
55
needAutoGenerateSidebar: false
6-
permalink: /parameters/reference/index.html
6+
permalink: /parameters/reference/index-v2.0.0.html
77
---
88

99
# Parameter Reference

0 commit comments

Comments
 (0)