docs(misc): add base astro setup for docs (#32058)

Add the base docs website built with Astro.

---------

Co-authored-by: Caleb Ukle <caleb@nrwl.io>

Author: jaysoo

.gitignore

@@ -108,3 +108,4 @@ tasks/
 # Upstream docs local configuration (machine-specific)
 .upstreamdocs.local.json
 
+astro-docs/.netlify

astro-docs/.gitignore

@@ -0,0 +1,24 @@
+# build output
+dist/
+# generated types
+.astro/
+
+# dependencies
+node_modules/
+
+# logs
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+
+
+# environment variables
+.env
+.env.production
+
+# macOS-specific files
+.DS_Store
+
+# Local Netlify folder
+.netlify

astro-docs/README.md

@@ -0,0 +1,54 @@
+# Starlight Starter Kit: Basics
+
+[![Built with Starlight](https://astro.badg.es/v2/built-with-starlight/tiny.svg)](https://starlight.astro.build)
+
+```
+pnpm create astro@latest -- --template starlight
+```
+
+[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/starlight/tree/main/examples/basics)
+[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/starlight/tree/main/examples/basics)
+[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/withastro/starlight&create_from_path=examples/basics)
+[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fwithastro%2Fstarlight%2Ftree%2Fmain%2Fexamples%2Fbasics&project-name=my-starlight-docs&repository-name=my-starlight-docs)
+
+> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
+
+## 🚀 Project Structure
+
+Inside of your Astro + Starlight project, you'll see the following folders and files:
+
+```
+.
+├── public/
+├── src/
+│   ├── assets/
+│   ├── content/
+│   │   ├── docs/
+│   └── content.config.ts
+├── astro.config.mjs
+├── package.json
+└── tsconfig.json
+```
+
+Starlight looks for `.md` or `.mdx` files in the `src/content/docs/` directory. Each file is exposed as a route based on its file name.
+
+Images can be added to `src/assets/` and embedded in Markdown with a relative link.
+
+Static assets, like favicons, can be placed in the `public/` directory.
+
+## 🧞 Commands
+
+All commands are run from the root of the project, from a terminal:
+
+| Command                | Action                                           |
+| :--------------------- | :----------------------------------------------- |
+| `pnpm install`         | Installs dependencies                            |
+| `pnpm dev`             | Starts local dev server at `localhost:4321`      |
+| `pnpm build`           | Build your production site to `./dist/`          |
+| `pnpm preview`         | Preview your build locally, before deploying     |
+| `pnpm astro ...`       | Run CLI commands like `astro add`, `astro check` |
+| `pnpm astro -- --help` | Get help using the Astro CLI                     |
+
+## 👀 Want to learn more?
+
+Check out [Starlight’s docs](https://starlight.astro.build/), read [the Astro documentation](https://docs.astro.build), or jump into the [Astro Discord server](https://astro.build/chat).

astro-docs/astro.config.mjs

@@ -0,0 +1,97 @@
+// @ts-check
+import { defineConfig } from 'astro/config';
+import starlight from '@astrojs/starlight';
+import { sectionSidebarPlugin } from './src/plugins/section-sidebar.plugin';
+import netlify from '@astrojs/netlify';
+import linkValidator from 'starlight-links-validator';
+import react from '@astrojs/react';
+import markdoc from '@astrojs/markdoc';
+
+// https://astro.build/config
+export default defineConfig({
+  integrations: [
+    markdoc(),
+    starlight({
+      title: 'Nx',
+      tagline:
+        'An AI-first build platform that connects everything from your editor to CI. Helping you deliver fast, without breaking things.',
+      favicon: '/favicon.svg',
+      logo: {
+        src: './src/assets/nx/Nx-light.png',
+        replacesTitle: true,
+      },
+      plugins: [
+        // linkValidator(),
+        sectionSidebarPlugin(),
+      ],
+      routeMiddleware: ['./src/plugins/banner.middleware.ts'],
+      markdown: {
+        // this breaks the renderMarkdown function in the plugin loader due to starlight path normalization
+        // as to _why_ it has to normalize a path?
+        // idk just working around the issue for now but we'll want to have linked headers so will need to fix
+        headingLinks: false,
+      },
+      social: [
+        { icon: 'github', label: 'GitHub', href: 'https://github.com/nrwl/nx' },
+        {
+          icon: 'youtube',
+          label: 'YouTube',
+          href: 'https://www.youtube.com/@NxDevtools?utm_source=nx.dev',
+        },
+        {
+          icon: 'x.com',
+          label: 'X',
+          href: 'https://x.com/NxDevTools?utm_source=nx.dev',
+        },
+        {
+          icon: 'discord',
+          label: 'Discord',
+          href: 'https://go.nx.dev/community',
+        },
+      ],
+      editLink: {
+        baseUrl: 'https://github.com/nrwl/nx/tree/main/',
+      },
+      customCss: ['./src/styles/custom.css'],
+      sidebar: [
+        {
+          label: 'Getting Started',
+          autogenerate: { directory: 'getting-started' },
+        },
+        {
+          label: 'Guides',
+          autogenerate: { directory: 'guides' },
+        },
+        {
+          label: 'Concepts',
+          autogenerate: { directory: 'concepts' },
+        },
+        {
+          label: 'References',
+          collapsed: true,
+          items: [
+            // have to use link bc slug is mapped to the /docs/ folder but we need the astro component in the pages/ dir
+            { label: 'Nx CLI', link: 'api/nx-cli' },
+            { label: 'Nx Cloud CLI', slug: 'api/nx-cloud-cli' },
+            { label: 'create-nx-workspace', link: 'api/create-nx-workspace' },
+            {
+              label: 'devkit',
+              collapsed: true,
+              items: [
+                { label: 'Overview', link: 'api/plugins/devkit/' },
+                {
+                  label: 'Ng CLI Adapter',
+                  link: 'api/plugins/devkit/ngcli_adapter',
+                },
+              ],
+            },
+            // plugins are autogenerated from the Nx repository via the sidebar plugin
+          ],
+        },
+      ],
+    }),
+    react(),
+  ],
+  site: 'https://docs.nx.dev',
+  adapter: netlify(),
+});

astro-docs/markdoc.config.mjs

@@ -0,0 +1,29 @@
+import { defineMarkdocConfig, component } from '@astrojs/markdoc/config';
+import starlightMarkdoc from '@astrojs/starlight-markdoc';
+
+export default defineMarkdocConfig({
+  extends: [starlightMarkdoc()],
+  tags: {
+    youtube: {
+      render: component('./src/components/Youtube.astro'),
+      attributes: {
+        src: {
+          type: 'String',
+          required: true,
+        },
+        title: {
+          type: 'String',
+          required: true,
+        },
+        width: {
+          type: 'String',
+          default: '100%',
+        },
+        caption: {
+          type: 'String',
+          required: false,
+        },
+      },
+    },
+  },
+});

astro-docs/package.json

@@ -0,0 +1,14 @@
+{
+  "name": "astro-docs",
+  "version": "0.0.1",
+  "private": true,
+  "dependencies": {
+    "astro": "^5.10.1",
+    "@astrojs/markdoc": "^0.15.0",
+    "@astrojs/netlify": "^6.4.0",
+    "@astrojs/starlight": "0.34.6",
+    "@astrojs/starlight-markdoc": "^0.4.0",
+    "@astrojs/check": "^0.7.0",
+    "@astrojs/react": "^4.3.0"
+  }
+}

astro-docs/project.json

@@ -0,0 +1,37 @@
+{
+  "name": "astro-docs",
+  "targets": {
+    "comment": "package.json#scripts runs in the project root directory with astro assumes is where the node_modules is. which fails. so run the scripts in project.json#targets with --root command instead",
+    "serve": {
+      "continuous": true,
+      "dependsOn": [
+        {
+          "projects": ["devkit", "create-nx-workspace"],
+          "target": "build"
+        }
+      ],
+      "command": "astro dev",
+      "options": {
+        "cwd": "astro-docs"
+      }
+    },
+    "build": {
+      "dependsOn": [
+        {
+          "projects": ["devkit", "create-nx-workspace"],
+          "target": "build"
+        }
+      ],
+      "command": "astro build",
+      "options": {
+        "cwd": "astro-docs"
+      }
+    },
+    "astro": {
+      "command": "astro",
+      "options": {
+        "cwd": "astro-docs"
+      }
+    }
+  }
+}