https://github.com/smartcontractkit/blockchain-developer-hub
Dive into blockchain and smart contract development.
https://github.com/smartcontractkit/blockchain-developer-hub
Last synced: about 1 year ago
JSON representation
Dive into blockchain and smart contract development.
- Host: GitHub
- URL: https://github.com/smartcontractkit/blockchain-developer-hub
- Owner: smartcontractkit
- License: mit
- Created: 2022-02-11T12:26:50.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-08-08T14:25:15.000Z (almost 3 years ago)
- Last Synced: 2023-08-08T15:43:39.154Z (almost 3 years ago)
- Language: JavaScript
- Homepage: https://blockchain.education
- Size: 26.2 MB
- Stars: 67
- Watchers: 6
- Forks: 20
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Blockchain Developer Hub
Your roadmap to start web3 and blockchain development is here.
**https://blockchain.education/**
## Contribute to the content
All content files are located in `./data` folder
- Add new blockchain learning material to the `./data/learn.yaml`
- Add new build material to the `./data/build.yaml`
- Add new articles as markdown files to the `./data/pages` folder
## Contribute to the website
All the source code is located in `./src` folder
- Add new components to the `./src/components` folder
- Add new pages to the `./src/pages` folder
- Add new styles to the `./src/styles` folder
- Add new sections to the `./src/sections` folder
- Add new layouts to the `./src/layouts` folder
## Getting Started
First, run the development server:
```bash
npm run dev
# or
yarn dev
```
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
You can start editing the page by modifying `src/pages/index.js`. The page auto-updates as you edit the file.
## Learn More
To learn more about Next.js, take a look at the following resources:
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions
are welcome!
## Table Support
To learn more about how to make table supported look at:
- [remarkGfm](https://www.npmjs.com/package/remark-gfm) - Install remark Gfm
- [How to integrate it with serialize](https://githubhot.com/repo/hashicorp/next-mdx-remote/issues/229) - see how its
integrated with serialize
**Important**: When adding a markdown for table, its important to put in a div with className `table-wrapper`, this
helps with the responsiveness of the table.
_Example_ :
```markdown
```
## Case studies
In other for us to be able to generate internal case studies, there are few things we have to do
- create a markdown file inside `data/pages/case-studies`. (the name of the markdown file is important for the URL, as
it much match the path on the url).
- The content on the markdown reuires some variable, which are also used to generate the case studies on the case
studies page. Below is a template you should use
```markdown
---
title: Deep Learning Case
description: Here is a small description about Build Case
href: case-studies/deep-learning-case
image: 'https://cdn.consensys.net/uploads/2021/09/16181652/damien-1.7923f061-958x460.png'
sidebar_title: Case Studies
sidebar_position: 2
---
```
### Code explanation
- **sidebar_title**: Case Studies because we the markdown is for Case Studies
- **sidebar_position**: Where the link will be positions on the side bar when you are on the blog pag.
- **title**: Used when the card is case study is generated for display on the case studies page and also serves as blog
heading.
- **href**: same as title.
- **description**: same as title.
- **image**: same as title.
Above you notice `deep-learning-case` in the href, it is also the name of the markdown file.
## Deploy on Vercel
The easiest way to deploy your Next.js app is to use the
[Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme)
from the creators of Next.js.
Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.