Merge pull request #1 from matzemathics/main

Basic project structure

Author: monsterkrampe

.github/workflows/ci.yml

@@ -0,0 +1,39 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Build
+        run: npm run build
+
+      - name: Upload
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: dist/nemo-doc
+
+  deploy:
+    needs: build
+    permissions:
+      contents: read
+      pages: write
+      id-token: write
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{steps.deployment.outputs.page_url}}
+    steps:
+      - name: Deploy artifact
+        id: deployment
+        uses: actions/deploy-pages@v4

.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
+
+# vscode
+.vscode/

README.md

@@ -1,5 +1,20 @@
 # Nemo Documentation
 
-The documentation of the [Nemo rule engine](https://github.com/knowsys/nemo) will soon move to this location.
+The documentation of the [Nemo rule engine](https://github.com/knowsys/nemo) is in the process of being built in this repository.
 
 For now, you can find the documentation in the [Nemo wiki pages](https://github.com/knowsys/nemo/wiki).
+
+[![Built with Starlight](https://astro.badg.es/v2/built-with-starlight/tiny.svg)](https://starlight.astro.build)
+
+## 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                     |

astro.config.mjs

@@ -0,0 +1,35 @@
+import { defineConfig } from 'astro/config';
+import starlight from '@astrojs/starlight';
+
+// https://astro.build/config
+export default defineConfig({
+  site: 'https://knowsys.github.io/',
+  base: '/nemo-doc',
+  outDir: './dist/nemo-doc',
+
+  integrations: [
+    starlight({
+      title: 'Nemo Rule Engine',
+      social: {
+        github: 'https://github.com/knowsys/nemo',
+      },
+      sidebar: [
+        {
+          label: 'Guides',
+          items: [
+            // Each item here is one entry in the navigation menu.
+            { label: 'Installing', slug: 'guides/installing' },
+            { label: 'Command Line', slug: 'guides/cli' },
+            { label: 'Rule Language', slug: 'guides/tour' },
+            { label: 'Broser Integration', slug: 'guides/wasm' },
+            { label: 'Python API', slug: 'guides/python' },
+          ],
+        },
+        {
+          label: 'Language Reference',
+          autogenerate: { directory: 'reference' },
+        },
+      ],
+    }),
+  ],
+});