This is a Next.js project.
To run the site locally you need to clone this repository, see this step by step guide for more information.
To run the project you need to have node.js and yarn installed on your machine.
If you don't have Node.js installed on your computer see the following link https://nodejs.org/en/download/package-manager/.
This project uses the yarn package manager to manage the Node.js dependencies. Use the following link to install Yarn https://classic.yarnpkg.com/lang/en/docs/install/#mac-stable.
To run the project use the following commands.
yarn install
yarn devOpen http://localhost:3000 with your browser to see the result.
We encourage the developer community to submit issues and pull requests for the origintrail.club to this repository.
Create a new folder in the courses folder with a slug of the name of the course, for example deep-dive.
Create a new file and copy the following content.
---
subject: [Title]
description: [Short description]
author: [Your name]
banner: /courses/your-asset.jpg
---
[Course introduction]
To add pages to the course you can add multiple .mdx files to the course folder with the following naming convention ([order]-[slug].mdx).
---
title: [Page title]
section: [Section]
---
[Page content]To group multiple page's in the same group use the same value in the section key, for example:
---
title: [Page title]
section: Tokenomics
------
title: [Page title]
section: Tokenomics
---You will end up with a folder looking like:
your-course/
├─ index.mdx
├─ 1-first-page-title.mdx
└─ 2-second-page-title.mdx
Create a new folder in the public/courses folder with the same slug as the course.
Create a image with the following properties:
- Aspect ratio of 16 / 10
- And at least a width of 300px
Both .jpg and .png files are supported and automatically optimized in the project.
If your finished adding the content you can open a pull requests for the OriginTrail.club site repository