Skip to content

Commit 88a4d03

Browse files
lunaaawlunaaaw
committed
18.1
1 parent e34d9bd commit 88a4d03

4 files changed

Lines changed: 94 additions & 123 deletions

File tree

‎.github/workflows/full-site-build.yml‎

Lines changed: 28 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -9,62 +9,43 @@ on:
99

1010
# A workflow run is made up of one or more jobs that can run sequentially or in parallel
1111
jobs:
12-
# This workflow contains jobs called "Build-Master" and "Build-Preview"
13-
Build-Master:
14-
if: ${{ github.ref == 'refs/heads/master' }}
12+
Build-v18-1:
13+
if: ${{ github.ref == 'refs/heads/v18.1' }}
1514
# The type of runner that the job will run on
1615
runs-on: self-hosted
1716

1817
# Steps represent a sequence of tasks that will be executed as part of the job
1918
steps:
20-
# Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
21-
#- uses: actions/checkout@v2
22-
23-
# Runs a set of commands using the runners shell
24-
- name: Build and Upload to Prod Env
25-
run: |
26-
cd /home/ubuntu
27-
[ -d DWTDoc ] && rm -rf DWTDoc
28-
[ -d web-twain-docs ] && rm -rf web-twain-docs
29-
[ -d Docs-Template-Repo-Preview ] && rm -rf Docs-Template-Repo-Preview
30-
mkdir -p DWTDoc
31-
git clone --depth 1 https://github.com/dynamsoft-docs/web-twain-docs.git web-twain-docs
32-
git clone --depth 1 --branch preview https://github.com/dynamsoft-docs/Docs-Template-Repo.git Docs-Template-Repo-Preview
33-
cp -rfp ./web-twain-docs/* ./DWTDoc/
34-
cd Docs-Template-Repo-Preview && git pull && cd .. && cp -rfp ./Docs-Template-Repo-Preview/* ./DWTDoc/
35-
cd DWTDoc && bundle exec jekyll build
36-
python3 /home/ubuntu/ftp.py /home/ubuntu/DWTDoc/_site/ ./www.dynamsoft.com/web-twain/docs/ prod
37-
38-
Build-Preview:
39-
if: ${{ github.ref == 'refs/heads/preview' }}
40-
# The type of runner that the job will run on
41-
runs-on: self-hosted
42-
43-
# Steps represent a sequence of tasks that will be executed as part of the job
44-
steps:
45-
4619
# Runs a set of commands using the runners shell
4720
- name: Build the site
4821
run: |
4922
cd /home/ubuntu
50-
[ -d DWTDocPreview ] && rm -rf DWTDocPreview
51-
[ -d web-twain-docs-preview ] && rm -rf web-twain-docs-preview
52-
[ -d Docs-Template-Repo-Preview ] && rm -rf Docs-Template-Repo-Preview
53-
mkdir -p DWTDocPreview
54-
git clone --depth 1 --branch preview https://github.com/dynamsoft-docs/web-twain-docs.git web-twain-docs-preview
55-
git clone --depth 1 --branch preview https://github.com/dynamsoft-docs/Docs-Template-Repo.git Docs-Template-Repo-Preview
56-
cp -rfp ./web-twain-docs-preview/* ./DWTDocPreview/
57-
cp -rfp ./Docs-Template-Repo-Preview/* ./DWTDocPreview/
58-
sed -i -e "1,3s/blob\/master$/blob\/preview/" \
59-
-e "1,3s/blob\/main$/blob\/preview/" /home/ubuntu/DWTDocPreview/_config.yml
60-
cd DWTDocPreview && bundle exec jekyll build
61-
- name: Sync files to Test Env
23+
[ -d web-twain-docs-archive ] && rm -rf web-twain-docs-archive
24+
[ -d Docs-Template-Repo-archive ] && rm -rf Docs-Template-Repo-archive
25+
[ -d DWTDocArchive ] && rm -rf DWTDocArchive
26+
mkdir -p DWTDocArchive
27+
git clone --depth 1 --branch v18.1 https://github.com/Dynamsoft/web-twain-docs.git web-twain-docs-archive
28+
git clone --depth 1 --branch dwt-v18.1 https://github.com/dynamsoft-docs/Docs-Template-Repo.git Docs-Template-Repo-archive
29+
cp -rfp ./web-twain-docs-archive/* ./DWTDocArchive/
30+
cp -rfp ./Docs-Template-Repo-archive/* ./DWTDocArchive/
31+
sed -i -e "1,3s/blob\/master$/blob\/v18.1/" \
32+
-e "1,3s/blob\/main$/blob\/v18.1/" /home/ubuntu/DWTDocArchive/_config.yml
33+
cd DWTDocArchive && bundle exec jekyll build
34+
35+
- name: Sync files
6236
uses: SamKirkland/FTP-Deploy-Action@4.3.0
6337
with:
64-
server: ${{ secrets.FTP_TEST_SITE_SERVER }}
65-
username: ${{ secrets.FTP_TEST_SITE_USER }}
66-
password: ${{ secrets.FTP_TEST_SITE_PASSWORD }}
67-
port: 7500
68-
local-dir: /home/ubuntu/DWTDocPreview/_site/
69-
server-dir: /www.dynamsoft.com/web-twain/docs/
38+
server: ${{ secrets.FTP_DYNAMSOFT_LOCAL_SERVER }}
39+
username: ${{ secrets.FTP_DYNAMSOFT_LOCAL_USER }}
40+
password: ${{ secrets.FTP_DYNAMSOFT_LOCAL_PASSWORD }}
41+
port: 21
42+
local-dir: /home/ubuntu/DWTDocArchive/_site/
43+
server-dir: /www.dynamsoft.com/web-twain/docs-archive/v18.1/
44+
45+
- name: Clear files
46+
run: |
47+
cd /home/ubuntu
48+
[ -d web-twain-docs-archive ] && rm -rf web-twain-docs-archive
49+
[ -d Docs-Template-Repo-archive ] && rm -rf Docs-Template-Repo-archive
50+
[ -d DWTDocArchive ] && rm -rf DWTDocArchive
7051

‎.github/workflows/main.yml‎

Lines changed: 25 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -7,39 +7,15 @@ on:
77
# Triggers the workflow on push events but only for the master branch
88
push:
99
branches:
10-
- master
11-
- preview
10+
- v18.1
1211

1312
# Allows you to run this workflow manually from the Actions tab
1413
workflow_dispatch:
1514

1615
# A workflow run is made up of one or more jobs that can run sequentially or in parallel
17-
jobs:
18-
# This workflow contains a single job called "build"
19-
Build-Master:
20-
if: ${{ github.ref == 'refs/heads/master' }}
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 DWTDoc ] && mkdir -p DWTDoc
34-
[ ! -d web-twain-docs ] && git clone --depth 1 https://github.com/Dynamsoft/web-twain-docs.git
35-
[ ! -d Docs-Template-Repo-Preview ] && git clone --depth 1 --branch preview https://github.com/dynamsoft-docs/Docs-Template-Repo.git Docs-Template-Repo-Preview
36-
cd web-twain-docs && git pull && cd .. && cp -rfp ./web-twain-docs/* ./DWTDoc/
37-
cd Docs-Template-Repo-Preview && git pull && cd .. && cp -rfp ./Docs-Template-Repo-Preview/* ./DWTDoc/
38-
cd DWTDoc && bundle exec jekyll build --incremental
39-
python3 /home/ubuntu/ftp.py /home/ubuntu/DWTDoc/_site/ ./www.dynamsoft.com/web-twain/docs/ prod
40-
41-
Build-Preview:
42-
if: ${{ github.ref == 'refs/heads/preview' }}
16+
jobs:
17+
Build-v18-1:
18+
if: ${{ github.ref == 'refs/heads/v18.1' }}
4319
# The type of runner that the job will run on
4420
runs-on: self-hosted
4521

@@ -49,20 +25,31 @@ jobs:
4925
- name: Build the site
5026
run: |
5127
cd /home/ubuntu
52-
[ ! -d web-twain-docs-preview ] && git clone --depth 1 --branch preview https://github.com/dynamsoft-docs/web-twain-docs.git web-twain-docs-preview
53-
[ ! -d Docs-Template-Repo-preview ] && git clone --depth 1 --branch preview https://github.com/dynamsoft-docs/Docs-Template-Repo.git Docs-Template-Repo-preview
54-
[ ! -d DWTDocPreview ] && mkdir -p DWTDocPreview
55-
cd web-twain-docs-preview && git pull && cd .. && cp -rfp ./web-twain-docs-preview/* ./DWTDocPreview/
56-
cd Docs-Template-Repo-preview && git pull && cd .. && cp -rfp ./Docs-Template-Repo-preview/* ./DWTDocPreview/
57-
sed -i -e "1,3s/blob\/master$/blob\/preview/" \
58-
-e "1,3s/blob\/main$/blob\/preview/" /home/ubuntu/DWTDocPreview/_config.yml
59-
cd DWTDocPreview && bundle exec jekyll build --incremental
28+
[ -d web-twain-docs-archive ] && rm -rf web-twain-docs-archive
29+
[ -d Docs-Template-Repo-archive ] && rm -rf Docs-Template-Repo-archive
30+
[ -d DWTDocArchive ] && rm -rf DWTDocArchive
31+
mkdir -p DWTDocArchive
32+
git clone --depth 1 --branch v18.1 https://github.com/Dynamsoft/web-twain-docs.git web-twain-docs-archive
33+
git clone --depth 1 --branch dwt-v18.1 https://github.com/dynamsoft-docs/Docs-Template-Repo.git Docs-Template-Repo-archive
34+
cp -rfp ./web-twain-docs-archive/* ./DWTDocArchive/
35+
cp -rfp ./Docs-Template-Repo-archive/* ./DWTDocArchive/
36+
sed -i -e "1,3s/blob\/master$/blob\/v18.1/" \
37+
-e "1,3s/blob\/main$/blob\/v18.1/" /home/ubuntu/DWTDocArchive/_config.yml
38+
cd DWTDocArchive && bundle exec jekyll build
39+
6040
- name: Sync files
6141
uses: SamKirkland/FTP-Deploy-Action@4.3.0
6242
with:
6343
server: ${{ secrets.FTP_TEST_SITE_SERVER }}
6444
username: ${{ secrets.FTP_TEST_SITE_USER }}
6545
password: ${{ secrets.FTP_TEST_SITE_PASSWORD }}
6646
port: 7500
67-
local-dir: /home/ubuntu/DWTDocPreview/_site/
68-
server-dir: /www.dynamsoft.com/web-twain/docs/
47+
local-dir: /home/ubuntu/DWTDocArchive/_site/
48+
server-dir: /www.dynamsoft.com/web-twain/docs-archive/v18.1/
49+
50+
- name: Clear files
51+
run: |
52+
cd /home/ubuntu
53+
[ -d web-twain-docs-archive ] && rm -rf web-twain-docs-archive
54+
[ -d Docs-Template-Repo-archive ] && rm -rf Docs-Template-Repo-archive
55+
[ -d DWTDocArchive ] && rm -rf DWTDocArchive

‎_config.yml‎

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,33 @@
11
repositoryUrl: https://github.com/dynamsoft-docs/web-twain-docs/blob/master
2-
firstLevelUrl: /web-twain/docs
2+
firstLevelUrl: /web-twain/docs-archive/v18.1
33
repository: dynamsoft-docs/web-twain-docs
4-
docFullPath: https://www.dynamsoft.com/web-twain/docs
4+
docFullPath: https://www.dynamsoft.com/web-twain/docs-archive/v18.1
55
productUrl: https://www.dynamsoft.com/web-twain/overview/
66
productName: Dynamic Web TWAIN
7-
docHomePage: /web-twain/docs/
8-
dynamsoft_logo: /web-twain/docs/assets/img-icon/dynamsoft-logo.png
9-
dwt_logo: /web-twain/docs/assets/img-icon/dwt-logo.png
10-
edit_icon: /web-twain/docs/assets/img-icon/edit-icon.png
7+
docHomePage: /web-twain/docs-archive/v18.1/
8+
dynamsoft_logo: /web-twain/docs-archive/v18.1/assets/img-icon/dynamsoft-logo.png
9+
dwt_logo: /web-twain/docs-archive/v18.1/assets/img-icon/dwt-logo.png
10+
edit_icon: /web-twain/docs-archive/v18.1/assets/img-icon/edit-icon.png
1111

12-
assets: /web-twain/docs/assets/
13-
_includes: /web-twain/docs/_includes/
14-
_layouts: /web-twain/docs/_layouts/
15-
about: /web-twain/docs/about/
16-
getstarted: /web-twain/docs/getstarted/
17-
indepth: /web-twain/docs/indepth/
18-
info: /web-twain/docs/info/
19-
faq: /web-twain/docs/faq/
12+
assets: /web-twain/docs-archive/v18.1/assets/
13+
_includes: /web-twain/docs-archive/v18.1/_includes/
14+
_layouts: /web-twain/docs-archive/v18.1/_layouts/
15+
about: /web-twain/docs-archive/v18.1/about/
16+
getstarted: /web-twain/docs-archive/v18.1/getstarted/
17+
indepth: /web-twain/docs-archive/v18.1/indepth/
18+
info: /web-twain/docs-archive/v18.1/info/
19+
faq: /web-twain/docs-archive/v18.1/faq/
2020

21-
dynamsoft_logo: /web-twain/docs/assets/img-icon/dynamsoft-logo.png
22-
dbr_logo: /web-twain/docs/assets/img-icon/dbr-logo.png
23-
edit_icon: /web-twain/docs/assets/img-icon/edit-icon.png
24-
smile_icon: /web-twain/docs/assets/img-icon/icon-smile.png
25-
sad_icon: /web-twain/docs/assets/img-icon/icon-sad.png
26-
dbr_icon: /web-twain/docs/assets/img-icon/icon-dbr.svg
27-
dwt_icon: /web-twain/docs/assets/img-icon/icon-dwt.svg
28-
dnt_icon: /web-twain/docs/assets/img-icon/icon-dnt.svg
21+
dynamsoft_logo: /web-twain/docs-archive/v18.1/assets/img-icon/dynamsoft-logo.png
22+
dbr_logo: /web-twain/docs-archive/v18.1/assets/img-icon/dbr-logo.png
23+
edit_icon: /web-twain/docs-archive/v18.1/assets/img-icon/edit-icon.png
24+
smile_icon: /web-twain/docs-archive/v18.1/assets/img-icon/icon-smile.png
25+
sad_icon: /web-twain/docs-archive/v18.1/assets/img-icon/icon-sad.png
26+
dbr_icon: /web-twain/docs-archive/v18.1/assets/img-icon/icon-dbr.svg
27+
dwt_icon: /web-twain/docs-archive/v18.1/assets/img-icon/icon-dwt.svg
28+
dnt_icon: /web-twain/docs-archive/v18.1/assets/img-icon/icon-dnt.svg
2929

30-
baseurl: /web-twain/docs/
30+
baseurl: /web-twain/docs-archive/v18.1/
3131

3232
theme: jekyll-theme-cayman
3333

‎_layouts/default-layout.html‎

Lines changed: 18 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -15,32 +15,35 @@
1515
</style>
1616

1717
<body>
18-
<header class="headWrapper">
18+
<div class="headWrapper">
1919
{%- include page_header.html -%}
20-
</header>
20+
</div>
2121
{%- include dwtNav.html -%}
2222
<div class="sideBarIcon"><i class="fa fa-list" style="margin-right: 5px;"></i> Table of contents</div>
23-
<main class="container" id="categoryMenuTree">
23+
<div class="container" id="categoryMenuTree">
2424
<div class="row">
25-
<aside class="sideBar col-xs-12 col-md-3 hide-xs hide-sm">
25+
<div class="sideBar col-xs-12 col-md-3 hide-xs hide-sm">
2626
<div id="sideBarCnt">
2727
<div class="docSearchPart" style="margin-top: 30px;">
2828
<input id="txtSearch" class="search" type="text">
2929
</div>
30-
<nav class="mainPage">
30+
<div class="mainPage">
3131
<ul id="fullTreeMenuListContainer" name="listLevel1">
3232
{%- assign treeList = site.data.full_tree.tree_list -%}
3333
{%- include liquid_generateFullTree.html treeList=treeList -%}
3434
</ul>
35-
</nav>
35+
</div>
3636
</div>
37-
</aside>
38-
<section class="docContainer col-xs-12 col-md-9">
37+
</div>
38+
<div class="docContainer col-xs-12 col-md-9">
3939
<div id="docHead" class = "head row hide-xs hide-sm">
4040
{%- include main-page-head.html -%}
4141
</div>
4242
<div class="main row showRightSideMenu" id="articleContent" data-needh3="{{page.needGenerateH3Content}}">
4343
<div class="content markdown-body headCounter {{noTitleIndex}} col-xs-12 col-md-12 col-lg-9 col-xl-10 showRightSideMenu">
44+
<div id="versionNote" style="width: 100%; padding: 20px; background: #b42727; color: #ffffff;border-radius: 5px;">
45+
This is the archived documentation for <span id="versionNoteOldVersion">18.1</span>. If you are using the latest version<span id="versionNoteLatestVersion"></span>, please visit <a class="noVersionAdd" href="/web-twain/docs/about/index.html" style="color: #ffffff;text-decoration: underline !important;">this link</a>.
46+
</div>
4447
{{ content }}
4548

4649
</div>
@@ -62,9 +65,9 @@
6265
<div class="lds-ring"><div></div><div></div><div></div><div></div></div>
6366
</div>
6467
</div>
65-
</section>
68+
</div>
6669
</div>
67-
</main>
70+
</div>
6871

6972
<div class="history list" id="categoryMenuTree_history">
7073
<div class="container">
@@ -75,14 +78,14 @@
7578
</div>
7679
</div>
7780

78-
<footer id="footerWrapper">
81+
<div id="footerWrapper">
7982
{%- include page_footer.html -%}
80-
</footer>
83+
</div>
84+
85+
<script type="text/javascript">anchors.add();</script>
86+
<script type="text/javascript">UrlReplace();</script>
8187

8288
<script type="text/javascript">
83-
$(".currentVersion").text("latest version (18.1)");
84-
anchors.add();
85-
UrlReplace();
8689
FullTreeMenuList('{{page.needAutoGenerateSidebar}}', '{{page.needGenerateH3Content}}');
8790
</script>
8891

0 commit comments

Comments
 (0)