Skip to content
This repository has been archived by the owner on Mar 16, 2021. It is now read-only.

Commit

Permalink
Init mdbook for serving docs (#1)
Browse files Browse the repository at this point in the history
* docs(README): fix typo of grammar

* ci(mdbook): init mdbook actions

* docs(book): add book folder back
  • Loading branch information
clearloop authored Nov 16, 2020
1 parent 620b99a commit bf86891
Show file tree
Hide file tree
Showing 7 changed files with 80 additions and 33 deletions.
25 changes: 25 additions & 0 deletions .github/workflows/gh-pages.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
name: github pages

on:
push:
branches:
- master

jobs:
deploy:
runs-on: ubuntu-18.04
steps:
- uses: actions/checkout@v2

- name: Setup mdBook
uses: peaceiris/actions-mdbook@v1
with:
mdbook-version: 'latest'

- run: mdbook build

- name: Deploy
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./gh-pages
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
/target
target
gh-pages
30 changes: 0 additions & 30 deletions README.md

This file was deleted.

1 change: 1 addition & 0 deletions README.md
14 changes: 14 additions & 0 deletions book.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
[book]
authors = ["Megaclite"]
language = "en"
multilingual = false
src = "book"
title = "Megaclite"

[build]
build-dir = "gh-pages"

[output.html]
default-theme = "dark"
preferred-dark-theme = "ayu"
git-repository-url = "https://github.com/patractlabs/megaclite"
32 changes: 32 additions & 0 deletions book/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Megaclite

Megaclite is a zero-knowledge proof tool set building for the Polkadot ecology.

## Curves

Here we provide `alt_bn128` and `bls12_381` curves for ZKP, both of them contain `Integrate addition`,
`Scalar multiplication` and `Pairing` functions, for helping devlopers trying and testing the curves,
we provide `groth16` for verifaction as well.


## Runtime Interfaces

+ [jupiter-contracts][jupiter-contracts]


## Ink!

+ [jupiter-ink-env][jupiter-ink-env]


## References

+ [alt\_bn128][alt_bn128]
+ [bls12\_381][bls12_381]
+ [groth16][groth16]

[alt_bn128]: https://github.com/zcash-hackworks/bn
[bls12_381]: https://github.com/zkcrypto/bls12_381
[groth16]: http://www.zeroknowledgeblog.com/index.php/groth16
[jupiter-contracts]: https://github.com/patractlabs/substrate/tree/contracts/frame/contracts
[jupiter-ink-env]: https://github.com/patractlabs/ink/tree/altbn128/env/crates/env
3 changes: 3 additions & 0 deletions book/SUMMARY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Summary

[Intro](./README.md)
5 changes: 3 additions & 2 deletions src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
fn main() {
println!("Hello, world!");
#[test]
fn test() {
println!("XIX");
}

0 comments on commit bf86891

Please sign in to comment.