Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions docs/_config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,8 @@ theme: minima
markdown: kramdown
minima:
skin: dark
defaults:
- scope:
path: ""
values:
layout: default
46 changes: 46 additions & 0 deletions docs/_layouts/default.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>{% if page.title %}{{ page.title }} · {% endif %}{{ site.title }}</title>
<link rel="stylesheet" href="{{ '/assets/main.css' | relative_url }}">
</head>
<body>
<header class="docs-header">
<div class="docs-header-inner">
<a class="docs-brand" href="{{ '/' | relative_url }}">{{ site.title }}</a>
<p class="docs-tagline">{{ site.description }}</p>
</div>
</header>

<main class="docs-shell">
<aside class="docs-sidebar">
<nav>
<h2>Overview</h2>
<a href="{{ '/' | relative_url }}">Home</a>
<a href="{{ '/guides/getting-started.html' | relative_url }}">Getting Started</a>
<a href="{{ '/guides/chaining.html' | relative_url }}">Chaining</a>
<a href="{{ '/guides/platforms.html' | relative_url }}">Platform Guides</a>
<a href="{{ '/reference/api.html' | relative_url }}">API Reference</a>
<a href="{{ '/guides/publishing.html' | relative_url }}">Publishing</a>

<h2>Platform Options</h2>
<a href="{{ '/platforms/github.html' | relative_url }}">GitHub</a>
<a href="{{ '/platforms/modrinth.html' | relative_url }}">Modrinth</a>
<a href="{{ '/platforms/hangar.html' | relative_url }}">Hangar</a>
<a href="{{ '/platforms/spigot.html' | relative_url }}">Spigot</a>
<a href="{{ '/platforms/curseforge.html' | relative_url }}">CurseForge</a>
<a href="{{ '/platforms/maven-metadata.html' | relative_url }}">Maven Metadata</a>
</nav>
</aside>

<section class="docs-content">
{% if page.title %}
<h1>{{ page.title }}</h1>
{% endif %}
{{ content }}
</section>
</main>
</body>
</html>
107 changes: 89 additions & 18 deletions docs/assets/main.scss
Original file line number Diff line number Diff line change
Expand Up @@ -19,47 +19,108 @@ html,
body {
background: radial-gradient(circle at top right, #142a52 0%, var(--bg) 35%, #080d18 100%);
color: var(--text);
margin: 0;
}

.site-header,
.site-footer {
background: rgba(9, 15, 28, 0.85);
border-color: var(--border);
.docs-header {
position: sticky;
top: 0;
z-index: 30;
background: rgba(6, 12, 24, 0.92);
border-bottom: 1px solid var(--border);
backdrop-filter: blur(10px);
}

.site-title,
.site-title:visited,
.page-link,
.page-link:visited {
.docs-header-inner {
max-width: 1200px;
margin: 0 auto;
padding: 0.9rem 1rem;
}

.docs-brand,
.docs-brand:visited {
color: var(--accent-2);
font-weight: 700;
text-decoration: none;
font-size: 1.05rem;
}

.docs-tagline {
margin: 0.2rem 0 0;
color: var(--muted);
font-size: 0.9rem;
}

.docs-shell {
max-width: 1200px;
margin: 1rem auto 2rem;
padding: 0 1rem;
display: grid;
grid-template-columns: 280px 1fr;
gap: 1rem;
}

.docs-sidebar {
position: sticky;
top: 88px;
align-self: start;
background: rgba(12, 20, 36, 0.85);
border: 1px solid var(--border);
border-radius: 12px;
padding: 0.9rem;
box-shadow: 0 12px 40px rgba(0, 0, 0, 0.35);
}

.page-content {
.docs-sidebar h2 {
margin: 0.35rem 0 0.45rem;
font-size: 0.8rem;
text-transform: uppercase;
letter-spacing: 0.08em;
color: var(--muted);
}

.docs-sidebar a {
display: block;
color: #cde1ff;
text-decoration: none;
padding: 0.45rem 0.55rem;
border-radius: 8px;
margin-bottom: 0.2rem;
border: 1px solid transparent;
}

.docs-sidebar a:hover {
background: rgba(78, 161, 255, 0.12);
border-color: rgba(78, 161, 255, 0.3);
color: #e6f1ff;
}

.docs-content {
background: rgba(12, 20, 36, 0.75);
border: 1px solid var(--border);
border-radius: 12px;
padding: 1.25rem;
box-shadow: 0 12px 40px rgba(0, 0, 0, 0.35);
}

h1,
h2,
h3,
h4 {
.docs-content h1,
.docs-content h2,
.docs-content h3,
.docs-content h4 {
color: #e7f0ff;
}

a,
a:visited {
.docs-content a,
.docs-content a:visited {
color: var(--accent);
}

a:hover {
.docs-content a:hover {
color: #9bcaff;
}

p,
li {
.docs-content p,
.docs-content li {
color: var(--text);
}

Expand Down Expand Up @@ -110,3 +171,13 @@ pre code {
.highlight .cm {
color: #6f8bb8;
}

@media (max-width: 920px) {
.docs-shell {
grid-template-columns: 1fr;
}

.docs-sidebar {
position: static;
}
}
4 changes: 3 additions & 1 deletion docs/guides/chaining.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Chaining and Fallback
---
title: Chaining and Fallback
---

Use `ChainedUpdateChecker` when you want one source as primary and one or more backups.

Expand Down
4 changes: 3 additions & 1 deletion docs/guides/getting-started.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Getting Started
---
title: Getting Started
---

## Add dependency (JitPack)

Expand Down
16 changes: 9 additions & 7 deletions docs/guides/platforms.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,15 @@
# Platform Guides
---
title: Platform Guides
---

Detailed option docs per platform:

- [GitHub Releases options](../platforms/github.md)
- [Modrinth options](../platforms/modrinth.md)
- [Hangar options](../platforms/hangar.md)
- [Spigot legacy options](../platforms/spigot.md)
- [CurseForge options](../platforms/curseforge.md)
- [Maven metadata options](../platforms/maven-metadata.md)
- [GitHub Releases options](../platforms/github.html)
- [Modrinth options](../platforms/modrinth.html)
- [Hangar options](../platforms/hangar.html)
- [Spigot legacy options](../platforms/spigot.html)
- [CurseForge options](../platforms/curseforge.html)
- [Maven metadata options](../platforms/maven-metadata.html)

## GitHub Releases

Expand Down
4 changes: 3 additions & 1 deletion docs/guides/publishing.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Publishing and Releases
---
title: Publishing and Releases
---

## GitHub Packages

Expand Down
16 changes: 9 additions & 7 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# MC Plugin Update Notifier
---
title: Documentation Home
---

Developer-friendly Java update checker library for Minecraft plugins.

Expand All @@ -18,9 +20,9 @@ Developer-friendly Java update checker library for Minecraft plugins.

## Documentation

- [Getting started](./guides/getting-started.md)
- [Chaining and fallback](./guides/chaining.md)
- [Platform guides](./guides/platforms.md)
- [Platform option reference](./platforms/github.md)
- [API reference](./reference/api.md)
- [Publishing and releases](./guides/publishing.md)
- [Getting started](./guides/getting-started.html)
- [Chaining and fallback](./guides/chaining.html)
- [Platform guides](./guides/platforms.html)
- [Platform option reference](./platforms/github.html)
- [API reference](./reference/api.html)
- [Publishing and releases](./guides/publishing.html)
4 changes: 3 additions & 1 deletion docs/platforms/curseforge.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# CurseForge Platform
---
title: CurseForge Platform
---

Class: `CurseForgeUpdateChecker`

Expand Down
4 changes: 3 additions & 1 deletion docs/platforms/github.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# GitHub Releases Platform
---
title: GitHub Releases Platform
---

Class: `UpdateChecker`

Expand Down
4 changes: 3 additions & 1 deletion docs/platforms/hangar.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Hangar Platform
---
title: Hangar Platform
---

Class: `HangarUpdateChecker`

Expand Down
4 changes: 3 additions & 1 deletion docs/platforms/maven-metadata.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Maven Metadata Platform
---
title: Maven Metadata Platform
---

Class: `MavenMetadataUpdateChecker`

Expand Down
4 changes: 3 additions & 1 deletion docs/platforms/modrinth.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Modrinth Platform
---
title: Modrinth Platform
---

Class: `ModrinthUpdateChecker`

Expand Down
4 changes: 3 additions & 1 deletion docs/platforms/spigot.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Spigot Legacy Platform
---
title: Spigot Legacy Platform
---

Class: `SpigotLegacyUpdateChecker`

Expand Down
4 changes: 3 additions & 1 deletion docs/reference/api.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# API Reference
---
title: API Reference
---

## Core Types

Expand Down
Loading