diff --git a/docs/KnownIssues.md b/docs/KnownIssues.md new file mode 100644 index 00000000..7632f0f8 --- /dev/null +++ b/docs/KnownIssues.md @@ -0,0 +1 @@ +# Known Issues \ No newline at end of file diff --git a/docs/assets/favicon.png b/docs/assets/favicon.png new file mode 100644 index 00000000..a4f4bc5d Binary files /dev/null and b/docs/assets/favicon.png differ diff --git a/docs/assets/mainpage.png b/docs/assets/mainpage.png new file mode 100644 index 00000000..c9c7ec51 Binary files /dev/null and b/docs/assets/mainpage.png differ diff --git a/docs/contribute.md b/docs/contribute.md new file mode 100644 index 00000000..2189c3c0 --- /dev/null +++ b/docs/contribute.md @@ -0,0 +1,2 @@ +# How to Contribute? + diff --git a/docs/faq.md b/docs/faq.md new file mode 100644 index 00000000..e3b3daef --- /dev/null +++ b/docs/faq.md @@ -0,0 +1,4 @@ +# FAQ's + +## How do I uninstall WinUtil? +* You do not have to uninstall WinUtil. As it is a script you run from Powershell it only loads into your RAM. This means as soon as you close WinUtil it will be deleted off your system. \ No newline at end of file diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 00000000..91cd803e --- /dev/null +++ b/docs/index.md @@ -0,0 +1,16 @@ +# Welcome to the LinUtil Documentation! + +[![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/start.sh?label=Total%20Downloads&style=for-the-badge) + +## Running latest release of LinUtil + +* You will first need to start a Terminal on your linux machine. +* Now you will need to run following command: + ``` + curl -fsSL https://christitus.com/linux | sh + ``` + +!!! 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. \ No newline at end of file diff --git a/docs/updates.md b/docs/updates.md new file mode 100644 index 00000000..758fc4bd --- /dev/null +++ b/docs/updates.md @@ -0,0 +1,3 @@ +# Update Log + +# \ No newline at end of file diff --git a/docs/userguide.md b/docs/userguide.md new file mode 100644 index 00000000..15ee5527 --- /dev/null +++ b/docs/userguide.md @@ -0,0 +1,9 @@ +# Walkthrough + +## How to run LinUtil? +Run the following command in a terminal on your Linux System: +``` +curl -fsSL https://christitus.com/linux | sh +``` +Once you have run that command you will see the following GUI show on your screen: +![Main Page](assets/mainpage.png) \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 00000000..5032786e --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,66 @@ +site_name: Chris Titus LinUtil Official Documentation +repo_url: https://github.com/ChrisTitusTech/linutil + +nav: + - Introduction: 'index.md' + - User Guide: 'userguide.md' + - Contribute: 'contribute.md' + - Updates: 'updates.md' + - Known Issues: 'KnownIssues.md' + - FAQ: 'faq.md' + +theme: + name: material + custom_dir: 'overrides' + features: + - navigation.tabs + - navigation.sections + - toc.integrate + - navigation.top + - search.suggest + - search.highlight + - content.tabs.link + - content.code.annotation + - content.code.copy + language: en + logo: assets/favicon.png + favicon: assets/favicon.png + palette: + - media: "(prefers-color-scheme: light)" + scheme: default + toggle: + icon: material/toggle-switch-off-outline + name: Switch to dark mode + primary: black + accent: purple + - media: "(prefers-color-scheme: dark)" + scheme: slate + toggle: + icon: material/toggle-switch + name: Switch to light mode + primary: teal + accent: lime +markdown_extensions: + - admonition + - pymdownx.details + - pymdownx.superfences + - pymdownx.superfences: + custom_fences: + - name: mermaid + class: mermaid + format: !!python/name:pymdownx.superfences.fence_code_format + - abbr + - attr_list + - pymdownx.snippets + - md_in_html + - pymdownx.superfences + - pymdownx.tabbed: + alternate_style: true + - pymdownx.highlight: + anchor_linenums: true + line_spans: __span + pygments_lang_class: true + - pymdownx.inlinehilite + - def_list + - pymdownx.tasklist: + custom_checkbox: true \ No newline at end of file diff --git a/overrides/main.html b/overrides/main.html new file mode 100644 index 00000000..0cebb4ac --- /dev/null +++ b/overrides/main.html @@ -0,0 +1,12 @@ +{% extends "base.html" %} + +{% block header %} + {{ super() }} +
+ Announcement: This documentation is still in progress. +
+{% endblock %} + +{% block footer %} + {# Empty block to override the footer #} +{% endblock %} \ No newline at end of file