docs: Migrate docs to starlight (#16)

Author: Pringled

.github/workflows/deploy.yml

@@ -0,0 +1,35 @@
+name: Deploy to GitHub Pages
+
+on:
+  push:
+    branches: [main]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: pages
+  cancel-in-progress: true
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v5
+      - name: Install, build, and upload site
+        uses: withastro/action@v5
+
+  deploy:
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -1 +1,4 @@
-.DS_Store
+.DS_Store
+node_modules/
+dist/
+.astro/

README.md

@@ -1,32 +1,33 @@
-# Mintlify Starter Kit
+# Minish Docs
 
-Click on `Use this template` to copy the Mintlify starter kit. The starter kit contains examples including
+This repository contains the Minish documentation site, built with Astro and Starlight.
 
-- Guide pages
-- Navigation
-- Customizations
-- API Reference pages
-- Use of popular components
+## Development
 
-### Development
+Install dependencies:
 
-Install the [Mintlify CLI](https://www.npmjs.com/package/mintlify) to preview the documentation changes locally. To install, use the following command
-
-```
-npm i -g mintlify
+```bash
+npm install
 ```
 
-Run the following command at the root of your documentation (where docs.json is)
+Start the local development server:
 
+```bash
+npm run dev
 ```
-mintlify dev
+
+Build the site:
+
+```bash
+npm run build
 ```
 
-### Publishing Changes
+Preview the production build locally:
 
-Install our Github App to auto propagate changes from your repo to your deployment. Changes will be deployed to production automatically after pushing to the default branch. Find the link to install on your dashboard. 
+```bash
+npm run preview
+```
 
-#### Troubleshooting
+## Deployment
 
-- Mintlify dev isn't running - Run `mintlify install` it'll re-install dependencies.
-- Page loads as a 404 - Make sure you are running in a folder with `docs.json`
+The site is deployed with GitHub Pages via GitHub Actions on pushes to `main`.

astro.config.mjs

@@ -0,0 +1,100 @@
+import { defineConfig } from 'astro/config';
+import starlight from '@astrojs/starlight';
+import starlightBlog from 'starlight-blog';
+import remarkMath from 'remark-math';
+import rehypeKatex from 'rehype-katex';
+
+export default defineConfig({
+  site: 'https://minish.ai',
+  redirects: {
+    '/packages': '/packages/overview/',
+  },
+  integrations: [
+    starlight({
+      title: 'Minish',
+      components: {
+        Header: './src/components/Header.astro',
+      },
+      description: 'Fast open-source NLP models and packages',
+      logo: {
+        light: '/logo/minish_logo_lighter.png',
+        dark: '/logo/minish_logo_lighter.png',
+        replacesTitle: false,
+      },
+      favicon: '/logo/minish_logo.png',
+      customCss: ['./src/styles/custom.css'],
+      social: [
+        { icon: 'github', label: 'GitHub', href: 'https://github.com/minishlab' },
+        { icon: 'linkedin', label: 'LinkedIn', href: 'https://linkedin.com/company/minish-lab' },
+        { icon: 'x.com', label: 'X', href: 'https://x.com/minishlab' },
+        { icon: 'discord', label: 'Discord', href: 'https://discord.gg/4BDPR5nmtK' },
+      ],
+      plugins: [
+        starlightBlog({
+          title: 'Blog',
+          authors: {
+            minish: { name: 'Minish Lab', url: 'https://minish.ai' },
+          },
+        }),
+      ],
+      sidebar: [
+        {
+          label: 'Packages',
+          items: [
+            { label: 'Overview', link: '/packages/overview/' },
+            {
+              label: 'Model2Vec',
+              items: [
+                { label: 'Introduction',  link: '/packages/model2vec/introduction/' },
+                { label: 'Installation',  link: '/packages/model2vec/installation/' },
+                { label: 'Inference',     link: '/packages/model2vec/inference/' },
+                { label: 'Distillation',  link: '/packages/model2vec/distillation/' },
+                { label: 'Training',      link: '/packages/model2vec/training/' },
+                { label: 'Models',        link: '/packages/model2vec/models/' },
+                { label: 'Results',       link: '/packages/model2vec/results/' },
+                { label: 'Integrations',  link: '/packages/model2vec/integrations/' },
+              ],
+            },
+            {
+              label: 'SemHash',
+              items: [
+                { label: 'Introduction',            link: '/packages/semhash/introduction/' },
+                { label: 'Installation',            link: '/packages/semhash/installation/' },
+                { label: 'Deduplication',           link: '/packages/semhash/deduplication/' },
+                { label: 'Outlier Filtering',       link: '/packages/semhash/outlier-filtering/' },
+                { label: 'Representative Sampling', link: '/packages/semhash/representative-sampling/' },
+                { label: 'Benchmarks',              link: '/packages/semhash/benchmarks/' },
+                { label: 'Custom Encoders',         link: '/packages/semhash/custom-encoders/' },
+              ],
+            },
+            {
+              label: 'Vicinity',
+              items: [
+                { label: 'Introduction',       link: '/packages/vicinity/introduction/' },
+                { label: 'Installation',       link: '/packages/vicinity/installation/' },
+                { label: 'Usage',              link: '/packages/vicinity/usage/' },
+                { label: 'Supported Backends', link: '/packages/vicinity/supported-backends/' },
+              ],
+            },
+            {
+              label: 'Tokenlearn',
+              items: [
+                { label: 'Usage', link: '/packages/tokenlearn/usage/' },
+              ],
+            },
+            {
+              label: 'Model2Vec-rs',
+              items: [
+                { label: 'Usage', link: '/packages/model2vec-rs/usage/' },
+              ],
+            },
+          ],
+        },
+      ],
+    }),
+  ],
+  markdown: {
+    remarkPlugins: [remarkMath],
+    rehypePlugins: [rehypeKatex],
+  },
+});