docs: add documentation site by astro (#29)

* docs: add documentation site by astro

closes #10

* Update docs/src/content/docs/getting-started/introduction.md

Co-authored-by: Enea Jahollari <jahollarienea14@gmail.com>

* docs: add documentation site by astro

closes #10

---------

Co-authored-by: Enea Jahollari <jahollarienea14@gmail.com>

.github/workflows/ci.yml

@@ -14,14 +14,15 @@ jobs:
       main-branch-name: main
       number-of-agents: 3
       init-commands: |
+        pnpm --filter docs install
         pnpm exec nx-cloud start-ci-run --stop-agents-after="build" --agent-count=3
       parallel-commands: |
         pnpm exec nx-cloud record -- pnpm exec nx format:check
       parallel-commands-on-agents: |
         pnpm exec nx affected --target=lint --parallel=3
         pnpm exec nx affected --target=test --parallel=3 --ci --code-coverage
         # pnpm exec nx affected --target=e2e --parallel=3 --ci
-        pnpm exec nx affected --target=build --parallel=3
+        pnpm exec nx affected --target=build --parallel=3 --exclude=docs
 
   agents:
     name: Nx Cloud - Agents

.github/workflows/docusaurus.yml

@@ -0,0 +1,51 @@
+name: Astro Docs Site
+
+on:
+  push:
+    branches: [main]
+
+jobs:
+  build-docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          persist-credentials: false
+          fetch-depth: 0
+
+      - uses: pnpm/action-setup@v2
+        with:
+          version: latest
+          run_install: false
+
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 20
+          cache: 'pnpm'
+
+      - name: Install dependencies
+        run: |
+          pnpm install --no-frozen-lockfile
+          pnpm --filter "docs" install --no-frozen-lockfile
+
+      - name: Create local build artifacts
+        run: |
+          echo "Building documentation..."
+          pnpm exec nx build docs
+
+      - name: Init git and commit local artifacts
+        run: |
+          cd docs/dist
+          git init
+          git add .
+          git config --local user.email "41898282+github-actions[bot]@users.noreply.github.com"
+          git config --local user.name "github-actions[bot]"
+          git commit -am "docs: build doc"
+
+      - name: Push
+        uses: ad-m/github-push-action@master
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          branch: astro-docs
+          force: true
+          directory: docs/dist

docs/.gitignore

@@ -0,0 +1,21 @@
+# 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

docs/.vscode/extensions.json

@@ -0,0 +1,4 @@
+{
+	"recommendations": ["astro-build.astro-vscode"],
+	"unwantedRecommendations": []
+}

docs/.vscode/launch.json

@@ -0,0 +1,11 @@
+{
+	"version": "0.2.0",
+	"configurations": [
+		{
+			"command": "./node_modules/.bin/astro dev",
+			"name": "Development server",
+			"request": "launch",
+			"type": "node-terminal"
+		}
+	]
+}

docs/README.md

@@ -0,0 +1,51 @@
+# Starlight Starter Kit: Basics
+
+```
+npm 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)
+
+> 🧑‍🚀 **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/
+│   │   └── config.ts
+│   └── env.d.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                                           |
+| :------------------------ | :----------------------------------------------- |
+| `npm install`             | Installs dependencies                            |
+| `npm run dev`             | Starts local dev server at `localhost:4321`      |
+| `npm run build`           | Build your production site to `./dist/`          |
+| `npm run preview`         | Preview your build locally, before deploying     |
+| `npm run astro ...`       | Run CLI commands like `astro add`, `astro check` |
+| `npm run 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).

docs/astro.config.mjs

@@ -0,0 +1,37 @@
+import starlight from '@astrojs/starlight';
+import { defineConfig } from 'astro/config';
+
+// https://astro.build/config
+export default defineConfig({
+	integrations: [
+		starlight({
+			title: 'ngxtension',
+			social: {
+				github: 'https://github.com/nartc/ngxtension-platform',
+			},
+			sidebar: [
+				{
+					label: 'Getting Started',
+					items: [
+						// Each item here is one entry in the navigation menu.
+						{ label: 'Introduction', link: '/getting-started/introduction' },
+						{ label: 'Installation', link: '/getting-started/installation' },
+					],
+				},
+				{
+					label: 'Utilities',
+					items: [
+						// Each item here is one entry in the navigation menu.
+						{ label: 'assertInjector', link: '/utilities/assert-injector' },
+						{
+							label: 'createInjectionToken',
+							link: '/utilities/create-injection-token',
+						},
+						{ label: 'repeat', link: '/utilities/repeat' },
+						{ label: 'resize', link: '/utilities/resize' },
+					],
+				},
+			],
+		}),
+	],
+});

docs/package.json

@@ -0,0 +1,17 @@
+{
+	"name": "docs",
+	"type": "module",
+	"version": "0.0.1",
+	"scripts": {
+		"dev": "astro dev",
+		"start": "astro dev",
+		"build": "astro build",
+		"preview": "astro preview",
+		"astro": "astro"
+	},
+	"dependencies": {
+		"@astrojs/starlight": "^0.9.1",
+		"astro": "^3.0.6",
+		"sharp": "^0.32.5"
+	}
+}