Revert "Refactor Linutil Docs with mdBook (#8)" (#9)

This reverts commit e5a8b09.

Author: Real-MullaC

.github/workflows/deploy.yml

@@ -0,0 +1,77 @@
+# Sample workflow for building and deploying a Hugo site to GitHub Pages
+name: Deploy Hugo site to Pages
+
+on:
+  # Runs on pushes targeting the default branch
+  push:
+    branches: ["main"]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+# Default to bash
+defaults:
+  run:
+    shell: bash
+
+jobs:
+  # Build job
+  build:
+    runs-on: ubuntu-latest
+    env:
+      HUGO_VERSION: 0.128.0
+    steps:
+      - name: Install Hugo CLI
+        run: |
+          wget -O ${{ runner.temp }}/hugo.deb https://github.com/gohugoio/hugo/releases/download/v${HUGO_VERSION}/hugo_extended_${HUGO_VERSION}_linux-amd64.deb \
+          && sudo dpkg -i ${{ runner.temp }}/hugo.deb
+      - name: Install Dart Sass
+        run: sudo snap install dart-sass
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          submodules: recursive
+      - name: Setup Pages
+        id: pages
+        uses: actions/configure-pages@v5
+      - name: Install Node.js dependencies
+        run: "[[ -f package-lock.json || -f npm-shrinkwrap.json ]] && npm ci || true"
+      - name: On the fly path replacement for images
+        run: |
+          grep -rl "/images/" ./content | xargs sed -i s@"/images/"@"/linutil-docs/images/"@g
+      - name: Build with Hugo
+        env:
+          HUGO_CACHEDIR: ${{ runner.temp }}/hugo_cache
+          HUGO_ENVIRONMENT: production
+        run: |
+          hugo \
+            --minify \
+            --baseURL "${{ steps.pages.outputs.base_url }}/"
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: ./public
+
+  # Deployment job
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.github/workflows/hugo.yml

@@ -1,7 +1,22 @@
 name: XTasks
 
 on:
-  workflow_dispatch:
+  pull_request:
+    paths:
+      - "xtask"
+      - "Cargo.toml"
+      - "Cargo.lock"
+      - ".cargo"
+      - "core/tabs"
+      - "docs"
+  push:
+    paths:
+      - "xtask"
+      - "Cargo.toml"
+      - "Cargo.lock"
+      - ".cargo"
+      - "core/tabs"
+      - "docs"
 
 env:
   CARGO_TERM_COLOR: always
@@ -48,5 +63,5 @@ jobs:
         run: |
           git config user.name "GitHub Actions"
           git config user.email "actions@github.com"
-          git add /src/userguide.md
+          git add /content/userguide.md
           git commit -m "Commit the user guide" || echo "No changes to commit"

.github/workflows/xtask.yml

@@ -1 +1,13 @@
-book
+# Generated files by hugo
+/public/
+/resources/_gen/
+/assets/jsconfig.json
+hugo_stats.json
+
+# Executable may be added to repository
+hugo.exe
+hugo.darwin
+hugo.linux
+
+# Temporary lock file while building
+/.hugo_build.lock

.gitignore

@@ -1,3 +1,6 @@
+[submodule "themes/relearn"]
+	path = themes/relearn
+	url = https://github.com/McShelby/hugo-theme-relearn.git
 [submodule "linutil"]
 	path = linutil
 	url = https://github.com/ChrisTitusTech/linutil.git

.gitmodules

@@ -0,0 +1,5 @@
++++
+date = '{{ .Date }}'
+draft = true
+title = '{{ replace .File.ContentBaseName "-" " " | title }}'
++++

README.md

@@ -0,0 +1,78 @@
++++
+title = "Welcome to the LinUtil Documentation!"
+type = "home"
++++
+
+[![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)
+
+[![Crates.io Version](https://img.shields.io/crates/v/linutil_tui?style=for-the-badge&color=%23af3a03)](https://crates.io/crates/linutil_tui) [![linutil AUR Version](https://img.shields.io/aur/version/linutil?style=for-the-badge&label=%5BAUR%5D%20linutil&color=%23230567ff)](https://aur.archlinux.org/packages/linutil) [![linutil-bin AUR Version](https://img.shields.io/aur/version/linutil-bin?style=for-the-badge&label=%5BAUR%5D%20linutil-bin&color=%23230567ff)](https://aur.archlinux.org/packages/linutil-bin)
+
+## Running the latest release of LinUtil
+
+To get started, run the following command in your terminal:
+
+### Stable branch
+
+```
+curl -fsSL https://christitus.com/linux | sh
+```
+---
+
+### Installation
+
+LinUtil is also available as a package in various repositories:
+
+[![Packaging status](https://repology.org/badge/vertical-allrepos/linutil.svg)](https://repology.org/project/linutil/versions)
+
+<details>
+  <summary>Arch Linux</summary>
+
+LinUtil can be installed on [Arch Linux](https://archlinux.org) with three different [AUR](https://aur.archlinux.org) packages:
+
+- `linutil` - Stable release compiled from source
+- `linutil-bin` - Stable release pre-compiled
+- `linutil-git` - Compiled from the last commit (not recommended)
+
+by running:
+
+```bash
+git clone https://aur.archlinux.org/<package>.git
+cd linutil
+makepkg -si
+```
+
+Replace `<package>` with your preferred package.
+
+If you use [yay](https://github.com/Jguer/yay), [paru](https://github.com/Morganamilo/paru) or any other [AUR Helper](https://wiki.archlinux.org/title/AUR_helpers), it's even simpler:
+
+```bash
+paru -S linutil
+```
+
+Replace `paru` with your preferred helper and `linutil` with your preferred package.
+
+</details>
+
+<details>
+  <summary>Cargo</summary>
+
+LinUtil can be installed via [Cargo](https://doc.rust-lang.org/cargo) with:
+
+```bash
+cargo install linutil
+```
+
+Note that crates installed using `cargo install` require manual updating with `cargo install --force` (update functionality is [included in LinUtil](https://christitustech.github.io/linutil/userguide/#applications-setup))
+
+</details>
+
+---
+
+After you've ran the command, you should see a GUI on your screen; It will look something like this:
+
+![preview](/images/preview.gif)
+
+> [!INFO]
+LinUtil is updated weekly as of the time of writing. Consequently, features and functionalities may evolve, and the documentation may not always reflect the most current images or information.

archetypes/default.md

@@ -1,6 +1,7 @@
-# Contributing Guidelines for Linutil
-
-<img src="../assets/contribute.png" width="50">
++++
+date = '2024-10-31T18:30:23Z'
+title = 'Contributing'
++++
 
 Thank you for considering contributing to Linutil! We appreciate your effort in helping improve this project. To ensure that your contributions align with the goals and quality standards of Linutil, please follow these guidelines:
 
@@ -69,5 +70,4 @@ cd linutil
 
 - **Agree to the license**: By contributing to Linutil, you agree that your contributions will be licensed under the project's MIT license.
 
-We appreciate your contributions and look forward to collaborating with you to make Linutil better!
-
+We appreciate your contributions and look forward to collaborating with you to make Linutil better!