Switch docs to Docusaurus (#134)

* Switch to using docusaurus

* Tweak action to deploy

* remove cache

* update links

* spicepod -> pod

* pod -> spicepod

* Remove unlisted

* update readme

* Fix getting started link

Author: phillipleblanc

.github/workflows/build_and_publish.yml

@@ -8,35 +8,33 @@ on:
       - v*
   pull_request:
 
+permissions:
+  contents: write
+
 jobs:
   deploy:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
         with:
-          submodules: recursive # Fetch Hugo themes (true OR recursive)
-          fetch-depth: 0 # Fetch all history for .GitInfo and .Lastmod
+          fetch-depth: 0
 
-      - name: Setup Hugo
-        uses: peaceiris/actions-hugo@v2
+      - uses: actions/setup-node@v4
         with:
-          hugo-version: "0.123.8"
-          extended: true
+          node-version: 20
 
-      - name: Install requirements
+      - name: Install dependencies
         working-directory: spiceaidocs
-        run: |
-          npm install
-          cd themes/docsy && npm install
+        run: npm install
 
-      - name: Build
+      - name: Build website
         working-directory: spiceaidocs
-        run: hugo --minify
+        run: npm run build
 
       - name: Deploy
         if: ${{ github.event_name != 'pull_request' && startswith(github.ref, 'refs/tags/v') }}
         uses: peaceiris/actions-gh-pages@v3
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
-          publish_dir: ./spiceaidocs/public
+          publish_dir: ./spiceaidocs/build
           cname: docs.spiceai.org

README.md

@@ -8,14 +8,14 @@ This repo contains the markdown files which generate the above website. See belo
 
 ## Overview
 
-The Spice.ai docs are built using [Hugo](https://gohugo.io/) with the [Docsy](https://docsy.dev) theme, hosted on [GitHub Pages](https://pages.github.com/).
+The Spice.ai docs are built using [Docusaurus](https://docusaurus.io/) hosted on [GitHub Pages](https://pages.github.com/).
 
-The [spiceaidocs](./spiceaidocs) directory contains the hugo project, markdown files, and theme configurations.
+The [spiceaidocs](./spiceaidocs) directory contains the Docusaurus project, markdown files, and theme configurations.
 
 ## Pre-requisites
 
-- [Hugo extended version](https://gohugo.io/getting-started/installing)
 - [Node.js](https://nodejs.org/en/)
+- [Docusaurus](https://docusaurus.io/docs/installation)
 
 ## Environment setup
 
@@ -32,17 +32,10 @@ git clone https://github.com/spiceai/docs.git
 cd ./docs/spiceaidocs
 ```
 
-4. Update submodules:
-
-```sh
-git submodule update --init --recursive
-```
-
-5. Install npm packages:
+4. Install npm packages:
 
 ```sh
 npm install
-cd themes/docsy && npm install
 ```
 
 ## Run local server
@@ -51,10 +44,10 @@ cd themes/docsy && npm install
 2. Run
 
 ```sh
-hugo server
+npm start
 ```
 
-3. Navigate to `http://localhost:1313/`
+3. Navigate to `http://localhost:3000/`
 
 ## Update docs
 

spiceaidocs/.gitignore

@@ -0,0 +1,20 @@
+# Dependencies
+/node_modules
+
+# Production
+/build
+
+# Generated files
+.docusaurus
+.cache-loader
+
+# Misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

spiceaidocs/README.md

@@ -0,0 +1,25 @@
+# Website
+
+This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
+
+### Installation
+
+```
+$ npm install
+```
+
+### Local Development
+
+```
+$ npm start
+```
+
+This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
+
+### Build
+
+```
+$ npm run build
+```
+
+This command generates static content into the `build` directory and can be served using any static contents hosting service.

spiceaidocs/archetypes/default.md

@@ -0,0 +1,3 @@
+module.exports = {
+  presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
+};