Published on

Getting Started with GitHub Blog and Study Rules

  • avatar
    Jaehyeok, Yu


Data Science Study Blog

We have migrated our blog from Notion to GitHub, and we are excited to continue sharing valuable content with our community. With GitHub blog, we aim to provide you with technical insights and development-related topics in an efficient and collaborative manner.

In this blog, you will find comprehensive tutorials on how to use GitHub effectively, along with tips and tricks to optimize your workflow. We'll explore various features, version control techniques, and integrations to make your development journey smoother.

Additionally, we'll establish clear study rules to ensure a productive and constructive learning environment. These guidelines will help foster healthy discussions, encourage knowledge sharing, and maintain a supportive community.

This is a Next.js, Tailwind CSS blogging starter template. Probably the most feature-rich Next.js markdown blogging template out there. Comes out of the box configured with the latest technologies to make technical writing a breeze.

1. Development

First, run the development server:

npm start
# or
npm run dev

Open http://localhost:3000 with your browser to see the result.

You can start editing the page by modifying pages/index.js. The page auto-updates as you edit the file.

2. Extend & Customize

data/siteMetadata.js - contains most of the site related information which should be modified for a user's need.

data/authors/ - default author information (required). Additional authors can be added as files in data/authors.

data/projectsData.js - data used to generate styled card on the projects page.

data/headerNavLinks.js - navigation links.

data/logo.svg - replace with your own logo.

data/blog - replace with your own blog posts.

public/static - store assets such as images and favicons.

tailwind.config.js and css/tailwind.css - contain the tailwind stylesheet which can be modified to change the overall look and feel of the site.

css/prism.css - controls the styles associated with the code blocks. Feel free to customize it and use your preferred prismjs theme e.g. prism themes.

components/social-icons - to add other icons, simply copy an svg file from Simple Icons and map them in index.js. Other icons use heroicons.

components/MDXComponents.js - pass your own JSX code or React component by specifying it over here. You can then call them directly in the .mdx or .md file. By default, a custom link and image component is passed.

layouts - main templates used in pages.

pages - pages to route to. Read the Next.js documentation for more information.

next.config.js - configuration related to Next.js. You need to adapt the Content Security Policy if you want to load scripts, images etc. from other domains.

3. Post

Sample Post


Frontmatter follows Hugo's standards.

Currently 7 fields are supported.

title (required)
date (required)
tags (required, can be empty array)
lastmod (optional)
draft (optional)
summary (optional)
images (optional, if none provided defaults to socialBanner in siteMetadata config)
authors (optional list which should correspond to the file names in `data/authors`. Uses `default` if none is specified)
layout (optional list which should correspond to the file names in `data/layouts`)
canonicalUrl (optional, canonical url for the post for SEO)

Here's an example of a post's frontmatter:

title: 'Introducing Tailwind Nexjs Starter Blog'
date: '2021-01-12'
lastmod: '2021-01-18'
tags: ['next-js', 'tailwind', 'guide']
draft: false
summary: 'Looking for a performant, out of the box template, with all the best in web technology to support your blogging needs? Checkout the Tailwind Nextjs Starter Blog template.'
images: ['/static/images/canada/mountains.jpg', '/static/images/canada/toronto.jpg']
authors: ['default']
layout: PostLayout


Run node ./scripts/compose.js to bootstrap a new post.

Follow the interactive prompt to generate a post with pre-filled front matter.

4. Licence

Licence Blog Template

5. Study Rules

Currently, we are in the pilot phase, and adjustments are being made flexibly. Please take this as a reference.

  • Each individual must upload their research content or findings weekly. While it is not mandatory, posting irrelevant or inappropriate content is prohibited. Therefore, please share personal research insights, troubleshooting experiences, or any relevant findings.

  • Source attribution is mandatory. For instance, when presenting an opinion, it must be supported either by one's own research findings or by referencing external sources with proper citations.

  • Presentations will take place on Discord every Wednesday at 8:00 PM (KST). Attendance is not mandatory.

  • New rules and the addition of new study members require a majority vote with at least more than half of the participants' agreement.

  • If participation rates in presentations or content posts are consistently low, a warning will be given once, and if the situation does not improve, the member may be subject to removal.

  • All members are expected to adhere to academic integrity principles and avoid plagiarism or unauthorized use of others' work.

  • Confidential or sensitive information shared during presentations should be treated with utmost confidentiality and not shared outside the study group without permission.

  • If a study member is unable to attend a presentation or upload content, prior notice to the group would be appreciated to facilitate scheduling and planning.