Merge branch 'main' into multi-selection

mkdocs.yml → .github/mkdocs.yml

@@ -1,16 +1,18 @@
 site_name: Chris Titus LinUtil Official Documentation
 repo_url: https://github.com/ChrisTitusTech/linutil
+docs_dir: '../docs'
 
 nav:
   - Introduction: 'index.md'
   - User Guide: 'userguide.md'
-  - Contribute: 'contribute.md'
-  - Known Issues: 'KnownIssues.md'
+  - Contributing Guide: 'contribute.md'
+  - Documentation:
+      - Known Issues: 'KnownIssues.md'
   - FAQ: 'faq.md'
 
 theme:
   name: material
-  custom_dir: 'overrides'
+  custom_dir: '../overrides'
   features:
     - navigation.tabs
     - navigation.sections
@@ -25,20 +27,28 @@ theme:
   logo: assets/favicon.png
   favicon: assets/favicon.png
   palette:
+    # Palette toggle for automatic mode
+    - media: "(prefers-color-scheme)"
+      toggle:
+        icon: material/brightness-auto
+        name: Switch to light mode
+
+    # Palette toggle for light mode
     - media: "(prefers-color-scheme: light)"
       scheme: default
+      accent: blue
       toggle:
-        icon: material/toggle-switch-off-outline
+        icon: material/brightness-7
         name: Switch to dark mode
-      primary: black
-      accent: purple
+
+    # Palette toggle for dark mode
     - media: "(prefers-color-scheme: dark)"
       scheme: slate
+      primary: black
+      accent: blue
       toggle:
-        icon: material/toggle-switch
+        icon: material/weather-night
         name: Switch to light mode
-      primary: teal
-      accent: lime
 markdown_extensions:
   - admonition
   - pymdownx.details
@@ -62,4 +72,16 @@ markdown_extensions:
   - pymdownx.inlinehilite
   - def_list
   - pymdownx.tasklist:
-      custom_checkbox: true
+      custom_checkbox: true
+  - toc:
+      permalink: true
+
+plugins:
+  - search
+  - awesome-pages
+  - git-revision-date-localized
+  - minify:
+      minify_html: true
+      htmlmin_opts:
+          remove_comments: true
+      cache_safe: true

.github/requirements.txt

@@ -0,0 +1,51 @@
+Babel==2.15.0
+bracex==2.5
+cairocffi==1.7.1
+CairoSVG==2.7.1
+certifi==2024.7.4
+cffi==1.17.0
+charset-normalizer==3.3.2
+click==8.1.7
+colorama==0.4.6
+csscompressor==0.9.5
+cssselect2==0.7.0
+defusedxml==0.7.1
+ghp-import==2.1.0
+gitdb==4.0.11
+GitPython==3.1.43
+htmlmin2==0.1.13
+idna==3.7
+Jinja2==3.1.4
+jsmin==3.0.1
+Markdown==3.6
+MarkupSafe==2.1.5
+mergedeep==1.3.4
+mkdocs==1.6.0
+mkdocs-awesome-pages-plugin==2.9.3
+mkdocs-get-deps==0.2.0
+mkdocs-git-revision-date-localized-plugin==1.2.6
+mkdocs-material==9.5.31
+mkdocs-material-extensions==1.3.1
+mkdocs-minify-plugin==0.8.0
+natsort==8.4.0
+packaging==24.1
+paginate==0.5.6
+pathspec==0.12.1
+pillow==10.4.0
+platformdirs==4.2.2
+pycparser==2.22
+Pygments==2.18.0
+pymdown-extensions==10.9
+python-dateutil==2.9.0.post0
+pytz==2024.1
+PyYAML==6.0.2
+pyyaml_env_tag==0.1
+regex==2024.7.24
+requests==2.32.3
+six==1.16.0
+smmap==5.0.1
+tinycss2==1.3.0
+urllib3==2.2.2
+watchdog==4.0.1
+wcmatch==9.0
+webencodings==0.5.1

.github/workflows/github-pages.yml

@@ -1,22 +1,32 @@
 name: GitHub Pages Deploy
+
 on:
-  release:
-    types: [published, prereleased]
-  workflow_dispatch: 
-permissions:
-  contents: write
+  push:
+    paths:
+      - 'mkdocs.yml'
+      - 'docs/**'
+      - 'overrides/**'
+      - 'CONTRIBUTING.md'
+  workflow_dispatch:
+
 jobs:
-  deploy:
+  build-and-deploy:
     runs-on: ubuntu-latest
+
     steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-python@v4
+      - name: Checkout Repository
+        uses: actions/checkout@v4
         with:
-          python-version: 3.x
-      - uses: actions/cache@v4
+          fetch-depth: '0'  # Fetch all commit history for all branches as well as tags.
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
         with:
-          key: ${{ github.ref }}
-          path: .cache
-      - run: pip install mkdocs-material
-      - run: pip install pillow cairosvg
-      - run: mkdocs gh-deploy --force
+          python-version: 3.x  # Install latest Stable release of Python 3
+          cache: 'pip'  # Caching pip dependencies
+
+      - name: Install Necessary Dependencies
+        run: pip install -r .github/requirements.txt
+
+      - name: Build & Deploy using mkdocs
+        run: mkdocs gh-deploy --force -f .github/mkdocs.yml

Cargo.toml

@@ -1,34 +1,16 @@
-[package]
-name = "tui"
+[workspace.package]
+license = "MIT"
 version = "0.1.0"
-edition = "2021"
 
-[dependencies]
-clap = { version = "4.5.16", features = ["derive"] }
-crossterm = "0.28.1"
+[workspace.dependencies]
 ego-tree = "0.6.2"
-oneshot = "0.1.8"
-portable-pty = "0.8.1"
-ratatui = "0.28.1"
-tui-term = "0.1.12"
-include_dir = "0.7.4"
-tempdir = "0.3.7"
-serde = { version = "1.0.205", features = ["derive"] }
-toml = "0.8.19"
-which = "6.0.3"
-unicode-width = "0.1.13"
-
-[build-dependencies]
-chrono = "0.4.33"
-
-[[bin]]
-name = "linutil"
-path = "src/main.rs"
-
 
+[workspace]
+members = ["tui", "core"]
+resolver = "2"
 
 [profile.release]
-opt-level = 3
+opt-level = "z"
 debug = false
 lto = true
 codegen-units = 1

README.md

@@ -2,6 +2,7 @@
 
 [![Version](https://img.shields.io/github/v/release/ChrisTitusTech/linutil?color=%230567ff&label=Latest%20Release&style=for-the-badge)](https://github.com/ChrisTitusTech/linutil/releases/latest)
 ![GitHub Downloads (specific asset, all releases)](https://img.shields.io/github/downloads/ChrisTitusTech/linutil/linutil?label=Total%20Downloads&style=for-the-badge)
+[![](https://dcbadge.limes.pink/api/server/https://discord.gg/bujFYKAHSp)](https://discord.gg/bujFYKAHSp)
 
 ![Preview](docs/assets/preview.png)
 

core/Cargo.toml

@@ -0,0 +1,13 @@
+[package]
+name = "linutil_core"
+edition = "2021"
+version.workspace = true
+license.workspace = true
+
+[dependencies]
+include_dir = "0.7.4"
+tempdir = "0.3.7"
+serde = { version = "1.0.205", features = ["derive"] }
+toml = "0.8.19"
+which = "6.0.3"
+ego-tree = { workspace = true }