seo.md

SEO

Remix has built-in support for setting up meta tags on a per-route basis which you can read about in the Remix Metadata docs.

The Epic Stack also has built-in support for /robots.txt and /sitemap.xml via resource routes using @nasa-gcn/remix-seo. By default, all routes are included in the sitemap.xml file, but you can configure which routes are included using the handle export in the route. Only public-facing pages should be included in the sitemap.xml file.

Here are two quick examples of how to customize the sitemap on a per-route basis from the @nasa-gcn/remix-seo docs:

// routes/blog/_layout.tsx
import { type SEOHandle } from '@nasa-gcn/remix-seo'
import { serverOnly$ } from 'vite-env-only/macros'

export const handle: SEOHandle = {
	getSitemapEntries: serverOnly$(async (request) => {
		const blogs = await db.blog.findMany()
		return blogs.map((blog) => {
			return { route: `/blog/${blog.slug}`, priority: 0.7 }
		})
	}),
}

Note the use of vite-env-only/macros. This is because handle is a route export object that goes in both the client as well as the server, but our sitemap function should only be run on the server. So we use vite-env-only/macros to make sure the function is removed for the client build. Support for this is pre-configured in the vite.config.ts file.

// in your routes/url-that-doesnt-need-sitemap
import { type SEOHandle } from '@nasa-gcn/remix-seo'

export async function loader({ request }: LoaderFunctionArgs) {
	/**/
}

export const handle: SEOHandle = {
	getSitemapEntries: () => null,
}