mirror of
https://github.com/ChrisTitusTech/linutil.git
synced 2024-11-21 21:09:42 +00:00
Starts adding docs to LinUtil.
This commit is contained in:
parent
9270f29b95
commit
e651bcae96
1
docs/KnownIssues.md
Normal file
1
docs/KnownIssues.md
Normal file
|
@ -0,0 +1 @@
|
||||||
|
# Known Issues
|
BIN
docs/assets/favicon.png
Normal file
BIN
docs/assets/favicon.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 9.6 KiB |
BIN
docs/assets/mainpage.png
Normal file
BIN
docs/assets/mainpage.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 15 KiB |
2
docs/contribute.md
Normal file
2
docs/contribute.md
Normal file
|
@ -0,0 +1,2 @@
|
||||||
|
# How to Contribute?
|
||||||
|
|
4
docs/faq.md
Normal file
4
docs/faq.md
Normal file
|
@ -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.
|
16
docs/index.md
Normal file
16
docs/index.md
Normal file
|
@ -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.
|
3
docs/updates.md
Normal file
3
docs/updates.md
Normal file
|
@ -0,0 +1,3 @@
|
||||||
|
# Update Log
|
||||||
|
|
||||||
|
#
|
9
docs/userguide.md
Normal file
9
docs/userguide.md
Normal file
|
@ -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)
|
66
mkdocs.yml
Normal file
66
mkdocs.yml
Normal file
|
@ -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
|
12
overrides/main.html
Normal file
12
overrides/main.html
Normal file
|
@ -0,0 +1,12 @@
|
||||||
|
{% extends "base.html" %}
|
||||||
|
|
||||||
|
{% block header %}
|
||||||
|
{{ super() }}
|
||||||
|
<div style="color: red; text-align: center; padding: 10px; font-size: 20px;">
|
||||||
|
<strong>Announcement:</strong> This documentation is still in progress.
|
||||||
|
</div>
|
||||||
|
{% endblock %}
|
||||||
|
|
||||||
|
{% block footer %}
|
||||||
|
{# Empty block to override the footer #}
|
||||||
|
{% endblock %}
|
Loading…
Reference in New Issue
Block a user