-
Notifications
You must be signed in to change notification settings - Fork 18
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Miros
committed
Mar 28, 2022
1 parent
f7ce255
commit 85af1a1
Showing
86 changed files
with
2,745 additions
and
557 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
# Mkdocs build | ||
site/ | ||
|
||
# Editors | ||
.vscode/ | ||
|
||
# System files | ||
**/.DS_Store |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,40 +1,97 @@ | ||
# docs | ||
iden3 documentation | ||
<div align="center"> | ||
<img src="mkdocs/docs/logo-dark.svg" width="150"/> | ||
</div> | ||
<br /> | ||
<div align="center"> | ||
|
||
[Work in progress] | ||
[![Chat on Twitter][ico-twitter]][link-twitter] | ||
[![Chat on Telegram][ico-telegram]][link-telegram] | ||
[![Website][ico-website]][link-website] | ||
<!-- [![GitHub repo][ico-github]][link-github] --> | ||
|
||
</div> | ||
|
||
## Offline use | ||
In order to use and visualize the result in a local machine follow this two steps: | ||
[ico-twitter]: https://img.shields.io/twitter/url?color=black&label=Iden3&logoColor=black&style=social&url=https%3A%2F%2Ftwitter.com%2Fidenthree | ||
[ico-telegram]: https://img.shields.io/badge/telegram-telegram-black | ||
[ico-website]: https://img.shields.io/website?up_color=black&up_message=iden3.io&url=https%3A%2F%2Fiden3.io | ||
<!-- [ico-github]: https://img.shields.io/github/last-commit/iden3/docs?color=black --> | ||
|
||
[link-twitter]: https://twitter.com/identhree | ||
[link-telegram]: https://t.me/iden3io | ||
[link-website]: https://iden3.io | ||
<!-- [link-github]: https://github.com/iden3/docs --> | ||
|
||
- install Docsifyjs cli: | ||
# Identity protocol | ||
|
||
## Prove your access rights, not your identity | ||
|
||
iden3 is a next-generation private access control based on self-sovereign identity, designed for decentralised and trust-minimised environments. | ||
|
||
## Privacy for all | ||
|
||
Everyone has the right to liberty and equality, the right freely to participate in their community, and the right to privacy. | ||
|
||
The aim of the iden3 protocol is to empower people and create a more inclusive and egalitarian foundation for better human relationships through open-source cryptography and decentralised technologies. | ||
|
||
<div align="center"> | ||
<br /> | ||
|
||
Privacy by design | Decentralised | Open source | ||
:---------------------------:|:---------------------------------:|:-------------------------------: | ||
 |  |  | ||
|
||
<br /> | ||
</div> | ||
|
||
## Iden3 protocol libraries | ||
|
||
- **Crypto library ([go-iden3-crypto](https://github.com/iden3/go-iden3-crypto))** | ||
<br />Implementation of Poseidon hash and Baby JubJub Eliptic curve | ||
|
||
- **Merkle tree sql library ([go-merkletree-sql](https://github.com/iden3/go-merkletree-sql))** | ||
<br />Implementation of Sparse Merkle tree | ||
|
||
- **Core library ([go-iden3-core](https://github.com/iden3/go-iden3-core))** | ||
<br />Identity core primitives | ||
|
||
- **Circuits ([circuits](https://github.com/iden3/circuits))** | ||
<br />Identity circuits | ||
|
||
- **Go-circuits ([go-circuits](https://github.com/iden3/go-circuits))** | ||
<br />Library for transformation go-core primitives to json inputs for identity circuits | ||
|
||
- **Prover server ([prover-server](https://github.com/iden3/prover-server))** | ||
<br />Wrapper on snarkjs for ZK proof generation | ||
|
||
- **Authorization library ([go-iden3-auth](https://github.com/iden3/go-iden3-auth))** | ||
<br />Library for authentication with zkp verification (edited) | ||
|
||
--- | ||
|
||
# How to run this documentation (locally) | ||
## Install mkdocs | ||
``` | ||
npm i docsify-cli -g | ||
pip3 install mkdocs | ||
``` | ||
|
||
- run local server: | ||
In case you have a rendering problem with the pieces of code, please execute: | ||
``` | ||
docsify serve docs | ||
pip install --upgrade mkdocs | ||
``` | ||
This will serve the documentation website in a local port, reloading the webpage each time that a file is updated. | ||
|
||
More details: https://docsify.js.org/#/quickstart | ||
|
||
## Deploying on server | ||
- just need to download this repository | ||
## Install mkdocs-material theme | ||
``` | ||
git clone https://github.com/iden3/docs.git | ||
pip install mkdocs-material | ||
``` | ||
|
||
- then run: | ||
## Install mkdocs-markdown-graphviz (1.3) | ||
``` | ||
./gitconnect | ||
pip3 install mkdocs-markdown-graphviz==1.3 | ||
``` | ||
This will automatically pull new commits added to this repo, to have always in the server the last version of this docs repositoy. | ||
|
||
- run local server: | ||
## Run the webserver | ||
At the mkdocs directory execute: | ||
|
||
``` | ||
docsify serve docs | ||
mkdocs serve | ||
``` | ||
This will serve the documentation website in a local port, reloading the webpage each time that a file is updated. |
Binary file not shown.
Oops, something went wrong.