update doc

Signed-off-by: xiaoming <[email protected]>

docs/.gitignore

@@ -1,3 +1,2 @@
 /_build
-/_static
 !Makefile

docs/_static/toctree.css

@@ -0,0 +1,4 @@
+.toctree-wrapper,
+.toctree {
+    display: none;
+}

docs/conf.py

@@ -19,23 +19,27 @@
 copyright = '2023, Quard(qiaoqiming)'
 author = 'Quard(qiaoqiming)'
 
-extensions = ['myst_parser']
+extensions = ['myst_parser', 'sphinxcontrib.googleanalytics']
 templates_path = ['_templates']
+html_static_path = ['_static']
 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
 
-language = ['en']
+language = 'en'
 html_theme = 'sphinx_material'
 html_title = 'Home'
 
 html_sidebars = {
     "**": ["logo-text.html", "globaltoc.html", "localtoc.html", "searchbox.html"]
 }
 
+googleanalytics_enabled = True
+googleanalytics_id = 'G-10XGZR5Z3C'
+
 html_theme_options = {
     'nav_title': 'quardCRT',
 
-    #'color_primary': 'blue',
-    #'color_accent': 'light-blue',
+    'color_primary': 'black',
+    'color_accent': 'light-blue',
 
     'repo_url': 'https://github.com/QQxiaoming/quardCRT',
     'repo_name': 'quardCRT',
@@ -49,3 +53,12 @@
         {"href": "installation","internal": True,"title": "Installation"},
     ],
 }
+
+source_suffix = {
+    '.rst': 'restructuredtext',
+    '.md': 'markdown',
+}
+
+def setup(app):
+    app.add_css_file('toctree.css') 
+

docs/index.rst

@@ -42,9 +42,61 @@ quardCRT
    :target: https://gitee.com/QQxiaoming/quardCRT
    :alt: Gitee forks
 
-.. image:: ./img/windows.png
-.. image:: ./img/macos.png
-.. image:: ./img/linux.png
+quardCRT is a terminal emulation and remote desktop software that supports multiple backend protocols, can be used across platforms without dependencies, and has a completely consistent user experience on windows/linux/mac. It supports traditional terminal software functions such as multi-tab and history management, and supports some unique detailed functions.
+
+.. list-table:: 
+   :widths: 33 33 33
+   :header-rows: 0
+
+   * - .. image:: ./img/windows.png
+          :align: center
+          :height: 160px
+     - .. image:: ./img/macos.png
+          :align: center
+          :height: 160px
+     - .. image:: ./img/linux.png
+          :align: center
+          :height: 160px
+   * - Windows
+     - MacOS
+     - Linux
+
+----------------------------------
+Features
+----------------------------------
+
+- **Cross-platform**: Windows, MacOS, Linux
+- **Multiple protocols**: SSH, Telnet, SFTP, Serial, VNC, LocalShell, RawSocket, NamedPipe
+- **Multiple sessions**: Multi-tab, multi-window, multi-monitor, floating window
+- **Multiple languages**: English, Simple Chinese, Traditional Chinese, Japanese, Korean, Spanish, French, Russian
+- **Multiple themes**: Light, Dark
+- **Session history management**: Session history management, session history search
+- **Session management**: Session management, session import and export
+- **HEX display**: HEX display
+- **Script**: Script recording, script playback
+- **Terminal customization**: Terminal font, color, size, cursor, scrollback, background, etc.
+
+----------------------------------
+Special functions
+----------------------------------
+
+- Tab floating preview
+- Floating window support, tab drag-and-drop to floating window
+- SSH2 session one-click open SFTP file transfer window
+- Working directory bookmark
+- Automated sending
+- Terminal background image supports gif animation and video
+- Terminal keyword highlight matching
+- Selected text translation function
+- Path matching and one-click direct
+- Working path direct
+- Windows local terminal enhancement (Tab key to select complete command, etc.)
+
+----------------------------------
+Plugin
+----------------------------------
+
+quardCRT will support plugins from version V0.4.0, plugins will be provided in the form of Qt plugins, loaded in the form of dynamic libraries, to learn more about plugin development information, please refer to the plugin open `platform <https://github.com/QuardCRT-platform>`_. This platform will provide template repositories and related examples for plugin development. At present, the plugin function is still in the early development stage. If you have good ideas or suggestions, please submit issues or discussions on `GitHub <https://github.com/QQxiaoming/quardCRT>`_ or `Gitee <https://gitee.com/QQxiaoming/quardCRT>`_
 
 .. toctree::
    :maxdepth: 3
@@ -59,3 +111,4 @@ quardCRT
    License<license.md>
    Roadmap<roadmap.md>
    Acknowledgements<acknowledgements.md>
+

docs/requirements.txt

@@ -1,4 +1,5 @@
 sphinx==5.3.0
+sphinxcontrib-googleanalytics==0.4
 sphinx_rtd_theme==0.5.2
 sphinx-material==0.0.35
 myst-parser==1.0.0