web: Add web

.github/workflows/publish-docs.yml

@@ -0,0 +1,19 @@
+name: Publish docs via GitHub Pages
+
+on: push
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v2
+        with:
+          python-version: 3.x
+      - run: cd docs/
+      - run: pip install git+https://${GH_TOKEN}@github.com/squidfunk/mkdocs-material-insiders.git
+      - run: pip install -r requirements.txt
+      - run: mkdocs gh-deploy --force
+
+env:
+  GH_TOKEN: ${{ secrets.GH_TOKEN }}

docs/docs/CNAME

@@ -0,0 +1 @@
+databap.incubator.edurt.io

docs/docs/index.md

@@ -0,0 +1,4 @@
+---
+template: home.html
+title: DataCap (incubator)
+---

docs/mkdocs.yml

@@ -0,0 +1,116 @@
+site_name: DataCap (incubator)
+site_url: https://databap.incubator.edurt.io/
+site_author: EdurtIO
+site_description: >-
+  DataCap is integrated software for data transformation, integration and visualization.
+repo_name: EdurtIO/incubator-datacap
+repo_url: https://github.com/EdurtIO/incubator-datacap
+edit_uri: "https://github.com/EdurtIO/incubator-datacap/blob/master/docs"
+
+copyright: Copyright © 2022 EdurtIO
+
+theme:
+  name: material
+  custom_dir: overrides
+  icon:
+    logo: material/open-source-initiative
+  favicon: material/open-source-initiative
+
+  include_search_page: false
+  search_index_only: true
+
+  language: en
+  features:
+    - content.code.annotate
+    - content.tabs.link
+    - navigation.expand
+    - navigation.indexes
+    - navigation.sections
+    - navigation.tabs
+    - navigation.top
+    - navigation.tracking
+    - search.highlight
+    - search.share
+    - search.suggest
+    - content.tooltips
+
+  palette:
+    - scheme: default
+      toggle:
+        icon: material/brightness-7
+        name: Switch to dark mode
+    - scheme: slate
+      toggle:
+        icon: material/brightness-4
+        name: Switch to light mode
+
+  font:
+    text: Roboto
+    code: Roboto Mono
+extra:
+  social:
+    - icon: fontawesome/brands/github
+      link: https://github.com/EdurtIO
+    - icon: fontawesome/brands/linkedin
+      link: https://linkedin.com/in/qianmoQ/
+
+  consent:
+    title: Cookie consent
+    description: >-
+      We use cookies to recognize your repeated visits and preferences, as well
+      as to measure the effectiveness of our documentation and whether users
+      find what they're searching for. With your consent, you're helping us to
+      make our documentation better.
+
+markdown_extensions:
+  - admonition
+  - abbr
+  - attr_list
+  - def_list
+  - footnotes
+  - meta
+  - md_in_html
+  - tables
+  - toc:
+      permalink: true
+  - pymdownx.arithmatex:
+      generic: true
+  - pymdownx.betterem:
+      smart_enable: all
+  - pymdownx.caret
+  - pymdownx.details
+  - pymdownx.emoji:
+      emoji_index: !!python/name:materialx.emoji.twemoji
+      emoji_generator: !!python/name:materialx.emoji.to_svg
+  - pymdownx.highlight
+  - pymdownx.inlinehilite
+  - pymdownx.keys
+  - pymdownx.snippets
+  - pymdownx.magiclink:
+      repo_url_shorthand: true
+      user: EdurtIO
+      repo: incubator-datacap
+  - pymdownx.mark
+  - pymdownx.smartsymbols
+  - pymdownx.superfences
+  - pymdownx.tabbed:
+      alternate_style: true
+  - pymdownx.tasklist:
+      custom_checkbox: true
+  - pymdownx.tilde
+  - pymdownx.emoji:
+      emoji_index: !!python/name:materialx.emoji.twemoji
+      emoji_generator: !!python/name:materialx.emoji.to_svg
+
+use_directory_urls: false
+
+plugins:
+  - search
+  - git-revision-date-localized:
+      enable_creation_date: true
+      fallback_to_build_date: true
+  - git-authors
+
+nav:
+  - Home: index.md
+  - Plugin: guide/plugin.md

docs/overrides/home.html

@@ -0,0 +1,51 @@
+{#-
+This file was automatically generated - do not edit
+-#}
+{% extends "main.html" %}
+{% block tabs %}
+{{ super() }}
+<style>
+  .md-header {
+    position: initial
+  }
+
+  .md-main__inner {
+    margin: 0
+  }
+
+  .md-content {
+    display: none
+  }
+
+  @media screen and (min-width:60em) {
+    .md-sidebar--secondary {
+      display: none
+    }
+  }
+
+  @media screen and (min-width:76.25em) {
+    .md-sidebar--primary {
+      display: none
+    }
+  }
+</style>
+<section class="mdx-container">
+  <div class="md-grid md-typeset">
+    <div class="mdx-hero">
+      <div class="mdx-hero__image">
+        <img src="assets/images/illustration.png" alt="" width="1659" height="1200" draggable="false">
+      </div>
+      <div class="mdx-hero__content">
+        <h1>Feel free to join us and contribute your code.</h1>
+        <h3 class="lead">DataCap is integrated software for data transformation, integration and visualization.</h3>
+        <a href="https://github.com/EdurtIO/incubator-datacap" target="_blank" title="Join Us On GitHub" class="md-button md-button--primary">
+          Join Us On GitHub
+        </a>
+      </div>
+    </div>
+  </div>
+  <br />
+</section>
+{% endblock %}
+{% block content %}{% endblock %}
+{% block footer %}{% endblock %}

docs/overrides/main.html

@@ -0,0 +1,66 @@
+{#-
+This file was automatically generated - do not edit
+-#}
+{% extends "base.html" %}
+{% block extrahead %}
+<link href="https://cdn.bootcdn.net/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css" rel="stylesheet" />
+<link rel="stylesheet" href="{{ 'assets/stylesheets/main.82a244a8.min.css' | url }}" />
+{% endblock %}
+{% block announce %}
+  DataCap is started ... <i class="fa fa-heart" style="color: red;"></i>
+{% endblock %}
+
+{% block content %}
+{{ super() }}
+<!-- Giscus -->
+<h2 id="__comments">{{ lang.t("meta.comments") }}</h2>
+<!-- Replace with generated snippet -->
+<script src="https://giscus.app/client.js"
+        data-repo="EdurtIO/incubator-datacap"
+        data-repo-id="R_kgDOIAzx4g"
+        data-category="Q&A"
+        data-category-id="DIC_kwDOIAzx4s4CRfmA"
+        data-mapping="pathname"
+        data-strict="0"
+        data-reactions-enabled="1"
+        data-emit-metadata="0"
+        data-input-position="bottom"
+        data-theme="preferred_color_scheme"
+        data-lang="zh-CN"
+        data-loading="lazy"
+        crossorigin="anonymous"
+        async>
+</script>
+<!-- Reload on palette change -->
+<script>
+  var palette = __md_get("__palette")
+  if (palette && typeof palette.color === "object")
+    if (palette.color.scheme === "slate") {
+      var giscus = document.querySelector("script[src*=giscus]")
+      giscus.setAttribute("data-theme", "dark")
+    }
+
+  /* Register event handlers after documented loaded */
+  document.addEventListener("DOMContentLoaded", function () {
+    var ref = document.querySelector("[data-md-component=palette]")
+    ref.addEventListener("change", function () {
+      var palette = __md_get("__palette")
+      if (palette && typeof palette.color === "object") {
+        var theme = palette.color.scheme === "slate" ? "dark" : "light"
+
+        /* Instruct Giscus to change theme */
+        var frame = document.querySelector(".giscus-frame")
+        frame.contentWindow.postMessage(
+          { giscus: { setConfig: { theme } } },
+          "https://giscus.app"
+        )
+      }
+    })
+  })
+</script>
+{% endblock %}
+
+{% block scripts %}
+{{ super() }}
+<script src="{{ 'assets/javascripts/bundle.39654835.min.js' | url }}"></script>
+{% endblock %}

docs/requirements.txt

@@ -0,0 +1,6 @@
+mkdocs-static-i18n>=0.43
+mkdocs-git-revision-date-localized-plugin
+mkdocs-redirects
+mkdocs-material-extensions
+mkdocs-git-committers-plugin-2
+mkdocs-git-authors-plugin