feat: migrate to docusaurus

.github/workflows/deploy-preview.yml

@@ -0,0 +1,21 @@
+name: Deploy Docusaurus
+on:
+  pull_request:
+    branches: [main]
+permissions:
+  contents: write
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: "18"
+      - run: npm ci
+      - run: npm run build
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v4
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./build

.gitignore

@@ -1 +1,21 @@
-node_modules
+# Dependencies
+/node_modules
+yarn.lock
+
+# 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*

README.md

@@ -1,34 +1,40 @@
-# Mintlify Starter Kit
+# Template
 
-Click on `Use this template` to copy the Mintlify starter kit. The starter kit contains examples including
+This template is built for [Docusaurus 3](https://docusaurus.io/), a modern static website generator.
 
-- Guide pages
-- Navigation
-- Customizations
-- API Reference pages
-- Use of popular components
+### Usage
 
-### 👩‍💻 Development
+```bash
+npx create-docusaurus@3.5.2 my-website --package-manager yarn
+```
 
-Install the [Mintlify CLI](https://www.npmjs.com/package/mintlify) to preview the documentation changes locally. To install, use the following command
+> When prompted to select a template choose `Git repository`.
 
-```
-npm i -g mintlify
+Template Repository URL:
+
+```bash
+https://github.com/PaloAltoNetworks/docusaurus-template-openapi-docs.git
 ```
 
-Run the following command at the root of your documentation (where mint.json is)
+> When asked how the template repo should be cloned choose "copy" (unless you know better).
 
-```
-mintlify dev
+```bash
+cd my-website
+yarn
 ```
 
-### 😎 Publishing Changes
+### Local Development
 
-Changes will be deployed to production automatically after pushing to the default branch.
+```bash
+yarn 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.
 
-You can also preview changes using PRs, which generates a preview link of the docs.
+### Build
 
-#### Troubleshooting
+```bash
+yarn build
+```
 
-- 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 `mint.json`
+This command generates static content into the `build` directory and can be served using any static contents hosting service.