Merge pull request #1 from AbdelStark/feature/nuts-pages

Feature/nuts pages
cashubtc · Sep 18, 2024 · 23a5e4a · 23a5e4a
2 parents 8f0c6de + 059b2f7
commit 23a5e4a
Show file tree

Hide file tree

Showing 31 changed files with 92 additions and 0 deletions.
diff --git a/.github/workflows/pages.yml b/.github/workflows/pages.yml
@@ -0,0 +1,31 @@
+name: Deploy MkDocs Site to GitHub Pages
+
+on:
+  push:
+    branches:
+      - main
+
+permissions: write-all
+
+jobs:
+  build-deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.x"
+
+      - name: Install Dependencies
+        run: pip install -r requirements.txt
+
+      - name: Build the Site
+        run: mkdocs build --clean
+
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./site
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,3 @@
+**/node_modules
+dist/
+site/
diff --git a/00.md → docs/00.md b/00.md → docs/00.md
diff --git a/01.md → docs/01.md b/01.md → docs/01.md
diff --git a/02.md → docs/02.md b/02.md → docs/02.md
diff --git a/03.md → docs/03.md b/03.md → docs/03.md
diff --git a/04.md → docs/04.md b/04.md → docs/04.md
diff --git a/05.md → docs/05.md b/05.md → docs/05.md
diff --git a/06.md → docs/06.md b/06.md → docs/06.md
diff --git a/07.md → docs/07.md b/07.md → docs/07.md
diff --git a/08.md → docs/08.md b/08.md → docs/08.md
diff --git a/09.md → docs/09.md b/09.md → docs/09.md
diff --git a/10.md → docs/10.md b/10.md → docs/10.md
diff --git a/11.md → docs/11.md b/11.md → docs/11.md
diff --git a/12.md → docs/12.md b/12.md → docs/12.md
diff --git a/13.md → docs/13.md b/13.md → docs/13.md
diff --git a/14.md → docs/14.md b/14.md → docs/14.md
diff --git a/15.md → docs/15.md b/15.md → docs/15.md
diff --git a/16.md → docs/16.md b/16.md → docs/16.md
diff --git a/17.md → docs/17.md b/17.md → docs/17.md
diff --git a/README.md → docs/README.md b/README.md → docs/README.md
diff --git a/error_codes.md → docs/error_codes.md b/error_codes.md → docs/error_codes.md
diff --git a/tests/00-tests.md → docs/tests/00-tests.md b/tests/00-tests.md → docs/tests/00-tests.md
diff --git a/tests/01-tests.md → docs/tests/01-tests.md b/tests/01-tests.md → docs/tests/01-tests.md
diff --git a/tests/02-tests.md → docs/tests/02-tests.md b/tests/02-tests.md → docs/tests/02-tests.md
diff --git a/tests/11-test.md → docs/tests/11-test.md b/tests/11-test.md → docs/tests/11-test.md
diff --git a/tests/12-tests.md → docs/tests/12-tests.md b/tests/12-tests.md → docs/tests/12-tests.md
diff --git a/tests/13-tests.md → docs/tests/13-tests.md b/tests/13-tests.md → docs/tests/13-tests.md
diff --git a/tests/README.md → docs/tests/README.md b/tests/README.md → docs/tests/README.md
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -0,0 +1,54 @@
+site_name: Cashu NUTs Specifications
+site_url: https://cashubtc.github.io/nuts/
+theme:
+  name: material
+  features:
+    - navigation.expand
+    - navigation.sections
+    - navigation.top
+    - search.highlight
+    - search.share
+    - toc.integrate
+    - content.code.copy
+    - content.tabs.link
+    - announce.dismiss
+  palette:
+    - scheme: default
+      primary: indigo
+      accent: indigo
+  icon:
+    logo: material/hand-coin
+nav:
+  - Home: README.md
+  - NUTs:
+      - Mandatory:
+          - NUT-00: 00.md
+          - NUT-01: 01.md
+          - NUT-02: 02.md
+          - NUT-03: 03.md
+          - NUT-04: 04.md
+          - NUT-05: 05.md
+          - NUT-06: 06.md
+          # Add more mandatory NUTs here
+      - Optional:
+          - NUT-07: 07.md
+          - NUT-08: 08.md
+          - NUT-09: 09.md
+          - NUT-10: 10.md
+          - NUT-11: 11.md
+          - NUT-12: 12.md
+          - NUT-13: 13.md
+          - NUT-14: 14.md
+          - NUT-15: 15.md
+          - NUT-16: 16.md
+          - NUT-17: 17.md
+          # Add more optional NUTs here
+plugins:
+  - search
+  - macros
+  - section-index
+markdown_extensions:
+  - admonition
+  - codehilite
+  - toc:
+      permalink: true
diff --git a/requirements.txt b/requirements.txt
@@ -0,0 +1,4 @@
+mkdocs
+mkdocs-material
+mkdocs-macros-plugin
+mkdocs-section-index