Update website (cvat-ai#3293)

* update docsy theme * update website * return to markdown markup * add item update submodule in site/README.md
udcool · Jun 8, 2021 · 6665fe1 · 6665fe1
1 parent 675ef96
commit 6665fe1
Show file tree

Hide file tree

Showing 8 changed files with 36 additions and 9 deletions.
diff --git a/site/README.md b/site/README.md
@@ -61,3 +61,19 @@ Then you can build a website in the "public" folder:
     hugo
 
 [Read more](https://www.docsy.dev/docs/getting-started/)
+
+### Update the submodule of the docsy theme
+
+To update the submodule of the docsy theme you need to have a repository clone. While in the repository folder,
+use the git command:
+
+    git submodule update --remote
+
+Add and then commit the change to project:
+
+    git add themes/
+    git commit -m "Updating theme submodule"
+
+Push the commit to project repo. For example, run:
+
+    git push
diff --git a/site/assets/scss/_custom.scss b/site/assets/scss/_custom.scss
@@ -4,8 +4,9 @@
 
 /* Increased left padding on the sidebar of documentation */
 
-.td-sidebar-nav__section-title .td-sidebar-nav__section {
-    padding-left: 0.3rem;
+.td-sidebar-nav__section .ul-1 ul {
+    padding-left: 0.6rem !important;
+    padding-right: 0.1rem !important;
 }
 
 /* Main documentation page */

diff --git a/site/content/en/about/_index.html b/site/content/en/about/_index.html
@@ -141,7 +141,7 @@ <h3 class="col-12 text-center">Core Team</h3>
         </ul>
         <ul class="col-lg-6 text-left">
           <li>
-            You can ask questions anytime in <a href="https://gitter.im/opencv-cvat/dev">Gitter chat for developers</a>.
+            We have is a separate <a href="https://gitter.im/opencv-cvat/dev">Gitter chat for developers</a> to discuss the development of CVAT.
           </li>
           <li>
             Visit our <a href="https://github.com/openvinotoolkit/cvat">GitHub</a> repository.

diff --git a/site/content/en/docs/for-users/installation.md b/site/content/en/docs/for-users/installation.md
@@ -2,8 +2,8 @@
 
 ---
 
-title: 'Installation'
-linkTitle: 'Installation'
+title: 'Installation Guide'
+linkTitle: 'Installation Guide'
 weight: 1
 description: 'CVAT installation guide for different operating systems'
 

diff --git a/site/content/en/docs/for-users/installation_automatic_annotation.md b/site/content/en/docs/for-users/installation_automatic_annotation.md
@@ -3,7 +3,7 @@
 ---
 
 title: 'Semi-automatic and Automatic Annotation'
-linkTitle: 'Semi-automatic and Automatic Annotation'
+linkTitle: 'Installation Auto Annotation'
 weight: 5
 description: 'This page provides information about the installation of components needed for
 semi-automatic and automatic annotation'

diff --git a/site/layouts/404.html b/site/layouts/404.html
@@ -1,9 +1,9 @@
 {{ define "main"}}
     <main id="main">
       <div class="text-center">
-       <h1 id="title">404</h1>
+       <h1>404</h1>
        <p>Not found</p>
-       <p>Oops! This page doesn't exist. Try going back to our <a href="{{ "/" | relURL }}">home page</a> or <a href="./docs">documentation page</a>.</p>
+       <p>Oops! This page doesn't exist. Try going back to our <a href="./about">about page</a> or <a href="./docs">documentation page</a>.</p>
       </div>
     </main>
 {{ end }}
diff --git a/site/layouts/shortcodes/blocks/feature.html b/site/layouts/shortcodes/blocks/feature.html
@@ -0,0 +1,10 @@
+{{ $icon := .Get "icon" | default "fa-lightbulb" }}
+{{ $url_text := .Get "url_text" }}
+<div class="col-lg-4 mb-5 mb-lg-0 text-center ">
+  <div class="mb-4 h1">
+    <i class="{{ if not (or (hasPrefix $icon "fas ") (hasPrefix $icon "fab ")) }}fas {{ end }}{{ $icon }}"></i>
+  </div>
+  <h4 class="h3">{{ .Get "title" | markdownify }}</h4>
+  <p class="mb-0">{{ .Inner }}</p>
+  {{ with .Get "url" }}<p><a href="{{ . }}">{{ with $url_text }}{{ $url_text }}{{ else }}{{ T "ui_read_more" }}{{ end }} …</a></p>{{ end }}
+</div>
diff --git a/site/themes/docsy b/site/themes/docsy
+5 −0		assets/js/offline-search.js
+18 −2		assets/scss/_sidebar-tree.scss
+2 −2		assets/scss/_variables.scss
+1 −1		assets/vendor/bootstrap
+55 −0		i18n/bg.toml
+2 −2		i18n/de.toml
+55 −0		i18n/tr.toml
+2 −2		layouts/_default/content.html
+1 −1		layouts/blog/list.html
+1 −1		layouts/docs/list.html
+1 −1		layouts/partials/community_links.html
+3 −3		layouts/partials/footer.html
+7 −4		layouts/partials/head.html
+7 −1		layouts/partials/page-meta-lastmod.html
+1 −1		layouts/partials/page-meta-links.html
+3 −3		layouts/partials/pager.html
+15 −1		layouts/partials/scripts.html
+1 −1		layouts/partials/search-input.html
+4 −2		layouts/partials/section-index.html
+4 −4		layouts/partials/sidebar-tree.html
+1 −0		layouts/partials/sidebar.html
+14 −2		layouts/shortcodes/blocks/feature.html
+1 −1		layouts/shortcodes/blocks/link-down.html
+20 −0		layouts/shortcodes/card-code.html
+50 −0		layouts/shortcodes/card.html
+3 −0		layouts/shortcodes/cardpane.html
+21 −0		layouts/shortcodes/iframe.html
+2 −10		layouts/shortcodes/swaggerui.html
+28 −0		layouts/shortcodes/tab.html
+43 −0		layouts/shortcodes/tabpane.html
+4 −5		layouts/swagger/baseof.html
+1 −1		layouts/swagger/list.html
+1 −1		netlify.toml
+2 −0		static/css/shortcodes.css
+21 −0		static/css/shortcodes/cards-pane.css
+18 −0		static/css/shortcodes/tabbed-pane.css
+10 −2		userguide/config.toml
+258 −1		userguide/content/en/docs/Adding content/Shortcodes/index.md
+130 −3		userguide/content/en/docs/Adding content/lookandfeel.md
+20 −0		userguide/content/en/docs/Adding content/navigation.md
+5 −1		userguide/content/en/docs/Examples/_index.md
+1 −4		userguide/content/en/docs/Getting started/quickstart-docker.md
+1,815 −420		userguide/package-lock.json