A showcase website for AI Builders.
- Node 16+ (with NPM 7+)
To run the app in your local
# first time only
npm install
npm run dev
The site should be available at http://localhost:3000/showcase.
Create a markdown file in posts/{year}
with the name of {number}-{title-in-kebab-case}.md
. The most important part in the file is the Front Matter, an example is shown below.
---
date: "2021-07-04"
title: "FoodyDudy"
builder: "Phacharaphol Somboontham (Gemmy)"
builder_info: "ประถมศึกษาปีที่ 6 / เชียงใหม่"
thumbnail: "/images/2021/001/1.png"
links:
github: "https://github.com/GemmyTheGeek/FoodyDudy"
facebook: "https://www.facebook.com/aibuildersx/posts/165448438956937"
blog: "https://bit.ly/2UkrtST"
---
date
, title
, builder
, builder_info
, thumbnail
and links
are required. For github
, facebook
and blog
, you can omit the field or add empty string ""
and add it later if it is not available at the time.
You can add images for each showcase in public/images/{year}/{showcase-number}
folder. Images should be JPEG
, JPG
or PNG
format.
To add image in the showcase markdown file, use the following syntax:
![Alternate Text](/images/{year}/{showcase-number}/{image-name}.png)
Open Graph tags are implemented so that when you share the URL, the title, description and image will be automatically populated.
For each showcase, the image will be the thumbnail of the showcase.
For main page (https://ai-builders.github.io/showcase/), you can change the image by placing the new image in public/og
folder. Then changes the image path in components/seo.tsx
to the new image path.
const fallbacks = {
title: 'AI Builders',
description: 'A program for kids who want to build good AI',
- image: '/og/14-04-2022.jpeg',
+ image: '/og/{new-image-path}',
url: 'https://www.facebook.com/aibuildersx',
};
If you find that the showcase is not rendered properly, please report it on Github Issues.