mirror of
https://github.com/CryptKeeperZK/Docs.git
synced 2026-01-06 21:53:51 -05:00
init mdbook
This commit is contained in:
33
.github/workflows/gh-pages.yml
vendored
Normal file
33
.github/workflows/gh-pages.yml
vendored
Normal file
@@ -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
|
||||
1
.gitignore
vendored
Normal file
1
.gitignore
vendored
Normal file
@@ -0,0 +1 @@
|
||||
book
|
||||
6
book.toml
Normal file
6
book.toml
Normal file
@@ -0,0 +1,6 @@
|
||||
[book]
|
||||
authors = ["AtHeartEngineer", "0xIsk", "0xmad"]
|
||||
language = "en"
|
||||
multilingual = false
|
||||
src = "src"
|
||||
title = "CryptKeeper Documentation"
|
||||
@@ -1,31 +0,0 @@
|
||||
---
|
||||
description: >-
|
||||
This section will show you how to integrate your dapp with the CryptKeeper
|
||||
extension.
|
||||
---
|
||||
|
||||
# 🧱 Integrating CryptKeeper
|
||||
|
||||
Before you begin, make sure you reviewed the [quick setup guide](../quick-setup.md)
|
||||
|
||||
{% content-ref url="connect-to-extension.md" %}
|
||||
[connect-to-extension.md](connect-to-extension.md)
|
||||
{% endcontent-ref %}
|
||||
|
||||
{% content-ref url="inject-client.md" %}
|
||||
[inject-client.md](inject-client.md)
|
||||
{% endcontent-ref %}
|
||||
|
||||
{% content-ref url="create-identity.md" %}
|
||||
[create-identity.md](create-identity.md)
|
||||
{% endcontent-ref %}
|
||||
|
||||
{% content-ref url="generate-proof.md" %}
|
||||
[generate-proof.md](generate-proof.md)
|
||||
{% endcontent-ref %}
|
||||
|
||||
{% content-ref url="zkitter-examples.md" %}
|
||||
[zkitter-examples.md](zkitter-examples.md)
|
||||
{% endcontent-ref %}
|
||||
|
||||
##
|
||||
16
src/SUMMARY.md
Normal file
16
src/SUMMARY.md
Normal file
@@ -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)
|
||||
Reference in New Issue
Block a user