feat: add canonicals, robots.txt and sitemap

PaperMC · Jul 20, 2024 · 9e95fae · 9e95fae
1 parent 6e2408c
commit 9e95fae
Show file tree

Hide file tree

Showing 24 changed files with 67 additions and 23 deletions.
diff --git a/.npmrc b/.npmrc
@@ -0,0 +1 @@
+enable-pre-post-scripts=true
diff --git a/next-sitemap.config.js b/next-sitemap.config.js
@@ -0,0 +1,9 @@
+/** @type {import('next-sitemap').IConfig} */
+
+const dev = process.env.NODE_ENV !== 'production';
+
+module.exports = {
+  siteUrl: dev ? 'http://localhost:3000' : 'https://papermc.io',
+  exclude: ["/downloads/all"],
+  generateIndexSitemap: false,
+};
diff --git a/package.json b/package.json
@@ -10,6 +10,7 @@
   "scripts": {
     "dev": "next dev",
     "build": "next build",
+    "postbuild": "next-sitemap",
     "start": "next start",
     "lint": "next lint"
   },
@@ -18,6 +19,7 @@
     "@headlessui/react": "2.1.2",
     "clsx": "2.1.1",
     "next": "13.5.4",
+    "next-sitemap": "^4.2.3",
     "react": "18.3.1",
     "react-dom": "18.3.1",
     "sharp": "^0.33.4",

diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/public/.gitignore b/public/.gitignore
@@ -0,0 +1 @@
+sitemap.xml
diff --git a/public/robots.txt b/public/robots.txt
@@ -1,3 +1,8 @@
 User-agent: *
+Disallow: /downloads/all
+Disallow: /repository/
+Disallow: /repo/
+Disallow: /api/
 Allow: /
-Disallow: /downloads/all
+
+Sitemap: https://papermc.io/sitemap.xml
diff --git a/src/components/layout/SoftwareDownload.tsx b/src/components/layout/SoftwareDownload.tsx
@@ -28,7 +28,7 @@ const SoftwareDownload = ({
   const [isStable, setStable] = useState(true);
   const version = isStable
     ? project.latestStableVersion
-    : project.latestExperimentalVersion ?? project.latestStableVersion;
+    : (project.latestExperimentalVersion ?? project.latestStableVersion);
   const { data: builds } = useVersionBuilds(id, version);
   const latestBuild = builds && builds.builds[builds.builds.length - 1];
 
@@ -61,7 +61,7 @@ const SoftwareDownload = ({
             </span>
           </h2>
           <p className="text-xl mt-4">
-            {isStable ? description : experimentalWarning ?? description}
+            {isStable ? description : (experimentalWarning ?? description)}
           </p>
           <div className="flex flex-col gap-4 mt-8">
             <SoftwareDownloadButton

diff --git a/src/components/util/SEO.tsx b/src/components/util/SEO.tsx
@@ -5,16 +5,24 @@ export interface SEOProps {
   title: string;
   description: string;
   keywords: string[];
+  canonical: string;
 }
 
-const SEO = ({ title, description, keywords }: SEOProps): ReactElement => {
+const SEO = ({
+  title,
+  description,
+  keywords,
+  canonical,
+}: SEOProps): ReactElement => {
   return (
     <Head>
       <title>{title + " | PaperMC"}</title>
 
       <meta name="description" content={description} />
       <meta name="keywords" content={keywords.join(", ")} />
 
+      <link rel="canonical" href={`https://papermc.io` + canonical} />
+
       <meta property="og:type" content="website" />
       <meta property="og:title" content={title} />
       <meta property="og:description" content={description} />

diff --git a/src/pages/community/guidelines.tsx b/src/pages/community/guidelines.tsx
@@ -11,6 +11,7 @@ const CommunityGuidelines: NextPage = () => (
       title="Community Guidelines"
       description="Community Guidelines for the PaperMC community."
       keywords={["papermc", "paper", "minecraft", "community", "guidelines"]}
+      canonical="/community/guidelines"
     />
     <header className="max-w-7xl mx-auto px-4 pt-32 pb-16">
       <h1 className="font-medium leading-normal lg:(text-5xl leading-normal) text-4xl">

diff --git a/src/pages/community/index.tsx b/src/pages/community/index.tsx
@@ -9,6 +9,7 @@ const CommunityIndex: NextPage = () => (
       title="Community"
       description="We're happy to have you as a part of the PaperMC community!"
       keywords={["papermc", "paper", "minecraft", "sponsor", "community"]}
+      canonical="/community"
     />
     <header className="max-w-7xl flex flex-row mx-auto px-4 pt-32 pb-16 lg:(pt-48 pb-32) gap-16">
       <div className="flex-1">

diff --git a/src/pages/contribute.tsx b/src/pages/contribute.tsx
@@ -13,6 +13,7 @@ const Contribute: NextPage = () => (
       title="Contributing"
       description="Without contributors our projects wouldn't be possible. Find out how you can help."
       keywords={["papermc", "paper", "minecraft", "sponsor", "contributing"]}
+      canonical="/contribute"
     />
     <header className="max-w-7xl flex flex-row mx-auto px-4 pt-32 pb-16 lg:(pt-48 pb-32) gap-16">
       <div className="flex-1">

diff --git a/src/pages/downloads/all.tsx b/src/pages/downloads/all.tsx
@@ -46,6 +46,7 @@ const LegacyDownloads: NextPage<LegacyDownloadProps> = ({
         title="Build explorer"
         description="Build explorer for PaperMC projects. Proceed with caution!"
         keywords={[]}
+        canonical="/downloads/all"
       />
       <div className="flex flex-col h-screen">
         <div className="h-16" />

diff --git a/src/pages/downloads/index.tsx b/src/pages/downloads/index.tsx
@@ -22,6 +22,7 @@ const Downloads: NextPage = () => {
           "waterfall",
           "downloads",
         ]}
+        canonical="/downloads"
       />
       <header className="max-w-4xl flex flex-col items-center mx-auto px-4 pt-32 pb-16 lg:(pt-48 pb-26) gap-2">
         <h1 className="font-medium leading-normal lg:(text-5xl leading-normal) text-4xl">

diff --git a/src/pages/downloads/paper.tsx b/src/pages/downloads/paper.tsx
@@ -20,6 +20,7 @@ const PaperDownloads = ({ project }: ProjectProps): ReactElement => {
           "downloads",
           "jar",
         ]}
+        canonical="/downloads/paper"
       />
       <SoftwareDownload
         id="paper"

diff --git a/src/pages/downloads/velocity.tsx b/src/pages/downloads/velocity.tsx
@@ -20,6 +20,7 @@ const VelocityDownloads = ({ project }: ProjectProps): ReactElement => {
           "downloads",
           "jar",
         ]}
+        canonical="/downloads/velocity"
       />
       <SoftwareDownload
         id="velocity"

diff --git a/src/pages/downloads/waterfall.tsx b/src/pages/downloads/waterfall.tsx
@@ -22,6 +22,7 @@ const WaterfallDownloads = ({ project }: ProjectProps): ReactElement => {
           "downloads",
           "jar",
         ]}
+        canonical="/downloads/waterfall"
       />
       <SoftwareDownload
         id="waterfall"

diff --git a/src/pages/index.tsx b/src/pages/index.tsx
@@ -24,6 +24,7 @@ const Home: NextPage<ProjectProps> = ({ project }) => {
         description="PaperMC is a Minecraft software organization focusing on improving
           the game’s ecosystem with faster and more secure software."
         keywords={["papermc", "paper", "velocity", "minecraft", "performance"]}
+        canonical="/"
       />
       <header className="max-w-7xl flex flex-row mx-auto px-4 pt-32 pb-26 lg:(pt-48 pb-46)">
         <div className="flex-1">

diff --git a/src/pages/javadocs.tsx b/src/pages/javadocs.tsx
@@ -34,6 +34,7 @@ const Javadocs: NextPage<JavadocProps> = ({
           "velocity",
           "waterfall",
         ]}
+        canonical="/javadocs"
       />
       <header className="max-w-7xl flex flex-col items-center mx-auto px-4 pt-32 pb-16 lg:(pt-48 pb-26) gap-2">
         <h1 className="font-medium leading-normal lg:(text-5xl leading-normal) text-4xl">

diff --git a/src/pages/software/folia/index.tsx b/src/pages/software/folia/index.tsx
@@ -29,6 +29,7 @@ const FoliaHome = ({ project }: HangarProjectProps): ReactElement => {
           "multithreading",
           "fork",
         ]}
+        canonical="/software/folia"
       />
       <SoftwareHeader
         id="folia"

diff --git a/src/pages/software/paper/index.tsx b/src/pages/software/paper/index.tsx
@@ -33,6 +33,7 @@ const PaperHome = ({
           "spigot",
           "fork",
         ]}
+        canonical="/software/paper"
       />
       <SoftwareHeader
         id="paper"

diff --git a/src/pages/software/velocity/index.tsx b/src/pages/software/velocity/index.tsx
@@ -31,6 +31,7 @@ const VelocityHome = ({
           "performance",
           "bungeecord",
         ]}
+        canonical="/software/velocity"
       />
       <SoftwareHeader
         id="velocity"

diff --git a/src/pages/software/waterfall/index.tsx b/src/pages/software/waterfall/index.tsx
@@ -25,6 +25,7 @@ const WaterfallHome = ({ project }: HangarProjectProps): ReactElement => {
           "bungeecord",
           "fork",
         ]}
+        canonical="/software/waterfall"
       />
       <SoftwareHeader
         id="waterfall"

diff --git a/src/pages/sponsors.tsx b/src/pages/sponsors.tsx
@@ -18,6 +18,7 @@ const Sponsors: NextPage = () => {
         title="Sponsors"
         description="Without contributors our projects wouldn't be possible. Find out how you can help."
         keywords={["papermc", "paper", "minecraft", "sponsor", "contributing"]}
+        canonical="/sponsors"
       />
       <header className="max-w-7xl flex flex-row mx-auto px-4 pt-32 pb-16 lg:(pt-48 pb-32) gap-16">
         <div className="flex-1">