Documentation website style and structure updates (#78)

* docs: minify scripts, improve design of pages, move css to respective file

* merge
This commit is contained in:
Aidan
2025-01-06 22:06:18 -05:00
committed by GitHub
parent 9e5d99d7e8
commit d5ee4315ca
6 changed files with 199 additions and 273 deletions

115
docs/assets/css/main.css Normal file
View File

@@ -0,0 +1,115 @@
html, body {
height: 100%;
margin: 0;
display: flex;
flex-direction: column;
font-family: 'Inter', sans-serif;
background-color: #ffffff;
color: #000000;
}
footer {
margin-top: auto;
background-color: #000000;
color: #ffffff;
padding: 1.5rem 0;
}
footer a {
color: #ffffff;
}
.navbar {
background-color: #000000;
}
.navbar-brand span {
font-weight: bold;
font-size: 1.5rem;
color: #ffffff;
}
.navbar-toggler {
background-color: #ffffff;
}
.navbar-nav .nav-link {
color: #ffffff;
}
.navbar-nav .nav-link:hover {
color: #cccccc;
}
header {
background-color: #000000;
color: #ffffff;
padding: 5rem 0;
}
header h1 {
font-size: 2.5rem;
}
header p {
font-size: 1.2rem;
}
ol {
padding-left: 1.5rem;
}
.highlight {
background: #f8f9fa;
border-left: 5px solid #000000;
font-size: 0.95rem;
overflow-x: auto;
white-space: pre-wrap;
}
.highlight code {
color: #000000;
font-family: monospace;
}
.header-icon {
font-size: 4rem;
margin-bottom: 1rem;
}
.contact-icons {
font-size: 2rem;
display: flex;
justify-content: center;
gap: 20px;
}
.contact-icons a {
color: #000000;
text-decoration: none;
}
.contact-icons a:hover {
color: #333333;
}
.btn-copy {
background-color: #000000;
color: #ffffff;
border: none;
cursor: pointer;
}
.btn-copy:hover {
background-color: rgb(238, 238, 238);
color: #000000;
}
.table th, .table td {
vertical-align: middle;
}
#devices a {
color: #000000;
}

7
docs/assets/js/copy.js Normal file
View File

@@ -0,0 +1,7 @@
function copyToClipboard(button) {
var code = button.previousElementSibling.textContent;
navigator.clipboard.writeText(code).then(() => {
button.textContent = "Copied!";
setTimeout(() => button.textContent = "Copy", 2000);
});
}

1
docs/assets/js/copy.min.js vendored Normal file
View File

@@ -0,0 +1 @@
function copyToClipboard(button){var code=button.previousElementSibling.textContent;navigator.clipboard.writeText(code).then(()=>{button.textContent="Copied!";setTimeout(()=>button.textContent="Copy",2000)})}

View File

@@ -9,128 +9,14 @@
<link href="https://fonts.googleapis.com/css2?family=Inter:wght@300;400;600;700;800&display=swap" rel="stylesheet">
<link rel="icon" href="assets/icons/ksu-next-tab.png" type="image/x-icon">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.0.0-beta3/css/all.min.css">
<style>
html, body {
height: 100%;
margin: 0;
display: flex;
flex-direction: column;
}
footer {
margin-top: auto;
}
body {
font-family: 'Inter', sans-serif;
background-color: #ffffff;
color: #000000;
}
.navbar {
background-color: #000000;
}
.navbar-brand span {
font-weight: bold;
font-size: 1.5rem;
color: #ffffff;
}
header {
background-color: #000000;
color: #ffffff;
padding: 5rem 0;
}
header h1 {
font-size: 2.5rem;
}
header p {
font-size: 1.2rem;
}
.btn-copy {
background-color: #000000;
color: #ffffff;
border: none;
cursor: pointer;
}
.btn-copy:hover {
background-color: rgb(238, 238, 238);
color: #000000;
}
.navbar-toggler {
background-color: #ffffff;
}
ol {
padding-left: 1.5rem;
}
footer {
background-color: #000000;
color: #ffffff;
padding: 1.5rem 0;
}
footer a {
color: #ffffff;
}
.highlight {
background: #f8f9fa;
border-left: 5px solid #000000;
padding: 1rem;
font-size: 0.95rem;
overflow-x: auto;
white-space: pre-wrap;
}
.highlight code {
color: #000000;
font-family: monospace;
}
.header-icon {
font-size: 4rem;
margin-bottom: 1rem;
}
.contact-icons {
font-size: 2rem;
display: flex;
justify-content: center;
gap: 20px;
}
.contact-icons a {
color: #000000;
text-decoration: none;
}
.contact-icons a:hover {
color: #333333;
}
.navbar-nav .nav-link {
color: #ffffff;
}
.navbar-nav .nav-link:hover {
color: #cccccc;
}
</style>
<link rel="stylesheet" href="assets/css/main.css">
</head>
<body>
<!-- Navbar -->
<nav class="navbar navbar-expand-md sticky-top py-3">
<div class="container">
<a class="navbar-brand d-flex align-items-center" href="https://rifsxd.github.io/KernelSU-Next/">
<a class="navbar-brand d-flex align-items-center" href="#">
<span>KernelSU Next</span>
</a>
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbarResponsive" aria-controls="navbarResponsive" aria-expanded="false" aria-label="Toggle navigation">
@@ -138,6 +24,9 @@
</button>
<div class="collapse navbar-collapse" id="navbarResponsive">
<ul class="navbar-nav ms-auto">
<li class="nav-item">
<a class="nav-link text-light" href="#">Home</a>
</li>
<li class="nav-item">
<a class="nav-link text-light" href="#installation">Installation</a>
</li>
@@ -173,15 +62,18 @@
<section id="installation" class="py-5">
<div class="container">
<h2 class="text-center mb-4">Installation</h2>
<p class="text-center">Run the following commands below for different installation options, should be ran inside the root of your kernel directory.</p>
<p class="text-center">Run the following commands below for different installation options, should be ran inside the root of your kernel's directory.</p>
<h3 class="mt-4">Latest</h3>
<div class="highlight mt-3">
<code>curl -LSs "https://raw.githubusercontent.com/rifsxd/KernelSU-Next/next/kernel/setup.sh" | bash -</code>
<button class="btn btn-copy mt-2" onclick="copyToClipboard(this)">Copy</button>
</div>
<h3 class="mt-4">Next branch (dev)</h3>
<div class="highlight mt-3">
<code>curl -LSs "https://raw.githubusercontent.com/rifsxd/KernelSU-Next/next/kernel/setup.sh" | bash -s next</code>
<button class="btn btn-copy mt-2" onclick="copyToClipboard(this)">Copy</button>
</div>
<h3 class="mt-4">Specific Tag</h3>
<div class="highlight mt-3">
<code>curl -LSs "https://raw.githubusercontent.com/rifsxd/KernelSU-Next/next/kernel/setup.sh" | bash -s v1.0.2-R14</code>
<button class="btn btn-copy mt-2" onclick="copyToClipboard(this)">Copy</button>
@@ -213,15 +105,7 @@
</footer>
<script src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.0/dist/js/bootstrap.bundle.min.js"></script>
<script>
function copyToClipboard(button) {
var code = button.previousElementSibling.textContent;
navigator.clipboard.writeText(code).then(() => {
button.textContent = "Copied!";
setTimeout(() => button.textContent = "Copy", 2000);
});
}
</script>
<script src="assets/js/copy.min.js"></script>
</body>
</html>

View File

@@ -9,78 +9,7 @@
<link href="https://fonts.googleapis.com/css2?family=Inter:wght@300;400;600;700;800&display=swap" rel="stylesheet">
<link rel="icon" href="../assets/icons/ksu-next-tab.png" type="image/x-icon">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.0.0-beta3/css/all.min.css">
<style>
html, body {
height: 100%;
margin: 0;
display: flex;
flex-direction: column;
}
footer {
margin-top: auto;
}
body {
font-family: 'Inter', sans-serif;
background-color: #ffffff;
color: #000000;
}
.navbar {
background-color: #000000;
}
.navbar-brand span {
font-weight: bold;
font-size: 1.5rem;
color: #ffffff;
}
.navbar-toggler {
background-color: #ffffff;
}
header {
background-color: #000000;
color: #ffffff;
padding: 5rem 0;
}
header h1 {
font-size: 2.5rem;
}
header p {
font-size: 1.2rem;
}
footer {
background-color: #000000;
color: #ffffff;
padding: 1.5rem 0;
}
footer a {
color: #ffffff;
}
.table th, .table td {
vertical-align: middle;
}
.navbar-nav .nav-link {
color: #ffffff;
}
.navbar-nav .nav-link:hover {
color: #cccccc;
}
#devices a {
color: #000000;
}
</style>
<link rel="stylesheet" href="../assets/css/main.css">
</head>
<body>
@@ -96,7 +25,16 @@
<div class="collapse navbar-collapse" id="navbarResponsive">
<ul class="navbar-nav ms-auto">
<li class="nav-item">
<a class="nav-link text-light" href="../index.html">Home</a>
<a class="nav-link text-light" href="https://rifsxd.github.io/KernelSU-Next/">Home</a>
</li>
<li class="nav-item">
<a class="nav-link text-light" href="https://rifsxd.github.io/KernelSU-Next/#installation">Installation</a>
</li>
<li class="nav-item">
<a class="nav-link text-light" href="features.html">Features</a>
</li>
<li class="nav-item"></li>
<a class="nav-link text-light" href="#">Devices</a>
</li>
<li class="nav-item">
<a class="nav-link" href="https://github.com/rifsxd/KernelSU-Next" target="_blank">

View File

@@ -9,70 +9,7 @@
<link href="https://fonts.googleapis.com/css2?family=Inter:wght@300;400;600;700;800&display=swap" rel="stylesheet">
<link rel="icon" href="../assets/icons/ksu-next-tab.png" type="image/x-icon">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.0.0-beta3/css/all.min.css">
<style>
html, body {
height: 100%;
margin: 0;
display: flex;
flex-direction: column;
}
footer {
margin-top: auto;
}
body {
font-family: 'Inter', sans-serif;
background-color: #ffffff;
color: #000000;
}
.navbar-nav .nav-link {
color: #ffffff;
}
.navbar {
background-color: #000000;
}
.navbar-brand span {
font-weight: bold;
font-size: 1.5rem;
color: #ffffff;
}
.navbar-toggler {
background-color: #ffffff;
}
header {
background-color: #000000;
color: #ffffff;
padding: 5rem 0;
}
header h1 {
font-size: 2.5rem;
}
header p {
font-size: 1.2rem;
}
ol {
padding-left: 1.5rem;
}
footer {
background-color: #000000;
color: #ffffff;
padding: 1.5rem 0;
}
footer a {
color: #ffffff;
}
</style>
<link rel="stylesheet" href="../assets/css/main.css">
</head>
<body>
@@ -88,7 +25,16 @@
<div class="collapse navbar-collapse" id="navbarResponsive">
<ul class="navbar-nav ms-auto">
<li class="nav-item">
<a class="nav-link text-light" href="../index.html">Home</a>
<a class="nav-link text-light" href="https://rifsxd.github.io/KernelSU-Next/">Home</a>
</li>
<li class="nav-item">
<a class="nav-link text-light" href="https://rifsxd.github.io/KernelSU-Next/#installation">Installation</a>
</li>
<li class="nav-item">
<a class="nav-link text-light" href="#">Features</a>
</li>
<li class="nav-item"></li>
<a class="nav-link text-light" href="devices.html">Devices</a>
</li>
<li class="nav-item">
<a class="nav-link" href="https://github.com/rifsxd/KernelSU-Next" target="_blank">
@@ -112,15 +58,50 @@
<section class="py-5">
<div class="container">
<h2 class="text-center mb-4">Features</h2>
<ul class="list-unstyled text-center">
<li>✔️ Non-GKI kernel support from 4.x - 5.4 LTS (3.x is experimental).</li>
<li>✔️ GKI kernels support LKM/KMI methods for easy installation.</li>
<li>✔️ Magic Mount ensures fast, light, and convenient module mounting.</li>
<li>✔️ New manager features and UI overhaul.</li>
<li>✔️ Restoration of modules post-uninstallation.</li>
<li>✔️ Manager app auto-updates with new releases.</li>
<li>✔️ Frequent updates and upcoming features.</li>
</ul>
<div class="row">
<div class="col-md-6 col-lg-4 mb-4 d-flex">
<div class="feature-box text-center p-3 border border-dark rounded flex-fill">
<h3><i class="fas fa-microchip"></i> Non-GKI Kernel Support</h3>
<p>Non-GKI kernel support from 4.x - 5.4 LTS (3.x is experimental).</p>
</div>
</div>
<div class="col-md-6 col-lg-4 mb-4 d-flex">
<div class="feature-box text-center p-3 border border-dark rounded flex-fill">
<h3><i class="fas fa-cogs"></i> GKI Kernel Support</h3>
<p>GKI kernels support LKM/KMI methods for easy installation.</p>
</div>
</div>
<div class="col-md-6 col-lg-4 mb-4 d-flex">
<div class="feature-box text-center p-3 border border-dark rounded flex-fill">
<h3><i class="fas fa-magic"></i> Magic Mount</h3>
<p>KernelSU-Next includes Magic Mount which provides a fast, light and convenient module mounting.</p>
</div>
</div>
<div class="col-md-6 col-lg-4 mb-4 d-flex">
<div class="feature-box text-center p-3 border border-dark rounded flex-fill">
<h3><i class="fas fa-tools"></i> New Manager Features</h3>
<p>KernelSU-Next has a new, redesigned manager with several feature improvements and a UI overhaul.</p>
</div>
</div>
<div class="col-md-6 col-lg-4 mb-4 d-flex">
<div class="feature-box text-center p-3 border border-dark rounded flex-fill">
<h3><i class="fas fa-undo"></i> Module Restoration</h3>
<p>KernelSU-Next allows for restoring modules even after uninstalling.</p>
</div>
</div>
<div class="col-md-6 col-lg-4 mb-4 d-flex">
<div class="feature-box text-center p-3 border border-dark rounded flex-fill">
<h3><i class="fas fa-sync-alt"></i> Auto-Updates</h3>
<p>The KernelSU-Next Manager app updates automatically with new releases.</p>
</div>
</div>
<div class="col-md-6 col-lg-4 mb-4 d-flex">
<div class="feature-box text-center p-3 border border-dark rounded flex-fill">
<h3><i class="fas fa-calendar-alt"></i> Frequent Updates</h3>
<p>KernelSU-Next is frequently updated with lots of upcoming features.</p>
</div>
</div>
</div>
</div>
</section>