https://github.com/offchainlabs/prysm-documentation
Documentation portal for all things Prysm / Eth2
https://github.com/offchainlabs/prysm-documentation
Last synced: about 1 year ago
JSON representation
Documentation portal for all things Prysm / Eth2
- Host: GitHub
- URL: https://github.com/offchainlabs/prysm-documentation
- Owner: OffchainLabs
- Created: 2020-01-14T21:40:05.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2025-06-03T21:08:53.000Z (about 1 year ago)
- Last Synced: 2025-06-04T01:51:22.160Z (about 1 year ago)
- Language: JavaScript
- Homepage: https://www.offchainlabs.com/prysm/docs
- Size: 22.2 MB
- Stars: 42
- Watchers: 11
- Forks: 170
- Open Issues: 47
-
Metadata Files:
- Readme: README.md
- Security: docs/security-best-practices.md
Awesome Lists containing this project
README
# Prysm Documentation Portal
This repository houses all the documentation pertaining to the Prysm client and Ethereum. It is generated with [Docusaurus](https://github.com/facebook/docusaurus) and deployed with [Vercel](https://vercel.com/).
Below are steps for initializing and reproducing this portal for development.
## Dependencies
1. The latest version of [Node](https://nodejs.org/en/download/) installed.
2. npm (comes with Node.js)
> You have to be on Node >= 8.x.
## Installation
1. Clone this repository.
2. Enter the newly cloned repo.
3. Issue the command `npm install`.
4. Wait for the installation process to complete.
## Running the development server
1. From the root directory, run the local web server using `npm start`.
2. Load the example site at http://localhost:3000/prsym/docs if it did not already open automatically. If port 3000 has already been taken, another port will be used. Look at the console messages to see which.
You should see the example site loaded in your web browser. There's also a LiveReload server running, and any changes made to the docs and files in the project directory will cause the page to refresh.
## Building Static HTML Pages
To create a static build of the documentation portal, run the following script from the root directory:
```bash
npm run build
```
This will generate a `build` directory containing the `.html` files from all of the docs and other files included in `pages`.
## Deployment with Vercel
This project is configured to be deployed with Vercel. The `vercel.json` file in the root directory contains the necessary configuration for deployment.
To deploy:
1. Push your changes to GitHub.
2. Connect your GitHub repository to Vercel.
3. Vercel will automatically build and deploy the site.
Alternatively, you can use the Vercel CLI to deploy from your local machine:
```bash
npm install -g vercel
vercel
```