Slight site improvements

stevenpetryk · Mar 4, 2024 · 583a671 · 583a671
1 parent c9ed792
commit 583a671
Show file tree

Hide file tree

Showing 4 changed files with 29 additions and 2 deletions.
diff --git a/docs/app/guides/link.tsx b/docs/app/guides/link.tsx
@@ -23,6 +23,8 @@ export function GuideLink({ sectionTitle, guideSlug, children }: GuideLinkProps)
           hover:text-blue-700 focus:text-blue-700
           focus:z-10
           dark:text-slate-300 dark:focus:text-blue-300 dark:hover:text-blue-300
+          transition
+          active:scale-[0.99]
           ${
             active
               ? "text-blue-700 dark:text-blue-400 dark:focus:text-blue-400 dark:hover:text-blue-400 font-bold md:bg-slate-100 md:dark:bg-slate-800"

diff --git a/docs/app/layout.tsx b/docs/app/layout.tsx
@@ -5,6 +5,7 @@ import "./globals.css"
 import "../node_modules/@wooorm/starry-night/style/core.css"
 import "../node_modules/@wooorm/starry-night/style/dark.css"
 import { Metadata } from "next"
+import mafsPkg from "../../package.json"
 
 export const metadata: Metadata = {
   title: "Mafs: React components for interactive math",
@@ -21,8 +22,16 @@ export default function RootLayout({ children }: { children: React.ReactNode })
       </head>
       <body className="flex flex-col min-h-screen items-stretch dark:bg-gray-900">
         <header className="sm:flex sm:space-x-6 sm:space-y-0 space-y-6 items-center p-6 self-center w-full max-w-5xl">
-          <div className="flex-shrink-0 flex justify-center md:block md:w-56 mx-auto lg:mx-0">
+          <div className="flex-shrink-0 flex justify-center items-center md:block md:w-56 mx-auto lg:mx-0 gap-4">
             <Logo />
+
+            <Link
+              href={`https://github.com/stevenpetryk/mafs/releases`}
+              target="_blank"
+              className="text-sm px-3 py-1 bg-gray-100 rounded-lg text-gray-700 dark:text-gray-300 dark:bg-gray-800"
+            >
+              v{mafsPkg.version}
+            </Link>
           </div>
           <div className="flex-grow">
             {/* The world isn't ready for search */}

diff --git a/docs/components/PropTable.tsx b/docs/components/PropTable.tsx
@@ -2,6 +2,7 @@ import * as React from "react"
 import ReactMarkdown from "react-markdown"
 
 import DocgenInfo from "../generated-docgen"
+import Link from "next/link"
 
 export interface Docgen {
   filePath: string
@@ -55,6 +56,16 @@ export function PropTable({ of: displayName }: PropTableProps) {
             </>
           )}
         </code>
+
+        <div className="flex-1"></div>
+
+        <Link
+          target="_blank"
+          className="text-sm"
+          href={`https://github.com/stevenpetryk/mafs/tree/main/${docgenInfo.filePath}`}
+        >
+          View on GitHub
+        </Link>
       </header>
 
       <div className="overflow-x-auto text-sm">

diff --git a/scripts/docgen.ts b/scripts/docgen.ts
@@ -14,6 +14,11 @@ const parse = docgen.withCustomConfig(tsConfigPath, {
 export function writeDocgenResults(docgenInfo: docgen.ComponentDoc[]) {
   const writePath = path.join(projectRoot, "docs/generated-docgen.tsx")
 
+  docgenInfo = docgenInfo.map((inf) => ({
+    ...inf,
+    filePath: path.relative(projectRoot, inf.filePath),
+  }))
+
   fs.writeFileSync(
     writePath,
     [
@@ -26,7 +31,7 @@ export function writeDocgenResults(docgenInfo: docgen.ComponentDoc[]) {
   console.log(`Docgen updated ${writePath}`)
 }
 
-const paths = fg.sync("src/**/*.tsx")
+const paths = fg.sync("src/**/*.tsx", { ignore: ["src/index.tsx"] })
 
 const docgenInfo = parse(paths)
 writeDocgenResults(docgenInfo)