Skip to content

Commit 4908561

Browse files
Dynamsoft-HenryDynamsoft-Henry
authored
Merge pull request #2 from dynamsoft-docs/preview
Merge from Preview
2 parents 9c01e35 + 2292a28 commit 4908561

File tree

90 files changed

+5381
-632
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

90 files changed

+5381
-632
lines changed

‎.github/workflows/main.yml‎

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
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 master 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" and "Build-Preview"
19+
Build-Main:
20+
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+
# Runs a set of commands using the runners shell
27+
- name: Build the site - Main
28+
run: |
29+
cd /home/ubuntu
30+
[ -d DCVDocJS ] && rm -rf DCVDocJS
31+
[ -d capture-vision-docs-js ] && rm -rf capture-vision-docs-js
32+
[ -d Docs-Template-Repo-Preview ] && rm -rf Docs-Template-Repo-Preview
33+
[ ! -d DCVDocJS ] && mkdir -p DCVDocJS
34+
git clone --depth 1 https://github.com/dynamsoft-docs/capture-vision-docs-js.git capture-vision-docs-js
35+
git clone --depth 1 --branch preview https://github.com/dynamsoft-docs/Docs-Template-Repo.git Docs-Template-Repo-Preview
36+
cp -rfp ./capture-vision-docs-js/* ./DCVDocJS/
37+
cp -rfp ./Docs-Template-Repo-Preview/* ./DCVDocJS/
38+
cd DCVDocJS && bundle exec jekyll build --incremental
39+
40+
- name: Sync files
41+
uses: SamKirkland/[email protected]
42+
with:
43+
server: ${{ secrets.FTP_DYNAMSOFT_LOCAL_SERVER }}
44+
username: ${{ secrets.FTP_DYNAMSOFT_LOCAL_USER }}
45+
password: ${{ secrets.FTP_DYNAMSOFT_LOCAL_PASSWORD }}
46+
port: 21
47+
local-dir: /home/ubuntu/DCVDocJS/_site/
48+
server-dir: /www.dynamsoft.com/capture-vision/docs/web/
49+
50+
Build-Preview:
51+
if: ${{ github.ref == 'refs/heads/preview' }}
52+
# The type of runner that the job will run on
53+
runs-on: self-hosted
54+
55+
# Steps represent a sequence of tasks that will be executed as part of the job
56+
steps:
57+
# Runs a set of commands using the runners shell
58+
- name: Build the site - Preview
59+
run: |
60+
cd /home/ubuntu
61+
[ -d DCVDocJS-preview ] && rm -rf DCVDocJS-preview
62+
[ -d capture-vision-docs-js-preview ] && rm -rf capture-vision-docs-js-preview
63+
[ -d Docs-Template-Repo-Preview ] && rm -rf Docs-Template-Repo-Preview
64+
[ ! -d DCVDocJS-preview ] && mkdir -p DCVDocJS-preview
65+
git clone --depth 1 --branch preview https://${{ secrets.GIT_USER }}:${{ secrets.GIT_PAT }}@github.com/dynamsoft-docs/capture-vision-docs-js.git capture-vision-docs-js-preview
66+
git clone --depth 1 --branch preview https://github.com/dynamsoft-docs/Docs-Template-Repo.git Docs-Template-Repo-Preview
67+
cp -rfp ./capture-vision-docs-js-preview/* ./DCVDocJS-preview/
68+
cp -rfp ./Docs-Template-Repo-Preview/* ./DCVDocJS-preview/
69+
sed -i -e "1,3s/blob\/master$/blob\/preview/" \
70+
-e "1,3s/blob\/main$/blob\/preview/" /home/ubuntu/DCVDocJS-preview/_config.yml
71+
cd DCVDocJS-preview && bundle exec jekyll build --incremental
72+
73+
- name: Sync files
74+
uses: SamKirkland/[email protected]
75+
with:
76+
server: ${{ secrets.FTP_TEST_SITE_SERVER }}
77+
username: ${{ secrets.FTP_TEST_SITE_USER }}
78+
password: ${{ secrets.FTP_TEST_SITE_PASSWORD }}
79+
port: 7500
80+
local-dir: /home/ubuntu/DCVDocJS-preview/_site/
81+
server-dir: /www.dynamsoft.com/capture-vision/docs/web/

‎.vscode/extensions.json‎

Lines changed: 0 additions & 5 deletions
This file was deleted.

‎_config.yml‎

Lines changed: 20 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,30 @@
11
repositoryUrl: https://github.com/dynamsoft-docs/capture-vision-docs-js/blob/main
22
repository: dynamsoft-docs/capture-vision-docs-js
3-
docFullPath: https://www.dynamsoft.com/capture-vision2/docs/
4-
firstLevelUrl: /capture-vision2/docs/
5-
docHomePage: /capture-vision2/docs/introduction/
3+
docFullPath: https://www.dynamsoft.com/capture-vision/docs/web/
4+
firstLevelUrl: /capture-vision/docs/web/
5+
docHomePage: /capture-vision/docs/core/introduction/
66

7-
introduction: /capture-vision2/docs/introduction/
8-
architecture: /capture-vision2/docs/architecture/
9-
parameter: /capture-vision2/docs/parameters/
10-
parameterFile: /capture-vision2/docs/parameters/file/
11-
parameterReference: /capture-vision2/docs/parameters/reference/
7+
introduction: /capture-vision/docs/core/introduction/
8+
architecture: /capture-vision/docs/core/architecture/
9+
parameter: /capture-vision/docs/core/parameters/
10+
parameterFile: /capture-vision/docs/core/parameters/file/
11+
parameterReference: /capture-vision/docs/core/parameters/reference/
12+
enums: /capture-vision/docs/core/enums/
1213

13-
assets: /capture-vision2/docs/assets/
14-
edit_icon: /capture-vision2/docs/assets/img-icon/edit-icon.png
15-
smile_icon: /capture-vision2/docs/assets/img-icon/icon-smile.png
16-
sad_icon: /capture-vision2/docs/assets/img-icon/icon-sad.png
17-
dbr_icon: /capture-vision2/docs/assets/img-icon/icon-dbr.svg
18-
dwt_icon: /capture-vision2/docs/assets/img-icon/icon-dwt.svg
19-
dnt_icon: /capture-vision2/docs/assets/img-icon/icon-dnt.svg
14+
js: /capture-vision/docs/web/programming/javascript/
15+
js_api: /capture-vision/docs/web/programming/javascript/api-reference/
16+
17+
assets: /capture-vision/docs/web/assets/
18+
edit_icon: /capture-vision/docs/web/assets/img-icon/edit-icon.png
19+
smile_icon: /capture-vision/docs/web/assets/img-icon/icon-smile.png
20+
sad_icon: /capture-vision/docs/web/assets/img-icon/icon-sad.png
21+
dbr_icon: /capture-vision/docs/web/assets/img-icon/icon-dbr.svg
22+
dwt_icon: /capture-vision/docs/web/assets/img-icon/icon-dwt.svg
23+
dnt_icon: /capture-vision/docs/web/assets/img-icon/icon-dnt.svg
2024

2125
useVersionTree: true
2226

23-
baseurl: "/capture-vision2/docs"
27+
baseurl: "/capture-vision/docs/web"
2428
plugins:
2529
- jemoji
2630

‎_data/full_tree.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
tree_file_list:
22
- sidelist-full-tree.html
3+
- sidelist-programming/programming-js.html
34

‎_includes/dcvNav.html‎

Lines changed: 54 additions & 68 deletions
Original file line numberDiff line numberDiff line change
@@ -1,70 +1,56 @@
11
<style>
2-
#cv-header .action-buttons {
3-
display: none;
2+
#cp-header .action-buttons { display: none; }
3+
#mdHeader { border-bottom: 0!important; }
4+
#sideBarCnt.sidebar-fixed { position: fixed; top: 88px; max-height: unset; }
5+
.rightSideMenu.rsm-fixed { position: fixed; top: 100px; }
6+
#docHead { top: 186px; }
7+
.productMenu .downloadBtn:hover { color: #ffffff!important; }
8+
@media (max-width: 1679px){
9+
#docHead {
10+
top: 145px;
11+
}
412
}
5-
6-
#mdHeader {
7-
border-bottom: 0!important;
8-
}
9-
10-
#sideBarCnt.sidebar-fixed {
11-
position: fixed;
12-
top: 88px;
13-
max-height: unset;
14-
}
15-
16-
.rightSideMenu.rsm-fixed {
17-
position: fixed;
18-
top: 100px;
19-
}
20-
21-
#docHead {
22-
top: 186px;
23-
}
24-
25-
.productMenu .downloadBtn:hover {
26-
color: #ffffff!important;
27-
}
28-
29-
@media (max-width: 1679px) {
30-
#docHead {
31-
top: 145px;
32-
}
33-
}
34-
</style>
35-
36-
<div id="CaptureVision" class="main">
37-
<div id="CaptureVisionMenu" class="productMenu">
38-
<div class="container pcProductMenu">
39-
<div class="row">
40-
<div class="col-xs-12">
41-
<ul class="menuList">
42-
<li class="title"><a class="orangeLink" href="{{site.overview}}">Dynamsoft Capture Vision</a></li>
43-
<li class="item overview">
44-
<a class="textUpperCase" href="{{site.docHomePage}}">Documentation</a>
45-
</li>
46-
</ul>
47-
</div>
48-
</div>
49-
</div>
50-
<div class="container mobileProductMenu">
51-
<div class="row">
52-
<div class="col-xs-12">
53-
<div class="productLogo" style="color:#fe8e14!important;font:10px">Dynamsoft Capture Vision <i class="icon-orange-angle"></i></div>
54-
<a class="textUpperCase" href="{{site.docHomePage}}">Documentation</a>
55-
</div>
56-
</div>
57-
</div>
58-
<div class="mobileProductDetailMenu">
59-
<div class="container">
60-
<div class="row">
61-
<div class="col-xs-12">
62-
<ul class="menuList">
63-
<li class="item"><a href="{{site.firstLevelUrl}}">Documentation</a></li>
64-
</ul>
65-
</div>
66-
</div>
67-
</div>
68-
</div>
69-
</div>
70-
</div>
13+
</style>
14+
15+
<div id="CaptureVision" class="main">
16+
<div id="CaptureVisionMenu" class="productMenu">
17+
<div class="container pcProductMenu">
18+
<div class="row">
19+
<div class="col-xs-12">
20+
<ul class="menuList">
21+
<!---->
22+
<li class="title"><a class="orangeLink" href="{{site.overview}}">Dynamsoft Capture Vision</a></li>
23+
<li class="item overview">
24+
<!---->
25+
<a class="textUpperCase" href="{{site.docHomePage}}">Documentation</a>
26+
</li>
27+
</ul>
28+
</div>
29+
</div>
30+
</div>
31+
<div class="container mobileProductMenu">
32+
<div class="row">
33+
<div class="col-xs-12">
34+
<div class="productLogo"><i class="dcv-logo"></i> <i class="icon-orange-angle"></i></div>
35+
<div id="dcvCurrentPage" class="fontOswald fr currentPage">Resource Base</div>
36+
</div>
37+
</div>
38+
</div>
39+
<div class="mobileProductDetailMenu">
40+
<div class="container">
41+
<div class="row">
42+
<div class="col-xs-12">
43+
<ul class="menuList">
44+
<!---->
45+
<li class="title"><a class="orangeLink" href="{{site.overview}}">Dynamsoft Capture Vision</a></li>
46+
<li class="item overview">
47+
<!---->
48+
<a class="textUpperCase" href="{{site.docHomePage}}">Documentation</a>
49+
</li>
50+
</ul>
51+
</div>
52+
</div>
53+
</div>
54+
</div>
55+
</div>
56+
</div>

‎_includes/sidelist-full-tree.html‎

Lines changed: 2 additions & 99 deletions
Original file line numberDiff line numberDiff line change
@@ -1,101 +1,4 @@
11
<li>
2-
<a href="{{ site.introduction }}" class="otherLinkColour">Introduction</a>
2+
<a style="cursor:pointer;color:#3c3c3c" href="{{ site.js }}index.html">JS Edition Introduction</a>
33
</li>
4-
<li>
5-
<a href="{{ site.architecture }}" class="otherLinkColour">Architecture</a>
6-
<!-- <ul>
7-
<li><a href="{{ site.architecture }}std-input.html" class="otherLinkColour">Input</a></li>
8-
<li><a href="{{ site.architecture }}image-processing/index.html" class="otherLinkColour">Image
9-
Processing</a>
10-
<ul>
11-
<li><a href="{{ site.architecture }}image-processing/region-predetection.html"
12-
class="otherLinkColour">Region Pre-detection</a></li>
13-
<li><a href="{{ site.architecture }}image-processing/shared-detection.html"
14-
class="otherLinkColour">Shared
15-
Detection</a></li>
16-
<li><a href="{{ site.architecture }}image-processing/barcode-localization.html"
17-
class="otherLinkColour">Barcode Localization</a></li>
18-
<li><a href="{{ site.architecture }}image-processing/barcode-decoding.html"
19-
class="otherLinkColour">Barcode
20-
Decoding</a></li>
21-
<li><a href="{{ site.architecture }}image-processing/textline-localization.html"
22-
class="otherLinkColour">Textline Localization</a></li>
23-
<li><a href="{{ site.architecture }}image-processing/textline-recognition.html"
24-
class="otherLinkColour">Textline Recognition</a></li>
25-
<li><a href="{{ site.architecture }}image-processing/document-detection.html"
26-
class="otherLinkColour">Document Detection</a></li>
27-
<li><a href="{{ site.architecture }}image-processing/document-normalization.html"
28-
class="otherLinkColour">Document Normalization</a></li>
29-
</ul>
30-
</li>
31-
<li><a href="{{ site.architecture }}semantic-processing.html" class="otherLinkColour">Semantic
32-
Processing</a>
33-
</li>
34-
<li><a href="{{ site.architecture }}std-output.html" class="otherLinkColour">Output</a></li>
35-
</ul> -->
36-
</li>
37-
<li>
38-
<a href="{{ site.parameter }}" class="otherLinkColour">Parameters</a>
39-
<ul>
40-
<li><a href="{{ site.parameterFile }}" class="otherLinkColour">Parameter Organization</a>
41-
<ul>
42-
<li><a href="{{ site.parameterFile }}capture-vision-template.html"
43-
class="otherLinkColour">CaptureVisionTemplate Object</a></li>
44-
<li><a href="{{ site.parameterFile }}image-source-options.html"
45-
class="otherLinkColour">ImageSource Object</a></li>
46-
<li><a href="{{ site.parameterFile }}target-ROI-def-options/"
47-
class="otherLinkColour">TargetROIDefi Object</a></li>
48-
<li><a href="{{ site.parameterFile }}semantic-processing-options/"
49-
class="otherLinkColour">SemanticProcessing Object</a>
50-
</li>
51-
<li><a href="{{ site.parameterFile }}task-settings/" class="otherLinkColour">Task
52-
Settings</a>
53-
<ul>
54-
<li><a href="{{ site.parameterFile }}task-settings/barcode-reader-task-setting-options.html"
55-
class="otherLinkColour">BarcodeReaderTaskSetting
56-
Object</a></li>
57-
<li><a href="{{ site.parameterFile }}task-settings/label-recognizer-task-setting-options.html"
58-
class="otherLinkColour">LabelRecognizerTaskSetting
59-
Object</a></li>
60-
<li><a href="{{ site.parameterFile }}task-settings/document-normalizer-task-setting-options.html"
61-
class="otherLinkColour">DocumentNormalizerTaskSetting
62-
Object</a></li>
63-
<li><a href="{{ site.parameterFile }}task-settings/code-parser-task-setting-options.html"
64-
class="otherLinkColour">CodeParserTaskSetting Object</a>
65-
</li>
66-
</ul>
67-
</li>
68-
<li><a href="{{ site.parameterFile }}image-parameter-array.html"
69-
class="otherLinkColour">ImagePapameter Object</a></li>
70-
<li><a href="{{ site.parameterFile }}auxiliary/" class="otherLinkColour">Auxiliary
71-
Settings</a>
72-
<ul>
73-
<li><a href="{{ site.parameterFile }}auxiliary/barcode-format-specification-options.html"
74-
class="otherLinkColour">BarcodeFormatSpecification
75-
Object</a></li>
76-
<li><a href="{{ site.parameterFile }}auxiliary/textline-specification-options.html"
77-
class="otherLinkColour">TextLineSpecification
78-
Object</a></li>
79-
<li><a href="{{ site.parameterFile }}auxiliary/character-model-array.html"
80-
class="otherLinkColour">CharacterModel Object</a>
81-
</li>
82-
<li><a href="{{ site.parameterFile }}auxiliary/global-parameter.html"
83-
class="otherLinkColour">GlobalParameter Object</a></li>
84-
</ul>
85-
</li>
86-
</ul>
87-
</li>
88-
<li><a href="{{ site.parameterReference }}" class="otherLinkColour">Parameter References</a>
89-
<ul>
90-
<li><a href="{{ site.parameterReference }}barcode-format-ids.html"
91-
class="otherLinkColour">BarcodeFormatIds</a></li>
92-
<li><a href="{{ site.parameterReference }}" class="otherLinkColour">Parameter 2</a></li>
93-
<li><a href="{{ site.parameterReference }}" class="otherLinkColour">Parameter 3</a></li>
94-
<li><a href="{{ site.parameterReference }}" class="otherLinkColour">Parameter 4</a></li>
95-
<li><a href="{{ site.parameterReference }}" class="otherLinkColour">Parameter 5</a></li>
96-
<li><a href="{{ site.parameterReference }}" class="otherLinkColour">Parameter 6</a></li>
97-
<li><a href="{{ site.parameterReference }}" class="otherLinkColour">Parameter 7</a></li>
98-
</ul>
99-
</li>
100-
</ul>
101-
</li>
4+
{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-programming/programming-js.html" -%}

0 commit comments

Comments
 (0)