Skip to content

Docx #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
LeeQianXi merged 1 commit into from
Jun 14, 2026
Merged

Docx #6

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
322 changes: 322 additions & 0 deletions .github/workflows/deploy-docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,322 @@
name: Deploy Docs to GitHub Pages

on:
push:
branches:
- "**"
paths:
- ".github/workflows/deploy-docs.yml"
- "docs/**"
- "website/**"
workflow_dispatch:

permissions:
actions: read
contents: write

env:
FORCE_JAVASCRIPT_ACTIONS_TO_NODE24: true

# All branch docs are written into one gh-pages branch, so serialize publishes.
concurrency:
group: docs-pages
cancel-in-progress: false

jobs:
build:
runs-on: ubuntu-latest
defaults:
run:
working-directory: website
outputs:
branch_path: ${{ steps.branch.outputs.branch_path }}
base_url: ${{ steps.branch.outputs.base_url }}
steps:
- name: Checkout source
uses: actions/checkout@v4

- name: Resolve branch path
id: branch
shell: bash
run: |
branch_path="${GITHUB_REF_NAME//\//-}"
echo "branch_path=${branch_path}" >> "$GITHUB_OUTPUT"
repo_name="${GITHUB_REPOSITORY#*/}"
echo "base_url=/${repo_name}/${branch_path}/" >> "$GITHUB_OUTPUT"

- name: Setup pnpm
uses: pnpm/action-setup@v4
with:
version: 10

- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: 24
cache: pnpm
cache-dependency-path: website/pnpm-lock.yaml

- name: Install dependencies
run: pnpm install --frozen-lockfile

- name: Build Docusaurus
env:
DOCUSAURUS_BASE_URL: ${{ steps.branch.outputs.base_url }}
run: pnpm run build

- name: Upload branch docs artifact
uses: actions/upload-artifact@v4
with:
name: docs-${{ steps.branch.outputs.branch_path }}
path: website/build

publish:
runs-on: ubuntu-latest
needs: build
steps:
- name: Checkout source
uses: actions/checkout@v4

- name: Download branch docs artifact
uses: actions/download-artifact@v4
with:
name: docs-${{ needs.build.outputs.branch_path }}
path: branch-build

- name: Checkout Pages branch
shell: bash
run: |
set -euo pipefail
mkdir pages
cd pages
git init
git remote add origin "https://x-access-token:${GITHUB_TOKEN}@github.com/${GITHUB_REPOSITORY}.git"
if git fetch --depth=1 origin gh-pages; then
git checkout -B gh-pages FETCH_HEAD
else
git checkout --orphan gh-pages
git rm -rf . >/dev/null 2>&1 || true
fi
env:
GITHUB_TOKEN: ${{ github.token }}

- name: Update branch docs directory
shell: bash
run: |
set -euo pipefail
branch_path="${{ needs.build.outputs.branch_path }}"
rm -rf "pages/${branch_path}"
mkdir -p "pages/${branch_path}"
cp -R branch-build/. "pages/${branch_path}/"
rm -f "pages/${branch_path}/CNAME"

if [ -f website/static/CNAME ]; then
cp website/static/CNAME pages/CNAME
fi
touch pages/.nojekyll

python3 <<'PY'
from datetime import datetime, timezone
from html import escape
from pathlib import Path
import re
import subprocess

pages = Path("pages")

def version_key(name):
return [int(part) if part.isdigit() else part.lower() for part in re.split(r"([0-9]+)", name)]

generated_dt = datetime.now(timezone.utc)
generated = generated_dt.strftime("%Y-%m-%d %H:%M UTC")
generated_iso = generated_dt.isoformat().replace("+00:00", "Z")

def last_updated(directory):
status = subprocess.run(
["git", "status", "--porcelain", "--", directory],
cwd=pages,
text=True,
stdout=subprocess.PIPE,
stderr=subprocess.DEVNULL,
check=False,
)
if status.stdout.strip():
return generated, generated_iso
result = subprocess.run(
["git", "log", "-1", "--format=%cI", "--", directory],
cwd=pages,
text=True,
stdout=subprocess.PIPE,
stderr=subprocess.DEVNULL,
check=False,
)
iso = result.stdout.strip()
if not iso:
return "Unknown", ""
parsed = datetime.fromisoformat(iso.replace("Z", "+00:00")).astimezone(timezone.utc)
return parsed.strftime("%Y-%m-%d %H:%M UTC"), iso

versions = []
for directory in sorted((p for p in pages.iterdir() if p.is_dir() and p.name != ".git"), key=lambda p: version_key(p.name), reverse=True):
label, iso = last_updated(directory.name)
versions.append((directory.name, label, iso))

cards = "\n".join(
f""" <a class="version-card" href="./{escape(name)}/">
<span class="version-name">{escape(name)}</span>
<span class="version-meta">Last updated <time datetime="{escape(iso)}">{escape(label)}</time></span>
</a>"""
for name, label, iso in versions
)

pages.joinpath("index.html").write_text(
f"""<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>RegistryLib Wiki Versions</title>
<style>
:root {{
color-scheme: light;
--bg: #f7f8fb;
--panel: #ffffff;
--ink: #172033;
--muted: #667085;
--line: #d9e0ea;
--accent: #1f6feb;
--accent-strong: #174ea6;
--shadow: 0 18px 45px rgba(23, 32, 51, 0.10);
}}
* {{ box-sizing: border-box; }}
body {{
margin: 0;
min-height: 100vh;
font-family: Inter, ui-sans-serif, system-ui, -apple-system, BlinkMacSystemFont, "Segoe UI", sans-serif;
background: var(--bg);
color: var(--ink);
line-height: 1.5;
}}
main {{
width: min(1040px, calc(100% - 32px));
margin: 0 auto;
padding: 72px 0 56px;
}}
.hero {{
display: grid;
grid-template-columns: minmax(0, 1fr) auto;
gap: 24px;
align-items: end;
margin-bottom: 28px;
}}
.eyebrow {{
margin: 0 0 10px;
color: var(--accent-strong);
font-size: 0.78rem;
font-weight: 700;
letter-spacing: 0.08em;
text-transform: uppercase;
}}
h1 {{
margin: 0;
font-size: clamp(2.2rem, 5vw, 4.3rem);
line-height: 1;
letter-spacing: 0;
}}
.summary {{
margin: 14px 0 0;
max-width: 680px;
color: var(--muted);
font-size: 1.05rem;
}}
.generated {{
min-width: 220px;
padding: 14px 16px;
border: 1px solid var(--line);
border-radius: 8px;
background: rgba(255, 255, 255, 0.72);
color: var(--muted);
font-size: 0.9rem;
text-align: right;
}}
.generated strong {{
display: block;
color: var(--ink);
font-size: 1rem;
}}
.version-grid {{
display: grid;
grid-template-columns: repeat(auto-fit, minmax(260px, 1fr));
gap: 14px;
}}
.version-card {{
display: flex;
min-height: 118px;
flex-direction: column;
justify-content: space-between;
padding: 22px;
border: 1px solid var(--line);
border-radius: 8px;
background: var(--panel);
box-shadow: var(--shadow);
color: inherit;
text-decoration: none;
transition: border-color 160ms ease, transform 160ms ease, box-shadow 160ms ease;
}}
.version-card:hover,
.version-card:focus-visible {{
border-color: var(--accent);
box-shadow: 0 22px 55px rgba(31, 111, 235, 0.16);
transform: translateY(-2px);
outline: none;
}}
.version-name {{
font-size: 1.45rem;
font-weight: 750;
}}
.version-meta {{
color: var(--muted);
font-size: 0.95rem;
}}
@media (max-width: 720px) {{
main {{ padding-top: 42px; }}
.hero {{ grid-template-columns: 1fr; }}
.generated {{ text-align: left; }}
}}
</style>
</head>
<body>
<main>
<section class="hero" aria-labelledby="page-title">
<div>
<p class="eyebrow">RegistryLib Wiki</p>
<h1 id="page-title">Version Directory</h1>
<p class="summary">Choose the wiki that matches the RegistryLib branch or release line you are using. Each entry shows when that version was last published.</p>
</div>
<p class="generated"><span>Directory refreshed</span><strong>{escape(generated)}</strong></p>
</section>
<section class="version-grid" aria-label="Available wiki versions">
{cards if cards else ' <p class="version-meta">No wiki versions have been published yet.</p>'}
</section>
</main>
</body>
</html>
""",
encoding="utf-8",
)
PY

- name: Commit and push Pages branch
shell: bash
run: |
set -euo pipefail
cd pages
git config user.name "github-actions[bot]"
git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
git add .
if git diff --cached --quiet; then
echo "No Pages changes to publish."
exit 0
fi
git commit -m "Deploy docs for ${GITHUB_REF_NAME}"
git push origin gh-pages
53 changes: 53 additions & 0 deletions docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
---
sidebar_position: 1
---

# BreakdownKernel（瓦解核心）

面向 Minecraft 26.1.2 的大型系列 Mod 基础框架。通过**通用材料系统**统一管理材料定义，自动生成对应的物品、方块、流体等游戏内容，大幅减少样板代码。

## 核心特性

- **通用材料系统** — 一次定义材料，自动生成锭、粒、粉、块、流体等全部变体
- **元素系统** — 内置 116+ 化学元素，含半衰期等物理属性
- **Addon 扩展机制** — `@BreaAddon` 注解自动发现子 Mod
- **数据生成** — 自动生成配方、标签、战利品表
- **灵活注册** — `RegisterCondition` / `RegisterAction` 解耦变体与注册逻辑

## 快速开始

```groovy
// build.gradle
dependencies {
implementation "com.phasetranscrystal:breakdownkernel:0.1.0"
}
```

```java
// 定义一个材料
Material aluminium = new Material.Builder("aluminium")
.ingot() // 标记为锭材料
.fluid() // 标记为流体材料
.color(0x7db9d8)
.element(Element.AL)
.build();
```

材料注册后，会自动生成：

- `aluminium_ingot`、`aluminium_nugget`、`aluminium_dust`
- `aluminium_block`
- `aluminium_liquid`、`aluminium_melt`

## 模块

| 模块 | 说明 |
|------|------|
| [通用材料系统](material/index.md) | Material / MaterialAttribute / MaterialVariant 核心 API |
| BreaLib | 日志、环境检测、线程安全等基础工具库 |

## 进行中任务

- [x] [通用材料系统](material/index.md)
- [ ] 配方系统
- [ ] 多方块结构
Loading
Loading