CivMC/Civ
1
0
Fork 0
mirror of https://github.com/CivMC/Civ.git synced 2026-07-15 23:20:44 +00:00
Code Issues Packages Projects Releases Wiki Activity

improve site SEO and add opengraph tags

Browse Source
This commit is contained in:
Huskydog9988
2025-01-25 15:58:15 -05:00
parent fce23a7310
commit f4bb6c8f50
9 changed files with 276 additions and 75 deletions
Download Patch File Download Diff File Expand all files Collapse all files

346
docs/.vitepress/config.mts
View File

@@ -1,26 +1,134 @@
import { defineConfig } from 'vitepress' import { defineConfig } from "vitepress";
// should roughly match the tag line used on the main site page
const DESCRIPTION = "A Minecraft server focused on civilization building";
const SITE_URL = "https://civmc.net";
const SITE_LOGO = SITE_URL + "/logo.png";
const GITHUB_ORG = "https://github.com/CivMC";
const DISCORD_LINK = "https://discord.gg/HkD79GfmQQ";
const REDDIT = "https://www.reddit.com/r/CivMC/";
const PATREON = "https://www.patreon.com/Civ_MC";
// https://vitepress.dev/reference/site-config // https://vitepress.dev/reference/site-config
export default defineConfig({ export default defineConfig({
title: "CivMC", lang: "en-US",
description: "CivMC", title: "CivMC",
themeConfig: { description: DESCRIPTION,
search: {
provider: 'local'
},
nav: [ sitemap: {
{ text: 'Home', link: '/' }, hostname: SITE_URL,
{ text: 'Wiki', link: '/wiki/' }, lastmodDateOnly: false,
{ text: 'Developer Docs', link: '/dev/' }, xmlns: {
// trim the xml namespace
news: false,
video: false,
xhtml: true,
image: false,
},
},
head: [
// favicon stuff
[
"link",
{
rel: "apple-touch-icon",
sizes: "180x180",
href: "/apple-touch-icon.png",
type: "image/png",
},
],
[
"link",
{
rel: "icon",
type: "image/png",
sizes: "32x32",
href: "/favicon-32x32.png",
},
],
[
"link",
{
rel: "icon",
type: "image/png",
sizes: "16x16",
href: "/favicon-16x16.png",
},
],
[
"link",
{
rel: "manifest",
href: "/site.webmanifest",
},
],
// used by search engines
[
"meta",
{
name: "keywords",
content:
"Civ, CivCraft, CivMC, Minecraft, Wiki, Roleplay, Role-playing",
},
],
// open graph
["meta", { property: "og:type", content: "website" }],
["meta", { property: "og:title", content: DESCRIPTION }],
["meta", { property: "og:image", content: SITE_LOGO }],
[
"meta",
{
property: "og:description",
content: DESCRIPTION,
},
],
["meta", { property: "og:url", content: SITE_URL }],
// twitter's og because special
[
"meta",
{
name: "twitter:description",
content: DESCRIPTION,
},
],
["meta", { name: "twitter:title", content: "CivMC" }],
["meta", { name: "twitter:card", content: "summary_large_image" }],
["meta", { name: "twitter:image", content: SITE_LOGO }],
["meta", { name: "twitter:url", content: SITE_URL }],
], ],
sidebar: { themeConfig: {
'/wiki/': [ search: {
{ provider: "local",
text: "Wiki", },
// enables showing the last time the page was updated
lastUpdated: {},
editLink: {
pattern: GITHUB_ORG + "/Civ/edit/main/docs/:path",
},
nav: [
{ text: "Home", link: "/" },
{ text: "Wiki", link: "/wiki/" },
{ text: "Developer Docs", link: "/dev/" },
],
sidebar: {
"/wiki/": [
{
text: "Wiki",
items: [ items: [
{ text: "New Player Guide", link: "/wiki/new-player-guide" }, {
text: "New Player Guide",
link: "/wiki/new-player-guide",
},
{ text: "Server Overview", link: "/wiki/index" }, { text: "Server Overview", link: "/wiki/index" },
{ text: "Change Log", link: "/wiki/changelog" }, { text: "Change Log", link: "/wiki/changelog" },
{ {
@@ -31,8 +139,14 @@ export default defineConfig({
link: "wiki/plugins/essential/", link: "wiki/plugins/essential/",
collapsed: false, collapsed: false,
items: [ items: [
{ text: "NameLayer", link: "wiki/plugins/essential/namelayer" }, {
{ text: "Citadel", link: "wiki/plugins/essential/citadel" }, text: "NameLayer",
link: "wiki/plugins/essential/namelayer",
},
{
text: "Citadel",
link: "wiki/plugins/essential/citadel",
},
{ {
text: "ExilePearl", text: "ExilePearl",
link: "wiki/plugins/essential/exilepearl", link: "wiki/plugins/essential/exilepearl",
@@ -44,16 +158,46 @@ export default defineConfig({
link: "pages/plugins/unique/", link: "pages/plugins/unique/",
collapsed: false, collapsed: false,
items: [ items: [
{ text: "Hiddenore", link: "wiki/plugins/unique/hiddenore" }, {
{ text: "Factorymod", link: "wiki/plugins/unique/factorymod" }, text: "Hiddenore",
{ text: "Finale", link: "wiki/plugins/unique/finale" }, link: "wiki/plugins/unique/hiddenore",
{ text: "PvP Server", link: "wiki/plugins/unique/pvpserver" }, },
{ text: "JukeAlert", link: "wiki/plugins/unique/jukealert" }, {
{ text: "Bastions", link: "wiki/plugins/unique/bastions" }, text: "Factorymod",
{ text: "Realistic Biomes", link: "wiki/plugins/unique/rb" }, link: "wiki/plugins/unique/factorymod",
{ text: "Heliodor", link: "wiki/plugins/unique/heliodor" }, },
{ text: "Transport Changes", link: "wiki//plugins/unique/Transport" }, {
{ text: "Chunk Limits",link: "wiki/plugins/unique/chunklimits" }, text: "Finale",
link: "wiki/plugins/unique/finale",
},
{
text: "PvP Server",
link: "wiki/plugins/unique/pvpserver",
},
{
text: "JukeAlert",
link: "wiki/plugins/unique/jukealert",
},
{
text: "Bastions",
link: "wiki/plugins/unique/bastions",
},
{
text: "Realistic Biomes",
link: "wiki/plugins/unique/rb",
},
{
text: "Heliodor",
link: "wiki/plugins/unique/heliodor",
},
{
text: "Transport Changes",
link: "wiki//plugins/unique/Transport",
},
{
text: "Chunk Limits",
link: "wiki/plugins/unique/chunklimits",
},
], ],
}, },
{ {
@@ -61,55 +205,107 @@ export default defineConfig({
link: "wiki/plugins/fun/", link: "wiki/plugins/fun/",
collapsed: true, collapsed: true,
items: [ items: [
{ text: "Item Exchange", link: "wiki/plugins/fun/itemexchange" }, {
{ text: "Brewery", link: "wiki/plugins/fun/brewery" }, text: "Item Exchange",
{ text: "EvenMoreFish", link: "wiki/plugins/fun/evenmorefish" }, link: "wiki/plugins/fun/itemexchange",
{ text: "Wordbank", link: "wiki/plugins/fun/wordbank" }, },
{ text: "Railswitch", link: "wiki/plugins/fun/railswitch" }, {
{ text: "Elevators", link: "wiki/plugins/fun/elevators" }, text: "Brewery",
{ text: "Castlegate", link: "wiki/plugins/fun/castlegate" }, link: "wiki/plugins/fun/brewery",
{ text: "Arthropod Egg", link: "wiki/plugins/fun/arthropodegg" }, },
{
text: "EvenMoreFish",
link: "wiki/plugins/fun/evenmorefish",
},
{
text: "Wordbank",
link: "wiki/plugins/fun/wordbank",
},
{
text: "Railswitch",
link: "wiki/plugins/fun/railswitch",
},
{
text: "Elevators",
link: "wiki/plugins/fun/elevators",
},
{
text: "Castlegate",
link: "wiki/plugins/fun/castlegate",
},
{
text: "Arthropod Egg",
link: "wiki/plugins/fun/arthropodegg",
},
], ],
}, },
], ],
}, },
] ],
} },
], ],
'/dev/': [ "/dev/": [
{ {
text: 'Developer Docs', text: "Developer Docs",
items: [ items: [
{ {
text: "Getting Started", text: "Getting Started",
link: '/dev/getting-started/', link: "/dev/getting-started/",
items: [ items: [
{ text: 'Project Overview', link: '/dev/getting-started/projects' }, {
{ text: 'Building with Gradle', link: '/dev/getting-started/building-with-gradle' }, text: "Project Overview",
] link: "/dev/getting-started/projects",
}, },
{ {
text: "Code Style", text: "Building with Gradle",
link: '/dev/code-style/', link: "/dev/getting-started/building-with-gradle",
items: [ },
{ text: 'Java Code Style', link: '/dev/code-style/java-code-style' }, ],
] },
}, {
{ text: "Code Style",
text: "Plugin Standards", link: "/dev/code-style/",
link: '/dev/plugin-standards/', items: [
items: [ {
{ text: 'Event Handling', link: '/dev/plugin-standards/event-handling' }, text: "Java Code Style",
{ text: 'Permissions', link: '/dev/plugin-standards/permissions' }, link: "/dev/code-style/java-code-style",
], },
}, ],
] },
} {
], text: "Plugin Standards",
}, link: "/dev/plugin-standards/",
items: [
{
text: "Event Handling",
link: "/dev/plugin-standards/event-handling",
},
{
text: "Permissions",
link: "/dev/plugin-standards/permissions",
},
],
},
],
},
],
},
socialLinks: [ socialLinks: [
{ icon: 'github', link: 'https://github.com/CivMC' } { icon: "discord", link: DISCORD_LINK, ariaLabel: "CivMC Discord" },
] {
} icon: {
}) svg: '<svg width="32" height="32" viewBox="0 0 24 24"><path fill="currentColor" d="M12 0A12 12 0 0 0 0 12a12 12 0 0 0 12 12a12 12 0 0 0 12-12A12 12 0 0 0 12 0zm5.01 4.744c.688 0 1.25.561 1.25 1.249a1.25 1.25 0 0 1-2.498.056l-2.597-.547l-.8 3.747c1.824.07 3.48.632 4.674 1.488c.308-.309.73-.491 1.207-.491c.968 0 1.754.786 1.754 1.754c0 .716-.435 1.333-1.01 1.614a3.111 3.111 0 0 1 .042.52c0 2.694-3.13 4.87-7.004 4.87c-3.874 0-7.004-2.176-7.004-4.87c0-.183.015-.366.043-.534A1.748 1.748 0 0 1 4.028 12c0-.968.786-1.754 1.754-1.754c.463 0 .898.196 1.207.49c1.207-.883 2.878-1.43 4.744-1.487l.885-4.182a.342.342 0 0 1 .14-.197a.35.35 0 0 1 .238-.042l2.906.617a1.214 1.214 0 0 1 1.108-.701zM9.25 12C8.561 12 8 12.562 8 13.25c0 .687.561 1.248 1.25 1.248c.687 0 1.248-.561 1.248-1.249c0-.688-.561-1.249-1.249-1.249zm5.5 0c-.687 0-1.248.561-1.248 1.25c0 .687.561 1.248 1.249 1.248c.688 0 1.249-.561 1.249-1.249c0-.687-.562-1.249-1.25-1.249zm-5.466 3.99a.327.327 0 0 0-.231.094a.33.33 0 0 0 0 .463c.842.842 2.484.913 2.961.913c.477 0 2.105-.056 2.961-.913a.361.361 0 0 0 .029-.463a.33.33 0 0 0-.464 0c-.547.533-1.684.73-2.512.73c-.828 0-1.979-.196-2.512-.73a.326.326 0 0 0-.232-.095z"/></svg>',
},
link: REDDIT,
ariaLabel: "CivMC SubReddit",
},
{ icon: "github", link: GITHUB_ORG, ariaLabel: "CivMC GitHub" },
{ icon: "patreon", link: PATREON, ariaLabel: "CivMC Patreon" },
],
footer: {
copyright: "Copyright © 2023-present CivMC",
},
},
});

BIN
docs/public/android-chrome-192x192.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 19 KiB

BIN
docs/public/android-chrome-512x512.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 41 KiB

BIN
docs/public/apple-touch-icon.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 18 KiB

BIN
docs/public/favicon-16x16.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 923 B

BIN
docs/public/favicon-32x32.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 2.2 KiB

BIN
docs/public/favicon.ico Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 15 KiB

4
docs/public/robots.txt Normal file
View File

@@ -0,0 +1,4 @@
User-agent: *
Allow: /
Sitemap: https://civmc.net/sitemap.xml

1
docs/public/site.webmanifest Normal file
View File

@@ -0,0 +1 @@
{"name":"","short_name":"","icons":[{"src":"/android-chrome-192x192.png","sizes":"192x192","type":"image/png"},{"src":"/android-chrome-512x512.png","sizes":"512x512","type":"image/png"}],"theme_color":"#ffffff","background_color":"#ffffff","display":"standalone"}