init mdbook

CryptKeeperZK · Aug 21, 2023 · 332b376 · 332b376
1 parent 5acbe75
commit 332b376
Show file tree

Hide file tree

Showing 16 changed files with 57 additions and 31 deletions.
diff --git a/.github/workflows/gh-pages.yml b/.github/workflows/gh-pages.yml
@@ -0,0 +1,33 @@
+name: github pages
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  deploy:
+    runs-on: ubuntu-20.04
+    concurrency:
+      group: ${{ github.workflow }}-${{ github.ref }}
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Install cargo-sort from git
+        uses: baptiste0928/cargo-install@v2
+        with:
+          crate: book-summary
+      - run: book-summary -n ./src -s cryptkeeper guides references -y
+
+      - name: Setup mdBook
+        uses: peaceiris/actions-mdbook@v1
+        with:
+          mdbook-version: 'latest'
+      - run: mdbook build
+
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v3
+        if: ${{ github.ref == 'refs/heads/main' }}
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./book
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1 @@
+book
diff --git a/book.toml b/book.toml
@@ -0,0 +1,6 @@
+[book]
+authors = ["AtHeartEngineer", "0xIsk", "0xmad"]
+language = "en"
+multilingual = false
+src = "src"
+title = "CryptKeeper Documentation"
diff --git a/guides/integrating-cryptkeeper/README.md b/guides/integrating-cryptkeeper/README.md
diff --git a/src/# b/src/#
@@ -0,0 +1 @@
+# References
diff --git a/src/SUMMARY.md b/src/SUMMARY.md
@@ -0,0 +1,16 @@
+# Summary
+
+- [Cryptkeeper](#)
+    - [Features](cryptkeeper/features.md)
+    - [Overview](cryptkeeper/overview.md)
+- [Guides](#)
+    - [Contributing](guides/contributing.md)
+    - [Integration](#)
+        - [Connect to Extension](guides/integration/connect-to-extension.md)
+        - [Create Identity](guides/integration/create-identity.md)
+        - [Generate Proof](guides/integration/generate-proof.md)
+        - [Inject Client](guides/integration/inject-client.md)
+        - [Zkitter Examples](guides/integration/zkitter-examples.md)
+- [References](#)
+    - [Faq](references/faq.md)
+    - [Terms](references/terms.md)
diff --git a/what-is-cryptkeeper/features.md → src/cryptkeeper/features.md b/what-is-cryptkeeper/features.md → src/cryptkeeper/features.md
diff --git a/what-is-cryptkeeper/overview.md → src/cryptkeeper/overview.md b/what-is-cryptkeeper/overview.md → src/cryptkeeper/overview.md
diff --git a/guides/quick-setup.md → src/guides/contributing.md b/guides/quick-setup.md → src/guides/contributing.md
diff --git a/...ating-cryptkeeper/connect-to-extension.md → ...uides/integration/connect-to-extension.md b/...ating-cryptkeeper/connect-to-extension.md → ...uides/integration/connect-to-extension.md
diff --git a/...ntegrating-cryptkeeper/create-identity.md → src/guides/integration/create-identity.md b/...ntegrating-cryptkeeper/create-identity.md → src/guides/integration/create-identity.md
diff --git a/...integrating-cryptkeeper/generate-proof.md → src/guides/integration/generate-proof.md b/...integrating-cryptkeeper/generate-proof.md → src/guides/integration/generate-proof.md
diff --git a/.../integrating-cryptkeeper/inject-client.md → src/guides/integration/inject-client.md b/.../integrating-cryptkeeper/inject-client.md → src/guides/integration/inject-client.md
diff --git a/...tegrating-cryptkeeper/zkitter-examples.md → src/guides/integration/zkitter-examples.md b/...tegrating-cryptkeeper/zkitter-examples.md → src/guides/integration/zkitter-examples.md
diff --git a/references/faq.md → src/references/faq.md b/references/faq.md → src/references/faq.md
diff --git a/references/terms.md → src/references/terms.md b/references/terms.md → src/references/terms.md