dynamsoft-docs · DMGithubPublisher · Jul 4, 2023 · Apr 17, 2023 · Apr 17, 2023 · Apr 17, 2023
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -5,9 +5,9 @@ name: CI
 # Controls when the workflow will run
 on:
   # Triggers the workflow on push events but only for the main branch
-   push:
-     branches: 
-  #   - main 
+  push:
+    branches: 
+     - main 
      - preview 
 
   # Allows you to run this workflow manually from the Actions tab
@@ -52,8 +52,8 @@ jobs:
           username: ${{ secrets.FTP_DYNAMSOFT_LOCAL_USER }}
           password: ${{ secrets.FTP_DYNAMSOFT_LOCAL_PASSWORD }}
           port: 21 
-          local-dir: /home/ubuntu/DDNDocServer/_site/
-          server-dir: /www.dynamsoft.com/code-parser/docs/js/
+          local-dir: /home/ubuntu/DCPDocJS/_site/
+          server-dir: /www.dynamsoft.com/code-parser/docs/web/
 
   Build-Preview:
     if: ${{ github.ref == 'refs/heads/preview' }}
@@ -91,4 +91,4 @@ jobs:
           password: ${{ secrets.FTP_TEST_SITE_PASSWORD }}
           port: 7500 
           local-dir: /home/ubuntu/DCPDocJSPreview/_site/
-          server-dir: /www.dynamsoft.com/code-parser/docs/js/          
+          server-dir: /www.dynamsoft.com/code-parser/docs/web/          
diff --git a/_config.yml b/_config.yml
@@ -0,0 +1,48 @@
+repositoryUrl: https://github.com/dynamsoft-docs/code-parser-docs-js/blob/main
+repository: dynamsoft-docs/code-parser-docs-js
+docFullPath: https://www.dynamsoft.com/code-parser/docs/web
+firstLevelUrl: /code-parser/docs/web/
+docHomePage: /code-parser/docs/core/introduction/
+
+javascript: /code-parser/docs/web/programming/javascript/
+javascript-api: /code-parser/docs/web/programming/javascript/api-reference/
+javascript-api-enum: /code-parser/docs/web/programming/javascript/api-reference/enum/
+javascript-api-interface: /code-parser/docs/web/programming/javascript/api-reference/interface/
+javascript-release-notes: /code-parser/docs/web/programming/javascript/release-notes/
+
+assets: /code-parser/docs/web/assets/
+edit_icon: /code-parser/docs/web/assets/img-icon/edit-icon.png
+smile_icon: /code-parser/docs/web/assets/img-icon/icon-smile.png
+sad_icon: /code-parser/docs/web/assets/img-icon/icon-sad.png
+dbr_icon: /code-parser/docs/web/assets/img-icon/icon-dbr.svg
+dwt_icon: /code-parser/docs/web/assets/img-icon/icon-dwt.svg
+dnt_icon: /code-parser/docs/web/assets/img-icon/icon-dnt.svg
+
+release-notes: /code-parser/docs/core/release-notes/
+
+useVersionTree: true
+
+baseurl: "/code-parser/docs/web"
+plugins:
+  - jemoji
+
+defaults:
+  - scope:
+      path: ""
+    values:
+      layout: "default-layout"
+      noTitleIndex: true
+      needAutoGenerateSidebar: true
+      needGenerateH3Content: true
+  - scope: 
+      path: "programming/javascript" 
+    values: 
+      docRootName: "Code Parser JS Edition" 
+      docHomePage: "/code-parser/docs/web/programming/javascript/"
+  - scope:
+      path: "Hide_Tree_Page.html"
+    values:
+      sitemap: false
+
+url: "https://www.dynamsoft.com" # sitemap root
+
diff --git a/_data/full_tree.yml b/_data/full_tree.yml
@@ -0,0 +1,3 @@
+tree_file_list:
+    - sidelist-full-tree.html
+    - sidelist-programming-javascript.html
diff --git a/_data/product_version.yml b/_data/product_version.yml
@@ -0,0 +1,2 @@
+version_info_list:
+  - latest version
diff --git a/_includes/dcpNav.html b/_includes/dcpNav.html
@@ -0,0 +1,77 @@
+<style>
+    #cp-header .action-buttons {
+        display: none;
+    }
+
+    #mdHeader {
+        border-bottom: 0!important;
+    }
+
+    #sideBarCnt.sidebar-fixed {
+        position: fixed;
+        top: 88px;
+        max-height: unset;
+    }
+
+    .rightSideMenu.rsm-fixed {
+        position: fixed;
+        top: 100px;
+    }
+
+    #docHead {
+        top: 186px;
+    }
+
+    .productMenu .downloadBtn:hover {
+        color: #ffffff!important;
+    }
+
+    @media (max-width: 1679px) {
+        #docHead {
+            top: 145px;
+        }
+    }
+</style>
+
+<div id="CodeParser" class="main">
+    <div id="CodeParserMenu" class="productMenu">
+        <div class="container pcProductMenu">
+            <div class="row">
+                <div class="col-xs-12">
+                    <ul class="menuList">
+                        <!---->
+                        <li class="title"><a class="orangeLink" href="{{site.docHomePage}}">Dynamsoft Code Parser</a></li>
+                        <li class="item overview">
+                            <!---->
+                            <a class="textUpperCase" href="{{site.release-notes}}">Release Notes</a>
+                        </li>
+                        <li class="item overview">
+                            <!---->
+                            <a class="textUpperCase" href="{{site.docHomePage}}">Documentation</a>
+                        </li>
+                    </ul>
+                </div>
+            </div>
+        </div>
+        <div class="container mobileProductMenu">
+            <div class="row">
+                <div class="col-xs-12">
+                    <div class="productLogo" style="color:#fe8e14!important;font:10px">Dynamsoft Code Parser <i class="icon-orange-angle"></i></div>
+                    <div id="dcpCurrentPage" class="fontOswald fr currentPage">Resource Base</div>
+                </div>
+            </div>
+        </div>
+        <div class="mobileProductDetailMenu">
+            <div class="container">
+                <div class="row">
+                    <div class="col-xs-12">
+                        <ul class="menuList">
+                            <li class="item"><a href="{{site.release-notes}}">Release Notes</a></li>
+                            <li class="item"><a href="{{site.firstLevelUrl}}">Documentation</a></li>
+                        </ul>
+                    </div>
+                </div>
+            </div>
+        </div>
+    </div>
+</div>
diff --git a/_includes/sidelist-full-tree.html b/_includes/sidelist-full-tree.html
@@ -0,0 +1 @@
+{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-programming-javascript.html" -%}
diff --git a/_includes/sidelist-programming-javascript.html b/_includes/sidelist-programming-javascript.html
@@ -0,0 +1,30 @@
+<li class="category">DEVELOPMENT</li>
+<li><a style="cursor:pointer;color:#3c3c3c" href="{{ site.javascript }}user-guide.html" class="otherLinkColour">User Guide</a>
+</li>
+<li><a style="cursor:pointer;color:#3c3c3c" class="otherLinkColour">API Reference</a>
+    <ul>
+        <li><a href="{{ site.javascript-api }}CodeParser.html" class="otherLinkColour">CodeParser for code parsing</a></li>
+        <li><a href="{{ site.javascript-api }}LicenseControl.html" class="otherLinkColour">License Control</a></li>
+        <li><a href="{{ site.javascript-api }}InitializeEngine.html" class="otherLinkColour">Initialization Control</a></li>
+        <li><a href="{{ site.javascript-api-interface }}index.html" class="otherLinkColour">Interfaces</a>
+            <ul>
+                <li><a href="{{ site.javascript-api-interface }}BasicPersonalInfo.html" class="otherLinkColour">BasicPersonalInfo</a></li>
+                <li><a href="{{ site.javascript-api-interface }}CodeParserException.html" class="otherLinkColour">CodeParserException</a></li>
+                <li><a href="{{ site.javascript-api-interface }}ParseResult.html" class="otherLinkColour">ParseResult</a></li>
+            </ul>
+        </li>
+        <li><a href="{{ site.javascript-api-enum }}index.html" class="otherLinkColour">Enums</a>
+            <ul>
+                <li><a href="{{ site.javascript-api-enum }}EnumCodeFormat.html" class="otherLinkColour">EnumCodeFormat</a></li>
+                <li><a href="{{ site.javascript-api-enum }}EnumErrorCode.html" class="otherLinkColour">EnumErrorCode</a></li>
+                <li><a href="{{ site.javascript-api-enum }}EnumResultInfoType.html" class="otherLinkColour">EnumResultInfoType</a></li>
+            </ul>
+        </li>
+    </ul>
+</li>
+<li ><a href="{{ site.javascript-release-notes }}" class="otherLinkColour">Release Notes</a>
+    <ul >
+        <li ><a href="{{ site.javascript-release-notes }}js-2.html" class="otherLinkColour">Version 1.x</a></li>
+    </ul>
+</li>
+
diff --git a/_layouts/default-layout.html b/_layouts/default-layout.html
@@ -0,0 +1,106 @@
+<!DOCTYPE html>
+<html lang="en-US">
+
+{%- include head.html -%}
+
+<body class="dlrDoc">
+    <div class="headWrapper">
+        {%- include page_header.html -%}
+    </div>
+    {%- include dcpNav.html -%}
+    <div class="sideBarIcon"><i class="fa fa-list" style="margin-right: 5px;"></i> Table of contents</div>
+    <div class="container" id="categoryMenuTree">
+        <div class="row">
+            <div class="sideBar col-xs-12 col-md-3 hide-xs hide-sm">
+                <div id="sideBarCnt">
+                    <div class="docSearchPart" style="margin-top: 30px;">
+                        <input id="txtSearch" class="search" type="text">
+                    </div>
+                    <div class="mainPage">
+                        <ul id="fullTreeMenuListContainer" name="listLevel1">
+                        </ul>
+                    </div>
+                </div>
+            </div>
+            <div class="docContainer col-xs-12 col-md-9">
+                <div id="docHead" class = "head row hide-xs hide-sm">
+                    {%- include main-page-head.html -%}
+                </div>
+                <div class="main row showRightSideMenu" id="articleContent" data-needh3="{{page.needGenerateH3Content}}">
+                    <div class="content markdown-body headCounter {{noTitleIndex}} col-xs-12 col-md-12 col-lg-9 col-xl-10 showRightSideMenu" style="margin-bottom: 20px;">
+                        {{ content }}
+                    </div>
+                    <div class="rightSideMenu col-xs-12 col-md-12 col-lg-3 col-xl-2  hide-md hide-sm hide-xs showRightSideMenu">
+                        <div id="compatibleInfo">
+                            <p>This page is compatible for:</p>
+                            <p class="compatibleCurVersion">Version 1.0</p>
+                        </div>
+                        <div id="feedbackFooter" style="color: #306877;">
+                            <p class="fontOswald">Is this page helpful? </p>
+                            <a href="javascript:void(0)" style="color: #306877;" class="recordLink smileLink" onclick="UsefulRecord(true)"><img class="icon-smile" src="{{ site.smile_icon }}" alt="Yes" />Yes</a>
+                            <a href="javascript:void(0)" style="color: #306877;" class="recordLink sadLink" onclick="UsefulRecord(false)"><img class="icon-sad" src="{{ site.sad_icon }}" alt="No" />No</a>
+                        </div>
+                        <hr />
+                        {%- if page.needAutoGenerateSidebar -%}
+                        <p class="fontOswald" style="color: #306877;"> In this article: </p>
+                        <div id="AutoGenerateSidebar"></div>
+                        {%- endif -%}
+                    </div>
+                </div>
+                <div class="main row" style="display: none; background: #f5f5f5;" id="loadingContent">
+                    <div class="loading" id="loadingLogin">
+                        <div class="lds-ring"><div></div><div></div><div></div><div></div></div>
+                    </div>
+                </div>
+            </div>
+        </div>
+    </div>
+    <div class="history list"  id="categoryMenuTree_history">
+        <div class="container">
+            <div class="col-xs-12">
+                {%- include liquid_autoGenerateHistoryList.html -%}
+                {%- include auto-version-list.html -%}
+            </div>
+        </div>
+    </div>
+    <div id="footerWrapper">
+        {%- include page_footer.html -%}
+    </div>
+
+    <iframe id="sideBarIframe" src="{{ site.firstLevelUrl }}/Hide_Tree_Page.html" allow="" height="0" frameborder="0"></iframe>
+
+    <script type="text/javascript">
+        anchors.add();
+    </script>
+
+    <script type="text/javascript">
+        UrlReplace();
+    </script>
+
+    <script type="text/javascript">
+        FullTreeMenuList('{{ page.needAutoGenerateSidebar }}', '{{ page.needGenerateH3Content }}', '{{ page.pageStartVer }}', '{{ site.useVersionTree }}');
+    </script>
+
+    {%- include livehelp.html -%}
+
+    <script type="text/javascript">
+        $('#txtSearch').keydown(function(e) { 
+            if (e.keyCode == 13) {
+                window.location.href = '/code-parser/search.html?q=' + $('#txtSearch').val()
+            }
+        })
+    </script>
+
+    <!-- Google Tag Manager -->
+    <noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-538F83"
+    height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
+    <script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':
+    new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],
+    j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
+    '//www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
+    })(window,document,'script','dataLayer','GTM-538F83');</script>
+    <!-- End Google Tag Manager -->
+
+</body>
+
+</html>
diff --git a/_layouts/home-page.html b/_layouts/home-page.html
@@ -0,0 +1,50 @@
+<!DOCTYPE html>
+<html lang="en-US">
+
+{%- include head.html -%}
+
+<style>
+    .markdown-body .editLinkColour { color: #323234; vertical-align: middle; height: 24px; line-height: 24px; display: inline-block; }
+    .markdown-body .editLinkColour:hover { color: #616167; }
+    .homepageContainer {
+        min-height: calc(100vh - 165px);
+    }
+    @media (max-width: 767px) {
+        .homepageContainer {
+            min-height: calc(100vh - 144px);
+        }
+    }
+</style>
+
+<body>
+    <div class="headWrapper">
+        {%- include page_header.html -%}
+    </div>
+    <div class="markdown-body homepageContainer container">
+        <div class="row">
+            <div class="col-xs-12 col-md-10 col-md-offset-1 col-xl-8 col-xl-offset-2">
+                <!-- <p class="pull-right">
+                    {% capture sourceCodeUrl %}		
+                    {% if page.url contains '.html' %}		
+                        {{ page.url | strip | replace: '.html', '.md'}}		
+                    {% else %}
+                        {{ page.url	| strip }}index.md
+                    {% endif %}
+                    {% endcapture %}
+                    <a href="{{ site.repositoryUrl }}{{ sourceCodeUrl | strip }}" class="editLinkColour">Edit<img src="{{ site.edit_icon }}" width="20px" height="15px" style="vertical-align: middle; margin-left: 5px; margin-top: -3px;" /></a>
+                </p> -->
+                {{ content }}
+            </div>
+        </div>
+    </div>
+    <div id="footerWrapper">
+        {%- include page_footer.html -%}
+    </div>
+
+    <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.1.0/anchor.min.js"
+        integrity="sha256-lZaRhKri35AyJSypXXs4o6OPFTbTmUoltBbDCbdzegg=" crossorigin="anonymous"></script>
+    <script>anchors.add();</script>
+
+</body>
+
+</html>
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-programming-javascript.html" -%}