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
65 changes: 65 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
name: Documentation

on:
release:
types: [published]
workflow_dispatch:
pull_request:
paths:
- 'docs/**/*.md'
- '.markdownlint.yml'

# Required for GitHub Pages deployment via Actions
permissions:
contents: read
pages: write
id-token: write

# Allow only one concurrent deployment; skip in-progress runs
concurrency:
group: "pages"
cancel-in-progress: false

jobs:
lint:
name: Validate Markdown
runs-on: ubuntu-latest
if: github.event_name == 'pull_request'
steps:
- name: Checkout
uses: actions/checkout@v4

- name: Lint documentation Markdown
uses: DavidAnson/markdownlint-cli2-action@v16
with:
globs: "docs/**/*.md"
config: ".markdownlint.yml"

build-and-deploy:
name: Build and Deploy
runs-on: ubuntu-latest
if: github.event_name == 'release' || github.event_name == 'workflow_dispatch'

environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}

steps:
- name: Checkout
uses: actions/checkout@v4

- name: Configure GitHub Pages
uses: actions/configure-pages@v5

- name: Build Jekyll site
uses: actions/jekyll-build-pages@v1
with:
source: ./docs
destination: ./_site

- name: Upload Pages artifact
uses: actions/upload-pages-artifact@v3

- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
34 changes: 34 additions & 0 deletions .markdownlint.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# markdownlint configuration
# https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md

default: true

# MD013 — Line length: documentation lines are allowed to exceed 80 chars
MD013: false

# MD022 — Blanks around headings: Kramdown attribute syntax ({: .no_toc }) must
# immediately follow a heading with no blank line — disable this rule
MD022: false

# MD025 — Single H1: pages have both front-matter title: and an # H1 heading;
# disable front-matter title detection to avoid false positives
MD025:
front_matter_title: ""

# MD033 — Inline HTML: needed for Jekyll/Liquid includes and badge images
MD033: false

# MD036 — Emphasis as heading: just-the-docs sub-sections inside tables use
# bold labels that markdownlint mistakes for headings
MD036: false

# MD041 — First line must be H1: front-matter pages don't start with a heading
MD041: false

# MD024 — No duplicate headings: allow sibling duplicates across sections
MD024:
siblings_only: true

# MD007 — Unordered list indentation: use 2-space indent under list items
MD007:
indent: 2
4 changes: 4 additions & 0 deletions docs/Gemfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
source "https://rubygems.org"

gem "github-pages", group: :jekyll_plugins
gem "just-the-docs"
71 changes: 71 additions & 0 deletions docs/_config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
remote_theme: just-the-docs/just-the-docs

title: EzRTP
description: >-
Production-focused random teleport plugin for Minecraft servers — safety-first
teleportation, cross-platform compatibility, and configuration-driven control
for server owners.

url: "https://ez-plugins.github.io"
baseurl: "/EzRTP"

# ── Appearance
────────────────────────────────────────────────────────────────
color_scheme: ezrtp
heading_anchors: true

# ── Header links
──────────────────────────────────────────────────────────────
aux_links:
"GitHub":
- "https://github.com/ez-plugins/EzRTP"
"Modrinth":
- "https://modrinth.com/plugin/ezplugins-ezrtp"
aux_links_new_tab: true

# ── Navigation
────────────────────────────────────────────────────────────────
nav_sort: case_insensitive
nav_external_links:
- title: Changelog
url: "https://github.com/ez-plugins/EzRTP/releases"
hide_icon: false

# ── Search
────────────────────────────────────────────────────────────────────
search_enabled: true
search:
heading_level: 2
previews: 3
preview_words_before: 5
preview_words_after: 10
tokenizer_separator: /[\s/]+/

# ── Footer
────────────────────────────────────────────────────────────────────
back_to_top: true
back_to_top_text: "Back to top"

footer_content: >-
Copyright © 2024–2026 Gyvex.
Distributed under the
<a href="https://github.com/ez-plugins/EzRTP/blob/main/LICENSE">MIT License</a>.

# ── Kramdown
──────────────────────────────────────────────────────────────────
kramdown:
syntax_highlighter_opts:
block:
line_numbers: false

# ── Plugins
───────────────────────────────────────────────────────────────────
plugins:
- jekyll-remote-theme
- jekyll-seo-tag

# ── Build exclusions
──────────────────────────────────────────────────────────
exclude:
- Gemfile
- Gemfile.lock
50 changes: 50 additions & 0 deletions docs/_sass/color_schemes/ezrtp.scss
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
// EzRTP — dark/blue/white color scheme for just-the-docs
//
// Palette:
// Background #141414 (body)
// Surface #1c1c1c (sidebar, cards)
// Elevated #222222 (code blocks, search, table rows)
// Border #2e2e2e
// Text #d0d0d0 (body) / #ffffff (headings)
// Accent #29b6f6 (blue — links, nav highlight, buttons)
// Accent dim #0288d1 (hover state)

$color-scheme: dark;

// ── Surfaces
─────────────────────────────────────────────────────────────────
$body-background-color: #141414;
$sidebar-color: #1c1c1c;
$feedback-color: #181818;

// ── Typography
────────────────────────────────────────────────────────────────
$body-text-color: #d0d0d0;
$body-heading-color: #ffffff;

// ── Links & accent
───────────────────────────────────────────────────────────
$link-color: #29b6f6;
$btn-primary-color: #29b6f6;

// ── Borders
───────────────────────────────────────────────────────────────────
$border-color: #2e2e2e;

// ── Code
──────────────────────────────────────────────────────────────────────
$code-background-color: #222222;

// ── Tables
────────────────────────────────────────────────────────────────────
$table-background-color: #1a1a1a;

// ── Search
────────────────────────────────────────────────────────────────────
$search-background-color: #222222;
$search-foreground-color: #c0c0c0;
$search-border-color: #333333;

// ── Buttons
─────────────────────────────────────────────────────────────────
$base-button-color: #252525;
Loading
Loading