An open API service indexing awesome lists of open source software.

https://github.com/graphprotocol/docs

Documentation for The Graph
https://github.com/graphprotocol/docs

Last synced: 7 days ago
JSON representation

Documentation for The Graph

Awesome Lists containing this project

README

          

# The Graph Docs

This is the source code for The Graph’s documentation, accessible at [https://thegraph.com/docs](https://thegraph.com/docs).

## Contributing

Please read [`CONTRIBUTING.md`](https://github.com/graphprotocol/docs/blob/main/CONTRIBUTING.md). Thank you ❤️

## Local Setup

This project is built on [Next.js](https://nextjs.org/). You can run it on your machine, provided you have [Node 22+](https://nodejs.org/en/) and [`pnpm`](https://pnpm.io) installed.

First, clone the repo:

```bash
git clone https://github.com/graphprotocol/docs.git
```

Make sure you are inside the folder:

```bash
cd docs
```

Install the dependencies:

```bash
pnpm install
```

Then, run the project:

```bash
pnpm dev
```

That’s it! Go to http://localhost:3000/docs to see it in action. Any change you make to a file in `website/src/pages` should be refreshed automatically in your browser.