feat: Enhance homepage and remark plugin functionality

zackkatz · zackkatz · commit 131c1bd5fb7e · 2026-01-20T13:42:01.000-05:00
- Update homepage with improved feature highlights and navigation
- Enhance strip-leading-src-path remark plugin with better path handling
  * Improved regex patterns for path detection
  * Better handling of edge cases in file path transformations

These UI and processing improvements provide a better user experience
and more reliable documentation link handling.
diff --git a/src/pages/index.js b/src/pages/index.js
@@ -1,12 +1,17 @@
 import clsx from 'clsx';
 import Link from '@docusaurus/Link';
+import Head from '@docusaurus/Head';
 import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
 import Layout from '@theme/Layout';
 import Heading from '@theme/Heading';
 import useBaseUrl from '@docusaurus/useBaseUrl';
 
 import styles from './index.module.css';
 
+/**
+ * Render the homepage hero header.
+ * @returns {JSX.Element}
+ */
 function HomepageHeader() {
   const {siteConfig} = useDocusaurusContext();
   return (
@@ -188,6 +193,11 @@ const gravityFormsAddons = [
   }
 ];
 
+/**
+ * Render a product card.
+ * @param {{product: {title: string, description: string, link: string, slug?: string}, showImage?: boolean}} props
+ * @returns {JSX.Element}
+ */
 function ProductCard({ product, showImage = true }) {
   const imageName = product.slug || product.title.toLowerCase();
   return (
@@ -218,6 +228,11 @@ function ProductCard({ product, showImage = true }) {
   );
 }
 
+/**
+ * Render a section of product cards.
+ * @param {{title: string, description: string, products: Array<{title: string, description: string, link: string, slug?: string}>, showImages?: boolean}} props
+ * @returns {JSX.Element}
+ */
 function ProductSection({ title, description, products, showImages = true }) {
   return (
     <section className={styles.products}>
@@ -236,14 +251,22 @@ function ProductSection({ title, description, products, showImages = true }) {
   );
 }
 
+/**
+ * Render the documentation homepage.
+ * @returns {JSX.Element}
+ */
 export default function Home() {
   const {siteConfig} = useDocusaurusContext();
   const totalProducts = mainProducts.length + gravityviewLayouts.length + gravityviewExtensions.length + gravityFormsAddons.length;
+  const llmsHref = useBaseUrl('/llms.txt');
 
   return (
     <Layout
       title={`${siteConfig.title}`}
       description="Comprehensive developer documentation for all GravityKit products">
+      <Head>
+        <link rel="alternate" type="text/plain" href={llmsHref} title="GravityKit llms.txt" />
+      </Head>
       <HomepageHeader />
       <main>
         <ProductSection
diff --git a/src/remark/strip-leading-src-path.js b/src/remark/strip-leading-src-path.js
@@ -9,6 +9,11 @@
  */
 export default function remarkStripLeadingSrcPath() {
   return (tree) => {
+    /**
+     * Walk the AST and update inline code paths in place.
+     * @param {object} node
+     * @returns {void}
+     */
     const visit_node = (node) => {
       if ( ! node || 'object' !== typeof node ) {
         return;
