Code Monkey home page Code Monkey logo

gatsby-starter-haon's Introduction

Gatsby Starter Haon (Blog Theme - Open Source) 🚀

💡 All the code in this repository and the blog theme are open source. Therefore, feel free to clone and use it as you wish! 🙂

  • (현 블로그 테마는 오픈소스입니다. 자유롭게 clone 받아 커스터마이징하여 블로그를 꾸며보세요 🙂)

💡 Blog Theme Live Demo: https://gatsby-starter-haon.netlify.app/

국문(한국어 원서) 는 Gatsby 블로그 초기 설정 ⚙️ 가이드라인 부터 확인 가능합니다.

I hope this theme will be helpful for those who want to customize and operate your blogs. Feel free to customize and use the Gatsby Haon Theme! 👋

💡 I drew great inspiration for creating this theme from Hudi's blog.


Features 🚀

  • Markdown
  • SEO
  • Responsive Web
  • Dark/Light Mode
  • Tag
  • Series
  • Search
  • Private Mode
  • Utterance (Comment widget)
  • GA (Google Analytics)

0. Create a GitHub Repository

Before installing the theme, you need a GitHub repository for your Gatsby Theme. Please create one.


1. Installing the Theme 👋

Follow the steps below to create your own blog theme!

npx gatsby new your-blog-name https://github.com/msung99/Gatsby-Starter-Haon.git

2. Running Gatsby Local Server

Once you have downloaded the theme to your local machine, follow the steps below to run the Gatsby local server.

cd your-blog-name
npm install  // install node.js
gatsby develop // or "npm start"

If the above commands run without any issues, you can check the initial state of your blog at http://localhost:8000!


3. Entering Blog Information

You can directly input your meta information to customize the theme. If you navigate to gatsby-config.js, you will see the initial state as follows:

module.exports = {
  siteMetadata: {
    title: `haon.blog`,
    description: `Hello! This is a tech blog theme using Gatsby 🤩`,
    author: `Haon`,
    siteUrl: `https://gatsby-starter-haon.netlify.app/`,
    keywords: [`server`, `backend`, `gatsby`],
    repo: "msung99/Gatsby-Starter-Haon",
    socialLinks: {
      github: "https://github.com/msung99",
      instagram: "https://www.instagram.com/iminseong920",
      facebook: "https://www.facebook.com/",
      linkedin: "https://www.linkedin.com/",
      velog: "https://velog.io/@msung99",
      email: `https://[email protected]`,
    },
  },
  plugins: [
    // ... (omitted)
  ],
}

Modify the siteMetadata as follows:

3-1. Basic Profile Settings

Input your basic profile information.

title: ``, // haon.blog
description: ``, // Hello! This is a tech blog theme using Gatsby 🤩
author: ``, // Haon
siteUrl: ``, // https://gatsby-starter-haon.netlify.app/
keywords: [ ], // [`server`, `backend`, `gatsby`]

3-2. Utterances (Comments) Configuration

This template is based on the issue creation-based comment system. Input your GitHub repository information for smooth comment functionality activation.

repo: "your-github-name/repository-name"  //  "msung99/Gatsby-Starter-Haon",

3-3. Social Links Integration

Lastly, you can integrate your social media accounts. This is required for the feature where clicking on social icons navigates to the respective URLs. Customize the desired fields from the below social accounts:

socialLinks: {
  github: ""  // "https://github.com/msung99",
  instagram: ""  // "https://www.instagram.com/iminseong920",
  facebook: ""  // "https://www.facebook.com/",
  linkedin: ""  // "https://www.linkedin.com/",
  velog: ""  // "https://velog.io/@msung99",
  email: ""  // `https://[email protected]`,
},

4. Deploying the Blog

You can quickly create your blog on Github Page or Netlify, depending on your preferred deployment environment. Here, I'll briefly mention Netlify.

By utilizing the button below, you can integrate your GitHub repository with Netlify to deploy your blog. You may need your GitHub repository for this process, which you should have created earlier.

Deploy to Netlify


Issue, PR Registration

If you're using Gatsby-Starter-Haon and have something you want to communicate:

Social Page or Register Issue and feel free to leave comments.

  • Suggestions
  • Q&A
  • Bug Discovery and Code Improvement
  • New Features / Functions

Feel free to leave comments or register issues according to the Issue Template.

We welcome any feedback. We're looking forward to many people's opinions for quality software improvement and theme development. 👍

gatsby-starter-haon's People

Contributors

msung99 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

gatsby-starter-haon's Issues

bug: pagination color 미적용

어떤 버그인가요? (What kind of bug is this?)

pagination 에서 ... 의 색깔이 미적용되었다.


버그가 어떻게 해결되어야 하나요? (How should the bug be resolved?)

컬러를 props.theme.main.text 로 적용


참고할만한 코드 및 자료(선택) (Codes and materials worth reference (optional))

fix: SocialLink Optional 로 변경

어떤 버그인가요? (What kind of bug is this?)

SocialLink 의 Optional 기능이 제공되지 않는다. 만일 리스트 데이터 중 1개라도 생략할 경우 오류가 터진다.


어떤 상황에서 발생한 버그인가요? (Under what circumstances did the bug occur?)

만일 리스트 데이터 중 1개라도 생략할 경우 버그가 발생한다.


참고할만한 코드 및 자료(선택) (Codes and materials worth reference (optional))

X

🚀 질의사항, 제안사항 등록하기 (소통하기)

Gatsby-Starter-Haon 을 사용하다가 소통하고 싶은 내용이 생긴다면 무엇이든 코멘트를 남겨주세요!
코멘트를 이 곳에 남겨주셔도 좋고, Issue Template 양식에 맞추어 이슈를 마음껏 등록하셔도 좋습니다.

    1. 제안사항
    1. Q&A
    1. 버그 발견 및 코드 개선
    1. 신규기능

무엇이든 좋습니다. 양질의 소프트웨어 향상, 테마 발전을 위해서 많은 분들의 의견을 기다리고 있습니다 👍

feature: 미리보기 이미지 (썸네일) 모바일 버전 지원

어떤 신규 기능인가요? (What new feature is it?)

모바일 버전에서 썸네일을 지원하지 않으니 다소 UI/UX 가 밋밋해보인다. 썸네일을 보여주도록 한다.

작업 상세 내용 (Details)

  • ImageMobileWrapper 생성
  • Image Reactive Style 제거
  • Image 크기 160px 로 지정

참고할만한 자료(선택) (Reference materials - Options)

X

bug: 초기 브라우저 화면 로딩시 header 가 등장합니다 🥹

어떤 버그인가요? (What kind of bug is this?)

안녕하세요 @msung99 님! 만들어주신 gatsby-starter 블로그 테마 잘 사용하고 있습니다. 감사합니다! 웹 프로그래밍은 접한게 이번에 처음인데 대단하신 것 같아요...

브라우저 최초 렌더링시 header 가 등장하는 현상이 보이는데, 혹시 제 컴퓨터에서만 이런걸까요 ?? 🥲

image


버그가 어떻게 해결되어야 하나요? (How should the bug be resolved?)


참고할만한 코드 및 자료(선택) (Codes and materials worth reference (optional))

fix: PostFooter 의 MoveButton 에 비공개 포스트가 등장하는 현상

어떤 버그인가요? (What kind of bug is this?)

PostFooter 의 MoveButton 에 비공개 포스트에 대한 이동 버튼이 등장하고 있다.


어떤 상황에서 발생한 버그인가요? (Under what circumstances did the bug occur?)

Prev, Next 포스트 중 비공개 포스트가 표시되고 있다. MoveButton 을 통해 이동하여 포스트 내용을 확인할 수 있다.


참고할만한 코드 및 자료(선택) (Codes and materials worth reference (optional))

X

etc: 블로그 가이드라인 세부 설명 추가

무엇이 필요한가요? (What do you want?)

블로그 테마를 사용하기 위한 초기 가이드라인 설명을 상세하게 추가한다.

  • 테마 설치 추가 설명 및 명령어 안내
  • 국문 / 영문 가이드라인 모두 추가
  • Readme 상세 소개
    • 기존에 적어놓았던 필요없는 설명들 모두 제거
    • 썸네일 이미지 추가

refactor: 프로필 링크 이모티콘 추가

어떤 기능의 개선을 원하나요? (What features would you like to see improved?)

Profile 컴포넌트에 링크 이모티콘을 추가한다.


어떤 점에서 개선의 필요성을 느꼈나요? (In what ways did you feel the need for improvement?)

프로필 검색 노출을 개선하기 위함이다.

refactor: Gatsby HighLight (코드블럭) 컬러 개선

어떤 기능의 개선을 원하나요? (What features would you like to see improved?)

Gatsby HighLight (코드블럭) 컬러를 개선한다. 라이트 모드 컬러를 더 예쁘게 커스터마이징한다.


어떤 점에서 개선의 필요성을 느꼈나요? (In what ways did you feel the need for improvement?)

라이트모드에서 코드 블럭이 지나치게 까맣다. 컬러에 다소 아쉬움이 남는다.

bug: 이메일 연동 문의드립니다!!!

어떤 버그인가요? (What kind of bug is this?)

어떤 버그인지 설명해주세요! (Please explain what kind of bug it is!)

안녕하세요. 예쁘고 깔끔한 블로그 테마 만들어주셔서 감사합니다. 🙂
여러 gatsby starter theme 을 찾아봤는데 @msung99 님이 만드신 이 블로그 테마가 가장 깔끔하고 필요한 것만 들어있는 것 같습니다.

테마를 설치하고 사용하는데, 이메일 계정이 연동되지 않는 것 같아서 문의드립니다!! 이메일 버튼을 클릭해도 기능이 원활히 동작되지 않는 것 같아서요!

예쁜 블로그 테마 만들어주셔서 다시 한 번 감사합니다.


버그가 어떻게 해결되어야 하나요? (How should the bug be resolved?)

이메일 기능이 지원되었으면 합니다!


참고할만한 코드 및 자료(선택) (Codes and materials worth reference (optional))

bug: sitemap 의 의존성 충돌 문제를 해결한다.

어떤 버그인가요? (What kind of bug is this?)

gatsby-plugin-advanced-sitemap 플러그인이 Gatsby 5 버전에서 호환성이 문제되는 현상이 일어나고 있다.


버그가 어떻게 해결되어야 하나요? (How should the bug be resolved?)

gatsby-remark-copy-linked-files 설치를 통한 의존성 충돌을 해결한다.


참고할만한 코드 및 자료(선택) (Codes and materials worth reference (optional))

refactor: Seo 검색 엔진 성능 개선

어떤 기능의 개선을 원하나요? (What features would you like to see improved?)

  • 1. gatsby-plugin-sitemap 적용
  • 2. robot.txt 적용
  1. Seo 검색 엔진 최적화를 위해 추가 필드를 넣는다. Post.jsx 를 메인으로 추가한다.
  • description
  • Exercpt

참고하면 좋을 자료


어떤 점에서 개선의 필요성을 느꼈나요? (In what ways did you feel the need for improvement?)

feature: pagefooter 소설 계정 연동

어떤 신규 기능인가요? (What new feature is it?)

PageFooter 에 소설 계정을 연동한다. 추가적으로 SideMenuBar 의 title 을 수정한다.

작업 상세 내용 (Details)

  • footer 의 gatsby starter haon 에 깃허브 링크를 연동한다.
  • SideMenuBar 의 title 을 haon.theme 로 변경

참고할만한 자료(선택) (Reference materials - Options)

question: How can I change my main profile picture? 🤔

What are you curious about?

hello!

I'm using the theme well! thank you 😁

It's no different than that I'm trying to change my profile picture, but I don't know how to change it, so I sent an issue.

I changed profile.png in the current static directory to the image I wanted, and the images in the favicon and the social part of the left navigation were changed. The main part still maintains the default image.

image

bug: main profile 업로드 지연 속도

어떤 버그인가요? (What kind of bug is this?)

현재 main profile 이 즉시 최신화되지 않는다. 약 2~4일이 경과한 뒤에서야 최신화된다.


버그가 어떻게 해결되어야 하나요? (How should the bug be resolved?)

최신화와 동시에 메인 프로필 이미지가 즉시 바뀌어야한다.


참고할만한 코드 및 자료(선택) (Codes and materials worth reference (optional))

refactor: 블로그 config 파일을 따로 생성한다.

어떤 기능의 개선을 원하나요? (What features would you like to see improved?)

blog-config.js 파일을 따로 분리한다. 이 안에 사용자 설정 정보를 기입할 수 있도록 한다.


어떤 점에서 개선의 필요성을 느꼈나요? (In what ways did you feel the need for improvement?)

현재 gatsby-config.js 에 사용자 설정 정보를 기입하도록 만드니 초기 설정에 불편함이 느껴진다.

bug:MarkDown 태그 미적용 현상 해결

어떤 버그인가요? (What kind of bug is this?)

마크다운 텍스트를 입력했을 때 일부 적용되지 않는 현상이 발생한다.


버그가 어떻게 해결되어야 하나요? (How should the bug be resolved?)

  • 표가 원활히 표시되어야 함 : table, tbody, tr 태그를 수정할 것.

참고할만한 코드 및 자료(선택) (Codes and materials worth reference (optional))

fix: Series 의 PostList 의 previewImage 가 defaultImage 로 등장하는 버그

어떤 버그인가요? (What kind of bug is this?)

Series 의 PostLIst 가 previewImage 를 읽어오지 못하고 있다.


어떤 상황에서 발생한 버그인가요? (Under what circumstances did the bug occur?)

Series 의 모든 Post 가 DefaultImage 로 미리보기가 표시되고 있다. PreviewImage 를 올바르게 읽어오도록 수정해야 한다.


참고할만한 코드 및 자료(선택) (Codes and materials worth reference (optional))

feature: BackEnd Social 계정 연동. 인증/인가 구현

어떤 신규 기능인가요? (What new feature is it?)

백엔드 API 연동을 통해 커뮤니티를 활성화한다.

작업 상세 내용 (Details)

  • Authentication
  • 0Auth
  • Optional : MySQL Source / Replica Server (for. Replication) 🤔
  • CI/CD

참고할만한 자료(선택) (Reference materials - Options)

https://velog.io/

refactor: SimpleTagList 크기 축소, 더보기 기능 추가

어떤 기능의 개선을 원하나요? (What features would you like to see improved?)

  • SimpleTagList 에서 Tag 의 개수가 40개가 넘어가면 더보기를 표시한다.
  • 폰트 사이즈를 축소한다.
  • KebabCase 를 제거한다.
  • SImpleTagList 외의 일반 TagList 에 대해서도 KebabCase 를 제거한다.

어떤 점에서 개선의 필요성을 느꼈나요? (In what ways did you feel the need for improvement?)

  • Tag 의 개수가 너무 많아지니 PostList 가 눈에 들어오지 않는다.

Etc: 디폴트 프로필 수정, 추가 document 작성

무엇이 필요한가요? (What do you want?)

  • 서비스 소개를 더 개성있게 표현하도록 도큐먼트를 수정한다.

Todo

  • 디폴트 리드미 파일 날짜 변경
  • static 파일 기본 이미지 중앙 정렬
  • Readme.md Desktop 이미지 추가

bug: 이메일 계정 연동

어떤 버그인가요? (What kind of bug is this?)

socialLink 의 Email 계정값을 설정후 Email 기능이 지원되지 않는다.


버그가 어떻게 해결되어야 하나요? (How should the bug be resolved?)

이메일 기능을 지원한다.


참고할만한 코드 및 자료(선택) (Codes and materials worth reference (optional))

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.