docs v2

Author: davemooreuws

.gitignore

@@ -23,10 +23,17 @@
 npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
-.pnpm-debug.log*
 
 # local env files
 .env*.local
 
 # vercel
 .vercel
+
+# typescript
+*.tsbuildinfo
+next-env.d.ts
+
+.contentlayer
+
+old

.husky/pre-commit

@@ -0,0 +1 @@
+yarn lint-staged

.spellcheckerrc.yml

@@ -1,5 +1,5 @@
 files:
-  - 'src/pages/**/*.{md,mdx}'
+  - 'docs/**/*.{md,mdx}'
 dictionaries:
   - dictionary.txt
 quiet: true

components.json

@@ -1,17 +1,20 @@
 {
   "$schema": "https://ui.shadcn.com/schema.json",
-  "style": "default",
-  "rsc": false,
+  "style": "new-york",
+  "rsc": true,
   "tsx": true,
   "tailwind": {
-    "config": "tailwind.config.js",
+    "config": "tailwind.config.ts",
     "css": "src/styles/tailwind.css",
-    "baseColor": "slate",
+    "baseColor": "zinc",
     "cssVariables": true,
     "prefix": ""
   },
   "aliases": {
     "components": "@/components",
-    "utils": "@/lib/utils"
+    "utils": "@/lib/utils",
+    "ui": "@/components/ui",
+    "lib": "@/lib",
+    "hooks": "@/hooks"
   }
 }

contentlayer.config.ts

@@ -0,0 +1,71 @@
+import { defineDocumentType, makeSource } from 'contentlayer2/source-files'
+import { extractTocHeadings } from './src/mdx/remark-toc-headings.mjs'
+import { title } from 'radash'
+import path from 'path'
+import fs from 'fs'
+
+const contentDirPath = 'docs'
+
+const branch = process.env.NEXT_PUBLIC_GITHUB_BRANCH || 'main'
+
+const Doc = defineDocumentType(() => ({
+  name: 'Doc',
+  filePathPattern: '**/*.mdx',
+  fields: {
+    title: {
+      type: 'string',
+      description: 'The meta title of the doc',
+    },
+    nav_title: {
+      type: 'string',
+      description: 'The title of the doc in the navigation',
+    },
+    description: {
+      type: 'string',
+      description: 'The description of the doc',
+    },
+    image: {
+      type: 'string',
+      description: 'The image of the doc',
+    },
+    image_alt: {
+      type: 'string',
+      description: 'The image alt of the doc',
+    },
+    disable_edit: {
+      type: 'boolean',
+      description: 'Disable the github edit button',
+    },
+  },
+  computedFields: {
+    slug: {
+      type: 'string',
+      resolve: (doc) => doc._raw.flattenedPath,
+    },
+    toc: { type: 'json', resolve: (doc) => extractTocHeadings(doc.body.raw) },
+    editUrl: {
+      type: 'string',
+      resolve: (doc) =>
+        `https://github.com/nitrictech/docs/edit/${branch}/docs/${doc._raw.sourceFilePath}`,
+    },
+    lastModified: {
+      type: 'date',
+      resolve: (doc) => {
+        // Get the full path to the markdown file
+        const filePath = path.join(
+          process.cwd(),
+          contentDirPath,
+          doc._raw.sourceFilePath,
+        )
+        // Extract and return the last modified date
+        const stats = fs.statSync(filePath)
+        return stats.mtime // This is the last modified date
+      },
+    },
+  },
+}))
+
+export default makeSource({
+  contentDirPath,
+  documentTypes: [Doc],
+})

cypress.config.ts

@@ -33,7 +33,7 @@ const isExternalUrl = (url: string) => {
   return !url.includes('localhost')
 }
 
-const req = (url: string, retryCount = 0) => {
+const req = (url: string, retryCount = 0): any => {
   return cy
     .request({
       url,
@@ -71,7 +71,8 @@ describe('Broken links test suite', () => {
               (link.getAttribute('href') &&
                 link.getAttribute('href')?.includes(l)) ||
               //@ts-ignore
-              (link.getAttribute('src') && link.getAttribute('src').includes(l))
+              (link.getAttribute('src') &&
+                link.getAttribute('src').includes(l)),
           )
         })
         .each((link) => {
@@ -90,7 +91,7 @@ describe('Broken links test suite', () => {
               let acceptableCodes = CORRECT_CODES
               if (REDIRECT_CODES.includes(res.status) && !isExternalUrl(url)) {
                 assert.fail(
-                  `${url} returned ${res.status} to ${res.headers['location']}`
+                  `${url} returned ${res.status} to ${res.headers['location']}`,
                 )
               } else {
                 acceptableCodes = [
@@ -106,7 +107,7 @@ describe('Broken links test suite', () => {
 
               expect(res.status).oneOf(
                 acceptableCodes,
-                `${url} returned ${res.status}`
+                `${url} returned ${res.status}`,
               )
             })
           }
@@ -129,7 +130,7 @@ describe('Current links test suite', () => {
           ? '/docs'
           : `/docs${p.loc
               .substring(PROD_BASE_URL.length, p.loc.length)
-              .replace('/_index', '')}`
+              .replace('/_index', '')}`,
       )
     })
   })

cypress/e2e/broken-links.cy.ts

@@ -1,5 +1,3 @@
-import { InstallNitric } from '@/components/InstallNitric'
-
 export const description =
   'Basic installation instructions for the Nitric Framework'
 
@@ -26,16 +24,16 @@ Please follow these links to the official installation steps for each.
 
 <InstallNitric>
 
-```bash {{ title: 'macOS' }}
+```bash !!tabs macOS
 brew install nitrictech/tap/nitric
 ```
 
-```bash {{ title: 'Windows' }}
+```bash !!tabs Windows
 scoop bucket add nitric https://github.com/nitrictech/scoop-bucket.git
 scoop install nitric
 ```
 
-```bash {{ title: 'Linux' }}
+```bash !!tabs Linux
 curl -L "https://nitric.io/install?version=latest" | bash
 ```
 
@@ -49,15 +47,15 @@ Alternatively, you can download pre-compiled binaries from the [releases](https:
 
 <InstallNitric>
 
-```bash {{ title: 'macOS' }}
+```bash !!tabs macOS
 brew upgrade nitric
 ```
 
-```bash {{ title: 'Windows' }}
+```bash !!tabs Windows
 scoop update nitric
 ```
 
-```bash {{ title: 'Linux' }}
+```bash !!tabs Linux
 curl -L "https://nitric.io/install?version=latest" | bash
 ```