Add mdbook github action

danhper · Jul 8, 2024 · 68abfe7 · 68abfe7
1 parent 816e1e3
commit 68abfe7
Show file tree

Hide file tree

Showing 8 changed files with 51 additions and 0 deletions.
diff --git a/.github/workflows/pages.yml b/.github/workflows/pages.yml
@@ -0,0 +1,31 @@
+name: GitHub pages
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+permissions:
+  contents: write
+
+jobs:
+  deploy:
+    runs-on: ubuntu-20.04
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Setup mdBook
+        uses: peaceiris/actions-mdbook@v2
+        with:
+          mdbook-version: "latest"
+
+      - name: Build book
+        run: cd docs && mdbook build
+
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v3
+        if: ${{ github.ref == 'refs/heads/main' }}
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./docs/book
diff --git a/docs/.gitignore b/docs/.gitignore
@@ -0,0 +1 @@
+book
diff --git a/docs/book.toml b/docs/book.toml
@@ -0,0 +1,7 @@
+[book]
+authors = ["Daniel Perez"]
+language = "en"
+multilingual = false
+src = "src"
+title = "Eclair Documentation"
+description = "Eclair: a Solidity Interpreter"
diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md
@@ -0,0 +1,10 @@
+# Summary
+
+[Overview](./overview.md)
+
+# Getting Started
+
+- [Installation](./installation.md)
+- [Configuration](./configuration.md.md)
+
+# Reference
diff --git a/docs/src/configuration.md b/docs/src/configuration.md
diff --git a/docs/src/configuration.md.md b/docs/src/configuration.md.md
@@ -0,0 +1 @@
+# Configuration
diff --git a/docs/src/installation.md b/docs/src/installation.md
@@ -0,0 +1 @@
+# Installation
diff --git a/docs/src/overview.md b/docs/src/overview.md