From ca64e55875577593218c6cf81f1457bfc755ae64 Mon Sep 17 00:00:00 2001
From: Copple <10214025+kiwicopple@users.noreply.github.com>
Date: Thu, 20 Jul 2023 10:14:01 -0700
Subject: [PATCH] adds some mkdocs (#198)

* adds some mkdocs

* more edits
---
 docs/index.md | 35 +++++++++++++++++++++++++++++++++++
 mkdocs.yaml   | 33 +++++++++++++++++++++++++++++++++
 2 files changed, 68 insertions(+)
 create mode 100644 docs/index.md
 create mode 100644 mkdocs.yaml

diff --git a/docs/index.md b/docs/index.md
new file mode 100644
index 0000000..ef368ad
--- /dev/null
+++ b/docs/index.md
@@ -0,0 +1,35 @@
+# `supabase-github-action`
+
+The Supabase GitHub Action provides an easy way to use the Supabase CLI on GitHub's hosted Actions runners.
+
+The action can be run on `ubuntu-latest`, `windows-latest`, and `macos-latest` GitHub Actions runners, and will install and expose a specified version of the Supabase CLI on the runner environment.
+
+## Quick start
+
+This example shows how you can use the Supabase GitHub Action to test your migrations on every Pull Request.
+
+Inside your repository, create a new file inside the `.github/workflows` folder called `test-migrations.yml`.
+
+Copy this snippet inside the file, and the action will run whenever a new PR is created:
+
+```yaml
+name: 'test-migrations'
+on:
+  pull_request:
+
+jobs:
+  build: 
+    runs-on: ubuntu-latest
+    steps:
+        - uses: supabase/setup-cli@v1
+            with:
+            version: latest
+        - run: supabase init
+        - run: supabase db start
+```
+
+
+## Resources
+
+- **Source Code**: <a href="https://github.com/supabase/supabase-github-action" target="_blank">github.com/supabase/supabase-github-action</a>
+- **CLI Documentation**: <a href="https://supabase.com/docs/guides/cli" target="_blank">supabase.com/docs/guides/cli</a>
\ No newline at end of file
diff --git a/mkdocs.yaml b/mkdocs.yaml
new file mode 100644
index 0000000..c8bf429
--- /dev/null
+++ b/mkdocs.yaml
@@ -0,0 +1,33 @@
+site_name: supabase-github-action
+site_url: https://supabase.github.io/supabase-github-action
+site_description: A GitHub action for interacting with your Supabase projects using the CLI. 
+
+repo_name: supabase/supabase-github-action
+repo_url: https://github.com/supabase/supabase-github-action
+
+nav:
+    - Welcome: 'index.md'
+
+theme:
+    name: 'material'
+    features:
+      - navigation.expand
+    favicon: 'assets/favicon.ico'
+    logo: 'assets/favicon.ico'
+    homepage: https://supabase.github.io/supabase-github-action
+    palette:
+        primary: black
+        accent: light green
+
+markdown_extensions:
+    - pymdownx.highlight:
+        linenums: true
+        guess_lang: false
+        use_pygments: true
+        pygments_style: default
+    - pymdownx.superfences
+    - pymdownx.tabbed:
+        alternate_style: true
+    - pymdownx.snippets
+    - pymdownx.tasklist
+    - admonition
\ No newline at end of file