wip

Author: davemooreuws

.gitignore

@@ -23,10 +23,15 @@
 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

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,59 @@
+import { defineDocumentType, makeSource } from 'contentlayer2/source-files'
+import { extractTocHeadings } from './src/mdx/remark-toc-headings.mjs'
+import { title } from 'radash'
+
+const contentDirPath = 'docs'
+
+const Docs = defineDocumentType(() => ({
+  name: 'Docs',
+  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,
+    },
+    seoTitle: {
+      type: 'string',
+      resolve: (doc) =>
+        doc._raw.flattenedPath
+          ? doc._raw.flattenedPath
+              .split('/')
+              .slice(-2)
+              .map((p) => title(p))
+              .join(': ')
+          : 'Welcome to Nitric Docs',
+    },
+    toc: { type: 'json', resolve: (doc) => extractTocHeadings(doc.body.raw) },
+  },
+}))
+
+export default makeSource({
+  contentDirPath,
+  documentTypes: [Docs],
+})

docs/getting-started/installation.mdx

@@ -0,0 +1,73 @@
+export const description =
+  'Basic installation instructions for the Nitric Framework'
+
+# Installation
+
+## Prerequisites
+
+Nitric relies on functionality from the following projects to help retrieve plugins, containerize and deploy your application.
+
+Please follow these links to the official installation steps for each.
+
+- [Git](https://git-scm.com/)
+- [Docker](https://docs.docker.com/get-docker/)
+- [Docker Buildx](https://github.com/docker/buildx/)
+- [Pulumi](https://www.pulumi.com/docs/cli/) _(for deployments, only needed if using the default providers)_
+
+<Note>
+  When setting up docker on Linux be sure to follow the [post-installation
+  steps](https://docs.docker.com/engine/install/linux-postinstall/) so you can
+  run docker as a non-root user.
+</Note>
+
+## Installing the Nitric CLI
+
+<InstallNitric>
+
+```bash !!tabs macOS
+brew install nitrictech/tap/nitric
+```
+
+```bash !!tabs Windows
+scoop bucket add nitric https://github.com/nitrictech/scoop-bucket.git
+scoop install nitric
+```
+
+```bash !!tabs Linux
+curl -L "https://nitric.io/install?version=latest" | bash
+```
+
+</InstallNitric>
+
+### Manual Install
+
+Alternatively, you can download pre-compiled binaries from the [releases](https://github.com/nitrictech/cli/releases) page and install them manually.
+
+## Update to the latest version
+
+<InstallNitric>
+
+```bash !!tabs macOS
+brew upgrade nitric
+```
+
+```bash !!tabs Windows
+scoop update nitric
+```
+
+```bash !!tabs Linux
+curl -L "https://nitric.io/install?version=latest" | bash
+```
+
+</InstallNitric>
+
+You can easily check which version you're on by running `nitric version`.
+
+## Release notes
+
+You can view the CLI release notes on our [CLI GitHub Releases page](https://github.com/nitrictech/cli/releases).
+
+## What's next
+
+- Checkout out our [concepts](/concepts/introduction) page for a quick overview of Nitric.
+- Start building with our [quickstart guide](./quickstart).