Refactor Linutil Docs with mdBook (#8)

* Refactor Linutil Docs with mdBook

* Add x task back

* Create .gitmodules

* Add linutil as a submodule

* Refactor Overall Structure

* Fix x-task Dir to Src

* [FAQ] Add unistall `opensuse` & `cargo`

* Fix [FAQ] Dir

* Fix Spell

* Spell Corrected

* Convert xtask To Manual Run

* Add's workflow dispatch

.github/workflows/deploy.yml

@@ -0,0 +1,40 @@
+name: Deploy
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write  # To push a branch 
+      pages: write  # To push to a GitHub Pages site
+      id-token: write # To update the deployment status
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Install latest mdbook
+        run: |
+          tag=$(curl 'https://api.github.com/repos/rust-lang/mdbook/releases/latest' | jq -r '.tag_name')
+          url="https://github.com/rust-lang/mdbook/releases/download/${tag}/mdbook-${tag}-x86_64-unknown-linux-gnu.tar.gz"
+          mkdir mdbook
+          curl -sSL $url | tar -xz --directory=./mdbook
+          echo `pwd`/mdbook >> $GITHUB_PATH
+      - name: Build Book
+        run: |
+          # This assumes your book is in the root of your repository.
+          # Just add a `cd` here if you need to change to another directory.
+          mdbook build
+      - name: Setup Pages
+        uses: actions/configure-pages@v4
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          # Upload entire repository
+          path: 'book'
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.github/workflows/xtask.yml

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

.gitignore

@@ -1,13 +1 @@
-# 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
+book

.gitmodules

@@ -1,6 +1,3 @@
-[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

README.md

@@ -0,0 +1,17 @@
+<div align="center">
+
+![Logo](/logo/cttlogo.avif)
+
+### **Official Linutil Documentation**
+
+</div>
+
+[![GitHub Actions Build Status][check]][link]
+
+*For installation and other guides, visit the* [Wiki](https://chris-titus-docs.github.io/linutil-docs/).
+
+<a href="https://chris-titus-docs.github.io/linutil-docs/" target="_blank"><img alt="Wiki" src="https://img.shields.io/badge/WIKI-98c379?style=flat-square" width="50"></a>
+
+
+[check]: https://github.com/chris-titus-docs/linutil-docs/actions/workflows/deploy.yml/badge.svg
+[link]: https://github.com/chris-titus-docs/linutil-docs/actions/workflows/deploy.yml

book.toml

@@ -0,0 +1,36 @@
+[book]
+authors = ["Aayush Chalise"]
+language = "en"
+multilingual = false
+src = "src"
+title = "Linutil Docs"
+description = "Linutil is a distro-agnostic toolbox designed to simplify everyday Linux tasks."
+
+[output.html]
+default-theme = "ayu"
+preferred-dark-theme = "ayu"
+smart-punctuation = true
+mathjax-support = true
+site-url = "/linutil-docs/"
+git-repository-url = "https://github.com/Chris-Titus-Docs/linutil-docs/tree/main/src/"
+edit-url-template = "https://github.com/Chris-Titus-Docs/linutil-docs/edit/main/{path}"
+
+[output.html.playground]
+editable = true
+line-numbers = true
+
+[output.html.code.hidelines]
+python = "~"
+
+[output.html.search]
+limit-results = 20
+use-boolean-and = true
+boost-title = 2
+boost-hierarchy = 2
+boost-paragraph = 1
+expand = true
+heading-split-level = 2
+
+[output.html.redirect]
+"/format/config.html" = "configuration/index.html"
+

src/404.md

@@ -0,0 +1,4 @@
+# Document not found (404)
+
+This URL is invalid, sorry. Try the search instead!
+

src/SUMMARY.md

@@ -0,0 +1,24 @@
+# Summary
+
+[Introduction](./introduction.md)
+[Preview](./preview.md)
+
+______________________________________________________________________
+
+[Installation](installation.md)
+
+[Command Line Tool](command.md)
+
+[User Guide](userguide.md)
+
+[Contributing](./collaboration/contribute.md)
+
+[RoadMap](./collaboration/roadmap.md)
+
+[Code of Conduct](./collaboration/coc.md)
+
+[FAQ](faq.md)
+
+-----------
+
+[Contributors](misc/contributors.md)