https://github.com/0xeigenlabs/0xeigenlabs.github.io
https://github.com/0xeigenlabs/0xeigenlabs.github.io
blockchain snark zkp zkvm
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/0xeigenlabs/0xeigenlabs.github.io
- Owner: 0xEigenLabs
- Created: 2022-01-25T15:46:51.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-08-14T03:55:53.000Z (almost 2 years ago)
- Last Synced: 2024-08-14T05:02:30.537Z (almost 2 years ago)
- Topics: blockchain, snark, zkp, zkvm
- Language: JavaScript
- Size: 57.6 MB
- Stars: 1
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Eigen zkVM Developer Documentation Site
Eigen Network builds the general-purpose zkVM with native privacy-preserving technology support on its modular proof system.
## Dependencies
To work on this site you will need:
- Linux or macOS (Windows may work, but is unsupported).
- Ruby, version 2.3.1 or newer
- Bundler — If Ruby is already installed, but the bundle command doesn't work,
just run `gem install bundler:1.16.3` in a terminal.
- [Pandoc](https://pandoc.org/installing.html)
## Build
Build site and slate API docs from the project's root directory:
```bash
./bin/build
```
## Run
To view the site locally, execute the build command first, and then run a simple
http server from the project's `/build` directory:
```bash
$ cd build
```
Python2:
```bash
$ python -m SimpleHTTPServer 8080
```
Python3:
```bash
$ python -m http.server 8080
```
Ruby:
```bash
$ ruby -run -e httpd . -p 8080
```
Node.js:
```bash
$ npm install -g http-server
$ http-server -p 8080
```
The site will run at [http://localhost:8080](http://localhost:8080).
## Updating API Docs
The [API Documentation](https://0xeigenlabs.github.io/api-docs/index.html)
runs on the Open Source [Slate Framework](https://github.com/lord/slate).
To make an update, fork the repo and make the changes to the appropriate
markdown in this [file directory](https://github.com/0xEigenLabs/0xEigenLabs.github.io/tree/master/src/api-docs/source/includes/).
To use livereload while working on the API docs, use middleman livereload like so:
``` bash
$ cd ./0xeigenlabs.github.io/src/api-docs/
$ bundle install
$ bundle exec middleman server
```
When your PR is merged the new docs will be deployed to the live docs page.
## Guide Contribution Guidelines
### Submitting Ideas
Have an idea for a guide or tutorial? First head on over to the
[GitHub issues](https://github.com/0xEigenLabs/0xeigenlabs.github.io/issues)
and see if your idea is already posted. If not, create an issue.
### Don't commit built files
Pull requests should only include changes to files in the `src` directory.
Releases will be done that build and deploy.
### Adding a New Guide
To add a new guide, just a submit a pull request (PR) with a markdown
file added to the `src/guides` directory in this repo (take a look at
some of the other guides [here](https://github.com/0xEigenLabs/0xeigenlabs.github.io/tree/master/src/guides)).
If your PR is accepted, it will added to the website.
Be sure to build the site before submitting your PR.