template.md

Content template GitHub

Hello fellow contributor, we're glad to have you!

Please use this template as a guide when creating pages for The Graph Academy Hub.

All pages use Markdown (a cheat sheet for this can be found here) so be sure to use .md as the extension when creating the page file. If you do not wish to use markdown, you can also use Editor.md a open-source online markdown editor.

Click here for an example of what a fully-fledged page looks like.

[Template Begin]

Page Heading [H1]

Summary [H2]

A summary of what the page is about.

Features [H2]

Main features.

Sub-feature 1 [H3]

Content for sub-feature 1.

Sub-feature 2 [H3]

Content for sub-feature 2.

Resources [H2]

Relevant resources like website, github link, blog posts etc go here

---

Content template GitBook

All documentation written in the GitHub repo is automatically synced to http://docs.thegraph.academy/

Section overview

To create a section overview, create a new folder and include an empty README.md only with the title of the section.

Content structure

Use SUMMARY.md to structure of the content over at docs.thegraph.academy and to include/exclude files. Use this file for defining pages and subpages etc.

Description

Add the following before the first headline to create a description

---
description: Detailed documentation about the roles within The Graph Network
---

Page link

Add the following to create a page link

{% page-ref page="../the-graph-ecosystem/organizational-structure/edge-and-node.md" %}

Hints

Add the following to create hints:

{% hint style="danger" %} Text. {% endhint %}

{% hint style="success" %} Text. {% endhint %}

{% hint style="success" %} Text. {% endhint %}

{% hint style="info" %} Text. {% endhint %} {% endtab %}

Tabs

Add tabs this way

{% tabs %} {% tab title="Indexing rewards" %}
Text
{% tab title="Query fee rebates" %}
Text