포스트

Chirpy Text and Typography Demo Plus Guide

Chirpy Starter에서 자주 쓰는 text and typography 기능을 예제와 함께 설명형으로 정리한 샘플 포스트. 재사용용 가이드와 AI 프롬프트 작성용 참고 문구를 함께 포함합니다.

Chirpy Text and Typography Demo Plus Guide

소개

이 문서는 Chirpy Starter에서 자주 쓰는 텍스트 및 타이포그래피 기능을
렌더링 테스트용 예제 + 실사용 가이드 + AI 프롬프트 참고 샘플 형태로 정리한 문서입니다.

기존 데모 포스트를 단순히 보여주는 수준에서 끝내지 않고, 아래처럼 용도 중심으로 바로 재사용할 수 있도록 구성했습니다.

  • 어떤 기능인지
  • 언제 쓰는지
  • 어떤 문맥에서 잘 어울리는지
  • AI에게 어떻게 요청하면 되는지

이 문서에서 바로 확인할 수 있는 항목은 아래와 같습니다.

  • Prompt 박스
  • filepath 강조
  • 코드 블록 파일명 배너
  • nolineno
  • image shadow
  • image left align
  • header id
  • inline link
  • abbreviation
  • footnote
  • definition list
  • inline attribute list
  • block attribute list
  • <kbd>
  • <mark>
  • <details>
  • math
  • mermaid
  • checklist
  • table
  • 비디오 임베드 (local·YouTube)
  • 오디오 임베드
  • dark/light 이미지 · LQIP · media_subpath
  • image right align · pin
  • mermaid 확장 (sequence·gantt·state·er)
  • diff / console 코드 블록
  • table 열 정렬

이 포스트는 렌더링 테스트와 작성 가이드를 겸하는 샘플입니다.

운영 문서에 그대로 복붙하기보다, 필요한 블록만 골라서 문맥에 맞게 재조합하는 편이 좋습니다.

HTML 혼합이나 일부 스타일은 테마 버전에 따라 렌더링 차이가 있을 수 있습니다.

운영 서버에 적용하는 명령이나 설정 예시는 반드시 직접 검증 후 사용하세요.

이 샘플을 어떻게 쓰면 좋은가

1. 블로그 샘플 포스트로 사용

Chirpy 기능이 정상 렌더링되는지 한 번에 확인할 때 유용합니다.

2. 팀 내부 마크다운 스타일 가이드로 사용

문서 작성자가 어떤 블록을 어떤 상황에서 써야 하는지 설명할 때 기준 문서로 쓸 수 있습니다.

3. AI 프롬프트용 예제 저장소로 사용

예를 들어 아래처럼 요청하면 일관된 결과를 얻기 쉽습니다.

Chirpy 블로그 포스트 형식으로 작성해줘.
prompt-info, filepath, code block filename, details, mermaid를 포함하고, 각 섹션마다 실무 용도를 짧게 설명해줘.

Chirpy 기능

prompt-tip / prompt-info / prompt-warning / prompt-danger

용도
상태, 주의사항, 팁, 위험 요소를 눈에 띄게 강조할 때 사용합니다.

추천 상황

  • info: 배경 설명, 보충 설명
  • tip: 권장 방법, 실무 팁
  • warning: 주의가 필요한 설정, 호환성 이슈
  • danger: 운영 영향, 데이터 손실 가능성, 강한 경고

AI 요청 예시
이 섹션은 warning 박스로 감싸고, 업그레이드 전 체크포인트를 3줄로 요약해줘

이 박스는 info 예제입니다.

이 박스는 tip 예제입니다.

이 박스는 warning 예제입니다.

이 박스는 danger 예제입니다.

filepath

용도
파일 경로를 일반 인라인 코드보다 더 문서 친화적으로 보여줄 때 사용합니다.

추천 상황

  • 설정 파일 위치 안내
  • 스크립트 경로 설명
  • 독자가 복사하거나 찾아야 하는 경로 강조

AI 요청 예시
설정 파일 경로는 filepath 스타일로 표기해줘

설정 파일은 .github/workflows/android-ci-demo.yml 입니다.

실행 스크립트는 scripts/build-debug.sh 입니다.

code block filename

용도
코드 블록이 어떤 파일에 들어가는 내용인지 바로 보이게 할 때 사용합니다.

추천 상황

  • 설정 파일 예제
  • 샘플 스크립트
  • 여러 파일을 순서대로 설명하는 튜토리얼

AI 요청 예시
코드 블록 위에 파일명 배너가 보이도록 Chirpy file attribute를 붙여줘

아래 코드는 파일명 배너 예제입니다.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
name: Android CI Demo

on:
  workflow_dispatch:
  push:
    branches: [main]

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Run tests
        run: ./gradlew test

nolineno

용도
짧은 코드나 단순 명령 예제에서 줄번호를 숨겨 시각적 부담을 줄일 때 사용합니다.

추천 상황

  • 셸 스크립트 3~10줄 예제
  • 복붙 중심 명령 예제
  • 줄번호가 의미 없는 설정 샘플

AI 요청 예시
짧은 bash 예제이므로 줄번호는 숨기고 file 속성도 유지해줘

아래 코드는 파일명 배너와 함께 줄번호를 숨기는 예제입니다.

1
2
3
4
5
#!/usr/bin/env bash
set -euo pipefail

echo "Start build"
./gradlew assembleDebug

image shadow / image left align

용도
이미지를 더 자연스럽게 배치하거나, 본문 흐름 안에서 설명형 레이아웃을 만들 때 사용합니다.

추천 상황

  • 대표 이미지 재사용
  • UI 캡처 소개
  • 이미지 옆에 설명 문단을 붙이고 싶을 때

AI 요청 예시
대표 이미지는 shadow를 적용하고, 두 번째 이미지는 left 정렬해서 본문이 흐르도록 작성해줘

대표 이미지 재사용 예제입니다.

Cover image

대표 이미지 재사용 예시

왼쪽 정렬 예시입니다.

Cover image

이 문단은 이미지가 왼쪽에 붙었을 때 텍스트가 어떻게 흐르는지 확인하기 위한 예시입니다.
Chirpy에서 이미지 정렬과 본문 흐름을 함께 점검할 때 사용할 수 있습니다.
문단이 충분히 길어야 줄바꿈 형태를 눈으로 확인하기 좋습니다.

kramdown 기능

header id

용도
제목 텍스트는 자유롭게 쓰되, 링크 대상 ID는 안정적으로 고정하고 싶을 때 사용합니다.

추천 상황

  • 한글 제목을 유지하면서 링크는 영어 slug로 고정
  • 다른 포스트나 문서에서 특정 섹션으로 직접 연결
  • 제목이 바뀌더라도 anchor를 최대한 유지

AI 요청 예시
한글 제목을 쓰되 링크용 anchor는 why-this-stack 으로 고정해줘

아래 제목은 고정 ID를 사용합니다.

개요 및 선정 이유 - Why this stack?

  • 제목은 한글로 자유롭게 쓰고
  • 링크용 ID는 영어 slug로 고정하고
  • 다른 포스트에서 직접 섹션 링크를 걸 수 있습니다

예시 링크: /posts/ghec-blog-begin/#intro

용도
Chirpy에서 고정된 섹션 링크와 문서 내부 점프 링크를 안정적으로 만들기 위한 작성 규칙입니다.

핵심 개념
Chirpy 테마는 내부적으로 Kramdown 마크다운 렌더러를 사용합니다.
따라서 Kramdown의 공식 문법인 속성 리스트(Attribute List) 를 활용해서 Slug(고정 ID) 를 지정하고, 그 Slug로 링크를 거는 방식이 가장 안정적입니다.

링크 작업은 크게 아래 두 단계로 나뉩니다.

  1. 목적지에 Slug(ID) 달기
  2. 지정한 Slug로 링크 걸기

1. 목적지에 Slug(ID) 지정하기

요소의 끝이나 바로 아랫줄에 중괄호와 샵 표기인 {#아이디} 또는 {: #아이디 } 를 사용하면 고유한 ID를 부여할 수 있습니다.

제목에 지정할 때

한글 제목은 브라우저에서 URL 인코딩이 길어지거나, 경우에 따라 링크가 지저분해 보일 수 있습니다.
그래서 제목 끝에 영문 Slug를 수동으로 지정하는 방식이 실무에서는 더 안정적입니다.

1
## 셋업 방법 안내 {#setup-guide}

실제 예시:

셋업 방법 안내

  • 표시되는 제목은 한글로 유지
  • 링크는 #setup-guide-demo 처럼 고정
  • 제목 문구가 조금 바뀌어도 anchor 전략을 유지하기 쉬움
일반 문단이나 블록에 지정할 때

문단, 인용구, 표, 리스트 같은 블록 요소 에 ID를 달고 싶다면, 해당 블록 바로 아래 줄에 {: #아이디 } 를 적습니다.

1
2
이 문단으로 바로 점프하게 만들고 싶습니다.
{: #jump-here }

실제 예시:

이 문단으로 바로 점프하게 만들고 싶습니다.

문장 중간 인라인 요소에 지정할 때

문장 중간의 특정 텍스트에만 Slug를 달고 싶다면, 텍스트를 백틱이나 강조 문법으로 감싼 뒤 바로 뒤에 공백 없이 {:#아이디} 를 붙입니다.

1
이 문장은 `인라인 앵커`{:#inline-anchor} 예시입니다.

실제 예시:

이 문장은 인라인 앵커 예시입니다.

일반적인 마크다운 링크 문법인 [링크 텍스트](이동할 경로) 를 사용하되, 목적지가 어디인지에 따라 경로 작성법이 달라집니다.

같은 포스트 내부에서 이동할 때

같은 페이지 안에서 이동할 때는 경로 자리에 #슬러그만 적으면 됩니다.

1
자세한 내용은 [셋업 방법 안내](#setup-guide-demo)를 참고하세요.

실제 예시:

자세한 내용은 셋업 방법 안내를 참고하세요.

문단 점프 예시: 이 문단으로 이동

인라인 앵커 점프 예시: 인라인 앵커로 이동

다른 포스트의 특정 위치로 이동할 때

다른 포스트나 페이지의 특정 위치로 이동할 때는 대상 포스트 URL 뒤에 #슬러그를 덧붙입니다.

1
[첫블로그 철칙 바로가기](/posts/ghec-blog-begin/#intro)

같은 블로그 내 다른 포스트 예시:

외부 링크는 일반 URL을 그대로 사용하면 됩니다.
다만 경로 표시용 텍스트 와 이동용 링크 는 구분해서 쓰는 편이 읽기 좋습니다.

외부 공식 문서 예시: GitHub Actions 공식 문서

권장 작성 팁

  • 여기, 클릭 같은 문구보다 무엇으로 이동하는지 드러나는 링크 텍스트 가 좋습니다.
  • 한글 제목은 자동 생성 anchor에 기대기보다, 영문 Slug를 직접 부여하는 편이 안전합니다.
  • 같은 문서 안 반복 참조가 많다면 setup-guide, build-logic, runner-checklist 처럼 짧고 예측 가능한 Slug 를 권장합니다.

AI 요청 예시
Chirpy와 Kramdown 기준으로 같은 페이지 이동 링크 작성법을 설명하고, 제목 Slug 지정 예제 1개, 블록 Slug 예제 1개, 인라인 Slug 예제 1개, 다른 포스트 섹션 링크 예제 1개를 포함해줘

abbreviation

용도
반복해서 등장하는 약어를 문서 상단에서 정의해 가독성을 높일 때 사용합니다.

추천 상황

  • 기술 문서에서 동일 약어가 여러 번 등장
  • 팀 외부 공유 문서
  • 영어 약어가 많은 블로그 포스트

AI 요청 예시
문서 상단에 AAB, APK, GHES, GHEC, PR 약어 정의를 추가해줘

AAB 와 APK 는 Android 배포 문서에서 자주 등장합니다.

GHES 와 GHEC 는 GitHub 제품군 비교 글에서 자주 등장합니다.

PR 자동화 정책을 설명할 때도 약어 정의가 있으면 문서가 더 깔끔해집니다.

footnote

용도
본문 흐름을 끊지 않으면서 보충 설명이나 예외사항을 뒤로 빼고 싶을 때 사용합니다.

추천 상황

  • 운영상 trade-off 설명
  • 비용, 제약, 부가 조건 정리
  • 본문보다 우선순위가 낮은 설명

AI 요청 예시
본문은 짧게 유지하고 운영상 단점은 footnote로 빼줘

이 방식은 운영 제어가 쉽습니다.1

비용 구조도 예측하기 편합니다.2

문서 하단 각주 영역이 실제로 생성되는지 확인해보세요.3

definition list

용도
용어 사전처럼 개념과 설명을 짝지어 보여줄 때 적합합니다.

추천 상황

  • 온보딩 문서
  • 개념 설명 섹션
  • 도메인 용어 정리

AI 요청 예시
아래 핵심 용어 3개를 definition list 형식으로 정리해줘

Self-hosted Runner
직접 운영하는 GitHub Actions 실행기
Artifact
워크플로 결과물로 업로드하는 파일
Matrix Build
여러 조합을 병렬로 실행하는 빌드 전략

inline attribute list

용도
문장 안 특정 토큰 하나만 별도 스타일이나 ID로 제어하고 싶을 때 사용합니다.

추천 상황

  • 경로만 강조
  • 짧은 인라인 anchor 생성
  • 특정 토큰을 링크 대상으로 만들기

AI 요청 예시
문장 안에서 경로 하나는 filepath 클래스로, 코드 하나는 고정 ID를 주는 예제로 보여줘

이 문장은 강조 경로 처럼 인라인 클래스 적용 예제를 보여줍니다.

이 문장은 inline-code-demo 처럼 인라인 ID를 줄 수 있습니다.

인라인 ID 링크 테스트

block attribute list

용도
문단, 인용문, 블록 전체에 ID나 클래스를 붙여 스타일 또는 링크 대상을 제어할 때 사용합니다.

추천 상황

  • 특정 블록을 바로 링크하고 싶을 때
  • prompt 스타일을 블록 전체에 적용할 때
  • 커스텀 CSS 대상 블록을 명확히 잡을 때

AI 요청 예시
이 문단은 custom-block-example ID를 부여하고 링크 테스트도 같이 넣어줘

이 문장은 block IAL + prompt-info 예제입니다.

이 문단은 일반 블록에 ID를 붙인 예제입니다.

블록 ID 링크 테스트

HTML 혼합

kbd

용도
단축키를 문서에서 읽기 쉽게 표현할 때 사용합니다.

추천 상황

  • 에디터 사용법
  • 개발도구 단축키 안내
  • 온보딩 문서

AI 요청 예시
단축키는 kbd 태그로 표기해줘

저장하려면 Ctrl + S 를 누르세요.

명령 팔레트는 Ctrl + Shift + P 입니다.

mark

용도
리뷰 포인트나 핵심 문장을 시각적으로 강조할 때 사용합니다.

추천 상황

  • 꼭 봐야 하는 한 문장
  • 변경 포인트 강조
  • 회의 후 요약 포인트 표시

AI 요청 예시
핵심 결론 한 문장만 mark 태그로 강조해줘

이 문장은 하이라이트 예제 입니다.

details

용도
기본 본문은 짧게 유지하면서, 필요할 때만 펼쳐보는 추가 정보를 넣을 때 유용합니다.

추천 상황

  • 트러블슈팅
  • FAQ
  • 로그 예시나 세부 조건 숨김 처리

AI 요청 예시
트러블슈팅 목록은 details 블록 안으로 넣어줘

트러블슈팅 더 보기
  • 러너 라벨이 정확한지 확인
  • 캐시 키가 너무 자주 바뀌지 않는지 확인
  • artifact 업로드 경로가 맞는지 확인
  • timeout 발생 시 어느 테스트가 hang 되었는지 summary에 노출되는지 확인

기타

table

용도
짧은 비교표, 기본 설정값, 체크 기준을 깔끔하게 보여줄 때 사용합니다.

추천 상황

  • 운영 기준표
  • 옵션 비교
  • 권장값 표기

AI 요청 예시
운영 기준을 3열 테이블로 정리해줘

항목권장비고
Runner 수4기본 운영 예시
캐시사용빌드 시간 절감
로그 보관14일팀 정책에 맞게 조정

checklist

용도
작업 완료 여부나 게시 전 검수 항목을 명확히 보여줄 때 사용합니다.

추천 상황

  • 포스트 발행 전 체크
  • CI 구성 점검
  • 문서 리뷰 체크리스트

AI 요청 예시
배포 전 점검 항목을 checklist 형식으로 5개 만들어줘

  • Prompt 박스 확인
  • filepath 확인
  • 코드 파일 배너 확인
  • nolineno 확인
  • 이미지 렌더링 확인
  • 각주 확인
  • 약어 정의 확인
  • 필요한 블록만 골라서 실제 포스트에 반영

math

용도
수식이 포함된 기술 문서나 개념 설명을 작성할 때 사용합니다.

추천 상황

  • 알고리즘 설명
  • 비용 공식
  • 모델 관련 수학 표현

AI 요청 예시
인라인 수식 1개와 블록 수식 1개를 포함해줘

인라인 수식 예: $E = mc^2$

블록 수식 예:

\[f(x) = x^2 + 2x + 1\]

mermaid

용도
텍스트 기반으로 간단한 구조도나 흐름도를 함께 보여줄 때 사용합니다.

추천 상황

  • CI/CD 흐름
  • 시스템 구성도
  • 검증 절차 설명

AI 요청 예시
GitHub Actions에서 self-hosted runner로 테스트가 실행되는 흐름을 mermaid로 그려줘

graph TD
    A[Developer Push] --> B[GitHub Actions]
    B --> C[Self-hosted Runner]
    C --> D[Test Execution]
    D --> E[Artifact Upload]

미디어 · 다이어그램 · 코드 확장

텍스트/타이포그래피 외에, 기술 블로그를 더 풍부하게 만드는 미디어 임베드 · 다이어그램 · 코드 블록 확장을 정리합니다. Chirpy 7.x 기준입니다.

아래 로컬 미디어(비디오·오디오·다크/라이트 이미지·LQIP) 예제는 실제 파일이 있어야 렌더됩니다. 문법만 보여주는 예제는 실제 파일 경로로 바꾼 뒤 ./tools/test.sh(html-proofer)로 확인하고 발행하세요.

로컬 비디오 임베드

용도
앱 화면 녹화, CI 실행 장면처럼 직접 만든 영상을 본문에 반응형으로 넣을 때 사용합니다.

추천 상황

  • Android 앱 동작 시연
  • GitHub Actions 워크플로 실행 캡처
  • 스크린샷으로는 전달이 약한 인터랙션

AI 요청 예시
데모 영상은 Chirpy embed/video.html로 넣고 poster와 title을 지정해줘

실제 파일을 assets/img/posts/<슬러그>/에 넣은 뒤 아래처럼 임베드합니다. autoplay, loop, muted, types 속성도 지정할 수 있습니다.

1
2
3
4
{% include embed/video.html
   src='/assets/img/posts/2026-03-08-chirpy-text-and-typography-demo/demo.mp4'
   title='앱 데모 녹화'
   poster='/assets/img/posts/2026-03-08-chirpy-text-and-typography-demo/cover.png' %}

저작권: 자가 호스팅(파일 직접 업로드)은 재배포 허용 라이선스가 필요합니다. 무료 예시로 Blender 오픈무비(CC BY 3.0)를 구글 공개 샘플 버킷에서 받을 수 있습니다. 용량이 크면 repo가 무거워지니 짧게 자른 저용량 클립을 권장합니다.

YouTube 임베드

용도
이미 YouTube에 있는 영상(세션 녹화, 공개 데모)을 호스팅 비용 없이 반응형으로 넣을 때 사용합니다.

추천 상황

  • 컨퍼런스/세션 다시보기
  • 공개된 데모 영상 인용
  • 파일을 직접 호스팅하고 싶지 않을 때

AI 요청 예시
이 유튜브 영상을 Chirpy embed/youtube.html로 넣고 출처를 CC BY로 표기해줘

아래는 Blender 오픈무비 Big Buck Bunny(CC BY 3.0) 실제 임베드 예제입니다.

© Blender Foundation · peach.blender.org · CC BY 3.0

임베드는 YouTube 서버에서 스트리밍되므로 내 사이트가 영상을 복제하지 않습니다. 그래도 공식/CC 라이선스 영상 위주로 쓰는 편이 안전합니다. Twitch·Bilibili도 embed/twitch.html, embed/bilibili.html로 같은 방식입니다.

오디오 임베드

용도
짧은 음성 메모, 알림음, 팟캐스트 클립 등을 본문에 넣을 때 사용합니다.

AI 요청 예시
오디오 파일은 embed/audio.html로 넣어줘

1
2
3
{% include embed/audio.html
   src='/assets/img/posts/2026-03-08-chirpy-text-and-typography-demo/clip.mp3'
   title='알림음 예제' %}

다크/라이트 모드 이미지

용도
다이어그램이나 스크린샷을 테마별로 다르게 보여줘, 라이트/다크 두 모드에서 모두 자연스럽게 만들 때 사용합니다. (Chirpy 7.0+)

추천 상황

  • 배경이 흰색/검은색인 다이어그램
  • 라이트 UI · 다크 UI 캡처를 각각
  • 투명 배경 로고

AI 요청 예시
밝은 버전과 어두운 버전 이미지를 각각 .light / .dark로 지정해줘

1
2
![Light](/path/diagram-light.png){: .light }
![Dark](/path/diagram-dark.png){: .dark }

같은 자리에서 라이트 모드면 첫 번째, 다크 모드면 두 번째 이미지가 표시됩니다.

LQIP (저품질 플레이스홀더)

용도
무거운 이미지가 로드되기 전 저해상도 미리보기를 먼저 보여줘 체감 로딩 속도를 개선할 때 사용합니다.

AI 요청 예시
대표 이미지에 lqip 저해상도 플레이스홀더를 붙여줘

1
![Cover](/path/cover.png){: lqip="/path/cover-lqip.webp" w="1200" h="630" }

media_subpath (경로 반복 제거)

용도
포스트 안 이미지가 많을 때, 공통 경로를 front matter에 한 번만 지정해 본문에서는 파일명만 쓰도록 합니다.

추천 상황

  • 이미지가 여러 장인 튜토리얼
  • /assets/img/posts/<슬러그>/를 매번 반복하기 싫을 때

AI 요청 예시
이미지 공통 경로는 media_subpath로 빼고 본문은 파일명만 쓰게 해줘

front matter에 아래를 추가하면:

1
media_subpath: /assets/img/posts/2026-03-08-chirpy-text-and-typography-demo/

본문에서는 파일명만 짧게 씁니다.

1
![Cover](cover.png){: w="1200" h="630" .shadow }

이 데모 포스트 본문은 이미지에 전체 경로를 그대로 쓰고 있습니다. media_subpath는 새 포스트에서 처음부터 적용하는 편이 혼선이 없습니다.

이미지 우측 정렬 + 캡션

용도
이미지를 본문 오른쪽에 붙여 텍스트가 옆으로 흐르게 하고, 바로 아랫줄 이탤릭으로 캡션을 답니다. (데모 앞쪽 .left의 반대)

AI 요청 예시
이 이미지는 오른쪽 정렬하고 아래에 캡션을 달아줘

Cover image 오른쪽 정렬 + 캡션 예시

이 문단은 이미지가 오른쪽에 붙었을 때 본문이 왼쪽에서 어떻게 흐르는지 확인하기 위한 예시입니다.
캡션은 이미지 바로 다음 줄에 이탤릭(_..._)으로 적으면 Chirpy가 자동으로 캡션 스타일을 적용합니다.
문단이 충분히 길어야 이미지 옆 흐름을 눈으로 확인하기 좋습니다.

pin (대표 글 상단 고정)

용도
공지, 대표 글, 시리즈 시작 글을 홈 화면 최상단에 고정할 때 사용합니다.

AI 요청 예시
이 글은 홈 상단에 고정되도록 pin 처리해줘

front matter에 아래 한 줄을 추가합니다.

1
pin: true

Mermaid 다이어그램 확장

용도
데모의 기본 플로우차트(graph TD) 외에도, mermaid: true만 있으면 다양한 다이어그램이 그대로 렌더됩니다. CI/CD·Android 주제에 잘 어울리는 것들입니다.

추천 상황

  • sequenceDiagram: 빌드→테스트→릴리즈 호출 순서
  • gantt: 릴리즈/스프린트 타임라인
  • stateDiagram-v2: 앱·워크플로 상태 전이
  • erDiagram: DB 스키마

AI 요청 예시
PR 머지부터 배포까지를 mermaid sequenceDiagram으로 그려줘

시퀀스 다이어그램:

sequenceDiagram
    participant Dev as Developer
    participant GH as GitHub Actions
    participant Run as Self-hosted Runner
    Dev->>GH: git push (PR)
    GH->>Run: 워크플로 트리거
    Run->>Run: build & test
    Run-->>GH: 결과 · 아티팩트
    GH-->>Dev: 상태 체크 리포트

릴리즈 타임라인(gantt):

gantt
    title 릴리즈 준비 일정
    dateFormat  YYYY-MM-DD
    section 개발
    기능 구현       :a1, 2026-03-01, 5d
    코드 리뷰       :a2, after a1, 2d
    section 검증
    QA 회귀         :b1, after a2, 3d
    릴리즈 태깅      :milestone, after b1, 0d

상태 전이(stateDiagram):

stateDiagram-v2
    [*] --> Queued
    Queued --> Running
    Running --> Passed
    Running --> Failed
    Failed --> Queued: 재시도
    Passed --> [*]

diff 코드 블록

용도
설정·코드의 변경 전/후를 +/- 색으로 한눈에 보여줄 때 사용합니다.

추천 상황

  • 워크플로 YAML 수정
  • 리팩터링 전후 비교
  • 리뷰 포인트 강조

AI 요청 예시
이 변경을 diff 코드 블록으로 before/after가 보이게 해줘

1
2
3
4
5
6
7
8
 jobs:
   build:
-    runs-on: ubuntu-latest
+    runs-on: self-hosted
     steps:
       - uses: actions/checkout@v4
+      - name: Cache Gradle
+        uses: actions/cache@v4

console / 터미널 출력

용도
명령과 그 출력을 함께 보여줄 때, $ 프롬프트와 결과가 구분되도록 렌더합니다.

AI 요청 예시
명령 실행과 출력을 console 코드 블록으로 보여줘

1
2
3
4
$ ./gradlew assembleDebug
> Task :app:assembleDebug
BUILD SUCCESSFUL in 12s
34 actionable tasks: 34 executed

테이블 열 정렬

용도
숫자는 오른쪽, 라벨은 왼쪽처럼 열 정렬로 표를 더 읽기 좋게 만들 때 사용합니다. 구분선의 콜론(:) 위치로 정렬을 지정합니다.

AI 요청 예시
수치 열은 오른쪽 정렬, 항목 열은 왼쪽 정렬한 표로 만들어줘

항목값비고
빌드 시간12s캐시 적용
테스트 수128단위+통합
실패0게이트 통과
  • :--- 왼쪽 정렬
  • ---: 오른쪽 정렬
  • :--: 가운데 정렬

AI 프롬프트 템플릿 예시

아래 문구는 이 문서를 샘플 템플릿처럼 재사용할 때 참고할 수 있는 예시입니다.

템플릿 1. 튜토리얼 포스트 생성

Chirpy 블로그 포스트 형식으로 작성해줘.
대상 독자는 CI/CD 입문자이고, prompt-info, filepath, code block filename, details, checklist를 포함해줘.
각 기능에는 한 줄짜리 용도 설명을 붙이고, 문체는 실무 가이드처럼 깔끔하게 써줘.

템플릿 2. 기술 비교 글 생성

GHES와 GHEC 비교 글을 작성해줘.
abbreviation, table, footnote, mark를 포함하고, 섹션마다 언제 이 구성이 유리한지 설명해줘.
같은 페이지 섹션 링크도 2개 넣어줘.

템플릿 3. 운영 문서 생성

self-hosted runner 운영 가이드를 Chirpy 포스트 형식으로 작성해줘.
warning과 danger 박스를 포함하고, 파일 경로는 filepath 스타일로 표시해줘.
트러블슈팅은 details 블록으로 접어주고, 마지막에는 체크리스트를 넣어줘.

위 템플릿들은 Chirpy를 적용한 가이드를 만들어줄테지만 항상 링크에 대한 검증과 제대로된 동작을 확인하시길 바랍니다.

템플릿 4. 기존 문서 수정

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
참고 문서의 규칙을 적용해서 원본 Markdown을 재작성해줘.

우선순위:
1. 원본 내용 보존
2. 참고 문서의 표현 규칙 적용
3. Chirpy/Kramdown 호환성 유지

작업 방식:
- 어떤 기법이 필요한지 먼저 판단
- 필요한 기법만 최소한으로 적용
- slug, inline link, filepath, code block file attribute, details 등을 상황에 맞게 사용
- 없는 링크/이미지/사실은 추가하지 않음

출력 형식:
- 최종 Markdown만 출력
- 설명, 해설, 변경 사유는 출력하지 않음

[참고 문서 시작]
여기에 chirpy guide markdown 전문
[참고 문서 끝]

[원본 Markdown 시작]
여기에 사용자 원본 markdown 전문
[원본 Markdown 끝]

마무리

이 포스트는 모든 것을 직접 검증하고 AI 템플릿을 추가하였습니다. 이 포스트를 prompt처럼 사용하고 싶으시면 프롬프트 부분부터 마지막까지는 지우고 사용하시면 됩니다. 제 모든 포스트는 AI와 함께 작성하지만 항상 Best Practice 그리고 직접 확인하는 것을 철칙으로 합니다. 이 블로그도 정식 AI가 정식 가이드가 아닌 쉬운 방법을 말해줘서 3번째 다시 만들었습니다.

  1. 대신 self-hosted runner 운영 비용과 관리 책임이 늘어납니다. ↩︎

  2. 초기 투자 비용은 늘 수 있지만 장기적으로는 효율적일 수 있습니다. ↩︎

  3. 이 각주는 렌더링 확인용 예시입니다. ↩︎

이 기사는 저작권자의 CC BY 4.0 라이센스를 따릅니다.