From 499848d643ee8b816b6d324669b1650117315b2a Mon Sep 17 00:00:00 2001 From: Real-MullaC Date: Thu, 25 Jul 2024 21:08:03 +0100 Subject: [PATCH] Updates docs to try allow better customising and removes announcment banner. (#2448) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Updates styling for WinUtil. * Removes announcement and fixes grammar * Revert "Deploying to main from @ ChrisTitusTech/winutil@8a6116cea1a8fa3e0f709b04f72b9cc232c9cda3 🚀" This reverts commit df2fe4a4c6c58892150a2ebaa615548fe1c24610. * Revert "Deploying to main from @ ChrisTitusTech/winutil@e82870da89f949809ef31cc6f698f4f23250d38c 🚀" This reverts commit 8a6116cea1a8fa3e0f709b04f72b9cc232c9cda3. * Revert "Deploying to main from @ ChrisTitusTech/winutil@e784604a1a8cc9ed0937011317be0803ed53807c 🚀" This reverts commit e82870da89f949809ef31cc6f698f4f23250d38c. * Revert "Update pre-release.yaml" This reverts commit e784604a1a8cc9ed0937011317be0803ed53807c. * Revert "Fixes release log (#2377)" This reverts commit 5d3d47eeb5c667466bcc4ca82d504b6d959c9391. * Reapply "Fixes release log (#2377)" This reverts commit 86f8d567b96f9ea4874e12497fcd86876a599d00. * Reapply "Update pre-release.yaml" This reverts commit 8761f3b815fe5e4265914745001caaa8acddd095. * Reapply "Deploying to main from @ ChrisTitusTech/winutil@e784604a1a8cc9ed0937011317be0803ed53807c 🚀" This reverts commit 673f416257d8ffce9282185c9a7d77feacbbd775. * Update README.md --- docs/contribute.md | 3 ++- docs/stylesheets/extra.css | 13 +++++++++++++ docs/userguide.md | 2 +- mkdocs.yml | 21 +++++++++++++++------ overrides/main.html | 7 ------- 5 files changed, 31 insertions(+), 15 deletions(-) create mode 100644 docs/stylesheets/extra.css diff --git a/docs/contribute.md b/docs/contribute.md index ddf6cc5e..f76b5ab7 100644 --- a/docs/contribute.md +++ b/docs/contribute.md @@ -82,7 +82,8 @@ graph LR ### Testing your changes -* To test to see if your changes work as intended, run the following commands in a powershell terminal: + +* To test to see if your changes work as intended run following commands in a powershell teminal as admin: * Change the directory where you are running the commands to the forked project. * `cd {path to the folder with the compile.ps1}` diff --git a/docs/stylesheets/extra.css b/docs/stylesheets/extra.css new file mode 100644 index 00000000..69b68875 --- /dev/null +++ b/docs/stylesheets/extra.css @@ -0,0 +1,13 @@ +/* Custom styles for MkDocs Material */ +body { + background-color: #c22525; +} + +.md-nav__link { + color: #ff5722; +} + +.md-typeset h1 { + font-size: 2.5em; + color: #3f51b5; +} diff --git a/docs/userguide.md b/docs/userguide.md index a590a49f..9800ed59 100644 --- a/docs/userguide.md +++ b/docs/userguide.md @@ -26,7 +26,6 @@ * This will scan for and select all installed programs in WinUtil that WinGet supports. === "Clear Selection" - * Click the `Clear Selection` button. * This will unselect all checked programs. @@ -60,6 +59,7 @@ Advanced Tweaks are intended for experienced users who have a solid understandin ### O&O Shutup + [O&O ShutUp10++](https://www.oo-software.com/en/shutup10) can be launched from WinUtil with only one button click. It is a free privacy tool for Windows that lets users easily manage their privacy settings. It disables telemetry, controls updates, and manages app permissions to enhance security and privacy. The tool offers recommended settings for optimal privacy with just a few clicks. diff --git a/mkdocs.yml b/mkdocs.yml index 668a5890..5f7b6c60 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -26,13 +26,22 @@ theme: logo: assets/favicon.png favicon: assets/favicon.png palette: - - media: "(prefers-color-scheme: light)" - scheme: default + # Palette toggle for automatic mode + - media: "(prefers-color-scheme)" toggle: - icon: material/toggle-switch-off-outline + icon: material/brightness-auto + name: Switch to light mode + + # Palette toggle for light mode + - media: "(prefers-color-scheme: light)" + scheme: default + + + toggle: + 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 toggle: @@ -63,4 +72,4 @@ markdown_extensions: - pymdownx.inlinehilite - def_list - pymdownx.tasklist: - custom_checkbox: true \ No newline at end of file + custom_checkbox: true diff --git a/overrides/main.html b/overrides/main.html index 0cebb4ac..f680422d 100644 --- a/overrides/main.html +++ b/overrides/main.html @@ -1,12 +1,5 @@ {% 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