gdb

What is gdb

gdb(github discussion blog), host blog content on GitHub, using GitHub Discussions as CMS for our Markdown content and then eventually using GitHub API to retrieve the content.

GitHub Discussion

Setup

• Enabled discussion feature in my repository.
• Deleted all default labels.
• Deleted all default categories and sections.
• Created new section named “Articles”.
• Created new category with type “Announcement”, named “Release” respective to release posts.

You can adjust the section and categories yourself.

Script

For the fetching part extra build step for Astro, and here’s how it goes:

"scripts": {
  "fetch": "node scripts/fetch-discussions.mjs",
},

Usage

npm run fetch --repository "${{github.repository}}" # for example: npm run fetch --repository "mfuu/gdb"

Config

Change your website config in src/config.ts

export default {
  site: '', // your website url
  base: '', // your website base path
  author: '',
  description: '', // your website description
  title: '', // your website title
  ogImage: 'og.png', // your website og image
  lightAndDarkMode: true, // enable light and dark mode
  postPageSize: 4, // post per page size
  dynamicOgImage: true,
  dir: 'ltr', // "rtl" | "auto"
  lang: 'en', // html lang code. Set this empty and default will be "en"
  timezone: 'Asia/Shanghai', // Default global timezone (IANA format) https://en.wikipedia.org/wiki/List_of_tz_database_time_zones

  socials: [], // social links

  shareLinks: [], // post share links
};

Giscus

By default, giscus is enabled. If necessary, please modify the giscus.config.mjs configuration yourself.

{
  repo: '',
  enable: true,
  lang: "zh-CN",
  theme: "transparent_dark",
  inputPosition: "bottom",
  emitMetadata: 0,
  reactionsEnabled: 1,
  lazyLoading: true,
}

For more configuration content, please go to Giscus. Please ensure that your repo has installed the Giscus App.

Deploy

Automatic synchronization with Gitubb Wokflow, detail in .github/workflows/discussions.yml. If you have adjusted the category name of the Discussion, please modify the env variable too.

Others

My blog theme source: AstroPaper. Of course you can freely adjust it to the theme you want.