Skip to content

Commit a57832a

Browse files
committed
Add public Starlight docs site
Adds a public documentation mirror under project-docs, Starlight/Astro site content, sync and generation scripts, GitHub Pages deployment workflow, and public-safe ignore rules.
1 parent 6a41e77 commit a57832a

92 files changed

Lines changed: 27951 additions & 0 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/workflows/deploy.yml

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
name: Deploy to GitHub Pages
2+
3+
on:
4+
push:
5+
branches: [main]
6+
workflow_dispatch:
7+
8+
permissions:
9+
contents: read
10+
pages: write
11+
id-token: write
12+
13+
concurrency:
14+
group: pages
15+
cancel-in-progress: false
16+
17+
jobs:
18+
build:
19+
runs-on: ubuntu-latest
20+
steps:
21+
- name: Checkout repository
22+
uses: actions/checkout@v6
23+
24+
- name: Install, build, and upload site
25+
uses: withastro/action@v6
26+
with:
27+
node-version: 24
28+
29+
deploy:
30+
needs: build
31+
runs-on: ubuntu-latest
32+
environment:
33+
name: github-pages
34+
url: ${{ steps.deployment.outputs.page_url }}
35+
steps:
36+
- name: Deploy to GitHub Pages
37+
id: deployment
38+
uses: actions/deploy-pages@v5

.gitignore

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
.DS_Store
2+
.env
3+
.env.*
4+
!.env.example
5+
6+
node_modules/
7+
dist/
8+
.astro/
9+
.cache/
10+
11+
*.log
12+
*.tmp
13+
*.sqlite
14+
*.sqlite3
15+
*.db
16+
17+
*.jar
18+
*.war
19+
*.zip
20+
21+
servers/
22+
build/
23+
out/

README.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# 1MoreBlock Plugin Docs
2+
3+
Public documentation mirror and Starlight site for 1MoreBlock plugin features.
4+
5+
The private development repository is `mrfdev/1MB-CMIAPI`. This public repository intentionally publishes documentation only:
6+
7+
- `project-docs/README.md`
8+
- `project-docs/docs/`
9+
- `src/content/docs/` for the Starlight site
10+
11+
It does not publish plugin source code, built jars, private server folders, databases, paid plugin files, internal task logs, or operational checklists.
12+
13+
## Local Workflow
14+
15+
From this repository:
16+
17+
```bash
18+
npm install
19+
npm run docs:sync
20+
npm run build
21+
```
22+
23+
`npm run docs:sync` copies `README.md` and `docs/` from the sibling private repo at `../CMI-API` into `project-docs/`, then regenerates the Starlight content pages.
24+
25+
If the private repo lives somewhere else:
26+
27+
```bash
28+
PRIVATE_DOCS_SOURCE=/path/to/CMI-API npm run docs:sync
29+
```
30+
31+
## GitHub Pages
32+
33+
GitHub Actions deploys the Starlight build on pushes to `main`.
34+
35+
Default public URL:
36+
37+
```text
38+
https://mrfdev.github.io/1MB-Plugins-Docs/
39+
```
40+
41+
For a future custom domain such as `docs.1moreblock.com`, add `public/CNAME` and update `astro.config.mjs` according to the Astro GitHub Pages custom-domain instructions.
42+
43+
## Sources
44+
45+
- Starlight: https://starlight.astro.build/
46+
- Astro GitHub Pages deployment: https://docs.astro.build/en/guides/deploy/github/

astro.config.mjs

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
import { defineConfig } from 'astro/config';
2+
import starlight from '@astrojs/starlight';
3+
4+
export default defineConfig({
5+
site: 'https://mrfdev.github.io',
6+
base: '/1MB-Plugins-Docs',
7+
integrations: [
8+
starlight({
9+
title: '1MoreBlock Plugin Docs',
10+
description: 'Friendly public documentation for 1MoreBlock plugin features.',
11+
editLink: {
12+
baseUrl: 'https://github.com/mrfdev/1MB-Plugins-Docs/edit/main/',
13+
},
14+
social: [
15+
{
16+
icon: 'github',
17+
label: 'GitHub',
18+
href: 'https://github.com/mrfdev/1MB-Plugins-Docs',
19+
},
20+
],
21+
customCss: ['./src/styles/custom.css'],
22+
sidebar: [
23+
{ label: 'Home', link: '/' },
24+
{
25+
label: 'Players',
26+
items: [
27+
{ slug: 'player-guides/getting-started' },
28+
{ slug: 'player-guides/commands' },
29+
{ slug: 'player-guides/features' },
30+
],
31+
},
32+
{
33+
label: 'Staff Reference',
34+
items: [
35+
{ slug: 'staff-reference' },
36+
{ slug: 'staff-reference/plugins' },
37+
],
38+
},
39+
],
40+
}),
41+
],
42+
});

0 commit comments

Comments
 (0)