Skip to content

Commit bd205dc

Browse files
committed
Switch docs site to Galaxy theme
1 parent 79e132b commit bd205dc

8 files changed

Lines changed: 114 additions & 216 deletions

File tree

README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,13 +32,19 @@ PRIVATE_DOCS_SOURCE=/path/to/CMI-API npm run docs:sync
3232

3333
GitHub Actions deploys the Starlight build on pushes to `main`.
3434

35-
Default public URL:
35+
Public URL:
36+
37+
```text
38+
https://docs.1moreblock.com/
39+
```
40+
41+
GitHub Pages origin location:
3642

3743
```text
3844
https://mrfdev.github.io/1MB-Plugins-Docs/
3945
```
4046

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.
47+
The custom domain is configured through `public/CNAME` and `astro.config.mjs`.
4248

4349
## Sources
4450

astro.config.mjs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import { defineConfig } from 'astro/config';
22
import starlight from '@astrojs/starlight';
3-
import starlightThemeFlexoki from 'starlight-theme-flexoki';
3+
import starlightThemeGalaxy from 'starlight-theme-galaxy';
44

55
export default defineConfig({
66
site: 'https://docs.1moreblock.com',
@@ -18,7 +18,7 @@ export default defineConfig({
1818
href: 'https://github.com/mrfdev/1MB-Plugins-Docs',
1919
},
2020
],
21-
plugins: [starlightThemeFlexoki({ accentColor: 'green' })],
21+
plugins: [starlightThemeGalaxy()],
2222
customCss: ['./src/styles/custom.css'],
2323
sidebar: [
2424
{ label: 'Home', link: '/' },

package-lock.json

Lines changed: 74 additions & 7 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,6 @@
1313
"dependencies": {
1414
"@astrojs/starlight": "^0.39.2",
1515
"astro": "^6.4.2",
16-
"starlight-theme-flexoki": "^0.2.2"
16+
"starlight-theme-galaxy": "^0.8.0"
1717
}
1818
}

public/CNAME

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
docs.1moreblock.com

scripts/generate-site-content.mjs

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1060,11 +1060,13 @@ This site explains the player-facing features, commands, and server systems that
10601060
10611061
## Public URL
10621062
1063-
The default GitHub Pages URL for this repo will be:
1063+
The public player-facing docs URL is:
10641064
1065-
https://mrfdev.github.io/1MB-Plugins-Docs/
1065+
https://docs.1moreblock.com/
1066+
1067+
The GitHub Pages origin location is still available for deployment/reference:
10661068
1067-
Later, this can move to a custom domain such as \`docs.1moreblock.com\`.
1069+
https://mrfdev.github.io/1MB-Plugins-Docs/
10681070
`);
10691071

10701072
await writeFile(path.join(contentRoot, 'player-guides', 'getting-started.mdx'), `---

src/content/docs/index.mdx

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,10 @@ This site explains the player-facing features, commands, and server systems that
1717

1818
## Public URL
1919

20-
The default GitHub Pages URL for this repo will be:
20+
The public player-facing docs URL is:
2121

22-
https://mrfdev.github.io/1MB-Plugins-Docs/
22+
https://docs.1moreblock.com/
23+
24+
The GitHub Pages origin location is still available for deployment/reference:
2325

24-
Later, this can move to a custom domain such as `docs.1moreblock.com`.
26+
https://mrfdev.github.io/1MB-Plugins-Docs/

0 commit comments

Comments
 (0)