라이프스타일

Markdown과 MD 파일 입문

Markdown은 제목, 목록, 링크와 코드를 일반 텍스트 기호로 표현하는 형식입니다. README.md는 프로젝트 설명, AGENTS.md는 에이전트 규칙, SKILL.md는 재사용할 스킬을 다룹니다. 모든 MD 파일이 자동으로 지침이 되는 것은 아닙니다.

읽는 데 약 10분 · 실습 20 분

작업 흐름을 설명하는 그림이며 제품 스크린샷이 아닙니다.
사진: Mokaair (© Mokaair)
이 글의 목차
  1. 목표와 준비
  2. 1단계: 일반 텍스트 파일 만들기
  3. 2단계: 여섯 가지 기본 문법 이해하기
  4. 3단계: 미리 보기, 링크, 실패 실습
  5. 4단계: Codex가 문서를 읽게 하기
  6. 일반 .md와 AGENTS.md의 차이

목표와 준비

Markdown은 일반 텍스트 서식 문법이며 .md는 흔한 확장자입니다. 편집기는 문자를 다루고 미리 보기가 이를 제목, 목록, 링크로 표시합니다. Word 이름만 바꿔도 변환되지 않고 코드 명령도 미리 보기로 실행되지 않습니다. 원문과 표시를 구분해 편집합니다.

1단계: 일반 텍스트 파일 만들기

새 codex-md-lab을 VS Code로 열고 Explorer에서 README.md와 notes.md를 만듭니다. OS에 관계없이 대소문자를 맞추고 README.md.txt가 되지 않게 합니다. 다른 편집기는 UTF-8 일반 텍스트로 저장하고 확장자 자동 추가를 확인하세요. 실제 README를 덮지 않고 새 폴더를 사용합니다.

예제 전체를 README.md에 복사해 저장합니다. 웹사이트 바깥 코드 틀은 표시용이라 추가하지 않지만 예제 안의 백틱 세 개는 파일 내용이므로 유지합니다. 다섯 언어가 같은 결과를 비교하도록 영어 예제와 파일명을 공통 사용합니다.

파일 내용: 전체를 README.md로 저장 · markdown
# Small Steps notebook

## Purpose

Keep a short record of this practice project.

## Working steps

1. Read the request.
2. Make one focused change.
3. Verify the result.

- Keep original files.
- Record checks that have not run.

[Open task notes](./notes.md)

## Example command

```sh
node --version
```

> This command is an example, not a record of execution.

다음 예제를 같은 위치의 notes.md에 저장합니다. ./notes.md는 README 폴더 기준이며 ./README.md로 돌아갑니다. 데이터베이스나 웹 라우팅 없이 작은 목차와 개별 문서 관계를 만듭니다.

파일 내용: 전체를 notes.md로 저장 · markdown
# Task notes

[Back to the notebook](./README.md)

## Accepted result

- **Completed** shows only finished tasks.
- `Read` is the sample task title.
- Empty titles must be rejected.

## Pending checks

The browser check has not run yet.

2단계: 여섯 가지 기본 문법 이해하기

# 뒤 공백은 주 제목, ##는 다음 계층입니다. 여기서는 주 제목 하나 아래 절을 구성합니다. 모든 문장을 큰 제목으로 만들면 구조가 사라집니다. 제목을 바꾼 뒤 해당 링크도 확인하며 앵커 생성은 렌더러마다 다를 수 있습니다.

번호 목록은 단계, 하이픈 목록은 병렬 조건에 맞습니다. 문단 사이에 빈 줄을 둡니다. 별표 두 개는 강조, 백틱 하나는 Read 같은 인라인 코드 표시이며 Codex 권한을 높이지 않습니다. >는 메모나 인용 구분이지 검증 완료 표식이 아닙니다.

링크는 대괄호에 표시명, 괄호에 목적지를 둡니다. 예제는 상대 파일 경로, 사이트는 완전한 HTTPS URL입니다. 개인 C:\Users 경로는 모두가 열 수 있는 링크가 아니며 없는 notes.md는 완성 문서가 아닙니다. 표시명은 달라도 대상 경로와 대소문자는 정확해야 합니다.

코드는 시작/끝 백틱으로 감싸고 sh는 표시용 언어명입니다. 명령은 안, 아래 인용은 밖에 둡니다. 끝 구분자가 없으면 뒤가 모두 코드처럼 보일 수 있으므로 재설치 대신 구분자를 복구합니다. 반각 문자를 유지하고 백틱을 일반 따옴표로 바꾸지 않습니다.

Markdown 코드 울타리 자체를 예제로 보여 주기

아래 조각 전체를 notes.md 끝에 추가하고 저장하세요. 바깥쪽 네 개의 백틱도 파일에 넣는 내용이며 안쪽 세 개의 백틱을 문자로 표시합니다. 미리보기에서 시작하는 백틱 세 개와 sh, 닫는 백틱 세 개가 보이고 마지막 문장은 코드 밖에 있어야 합니다. GitHub 공식 문서의 중첩 작성법입니다.

파일 조각: 내부 백틱을 모두 유지하여 notes.md에 추가 · markdown
## Show the Markdown source

````markdown
```sh
node --version
```
````

This paragraph is outside the example.

마지막 문장까지 코드 안에 있으면 바깥쪽 닫는 백틱이 네 개인지 세어 보세요. 세 개로는 네 개짜리 시작을 닫을 수 없습니다. 끝부분만 고쳐 다시 확인하세요. 추가 실습을 되돌릴 때는 추가한 절만 지우고 원래 두 문서와 양방향 링크는 남깁니다.

3단계: 미리 보기, 링크, 실패 실습

VS Code에서 README.md를 열고 Markdown: Open Preview 또는 Windows/Linux의 Ctrl+Shift+V, macOS의 Command+Shift+V를 씁니다. 원문과 미리 보기는 같은 파일의 두 보기입니다. 저장 후 주 제목, 단계, 두 조건, 코드 블록을 확인합니다.

개인 설정이나 확장 기능이 단축키를 바꿀 수 있습니다. 열리지 않으면 명령 팔레트에서 Markdown: Open Preview를 찾아 현재 키를 확인하거나 직접 실행하세요. 다른 단축키 표로 추측하지 않으며 직접 조작하지 않은 OS는 공식 문서로 확인한 것으로 기록합니다.

Open task notes로 같은 폴더의 notes.md를 열고 돌아오는 링크를 확인합니다. 편집 탭으로 열리면 그 파일을 미리 보기 합니다. 제목이 같다는 이유만으로 판단하지 않습니다. 목적지를 ./missing.md로 바꿔 실패를 확인한 뒤 ./notes.md로 복구해 양방향을 확인합니다.

추가로 README.md를 백업하고 끝 코드 구분자만 지워 인용이 코드로 들어가는 것을 본 뒤 복원합니다. 경로, 제목, 구분자를 동시에 바꾸지 말고 하나씩 확인합니다. 기초 연습이기도 합니다.

4단계: Codex가 문서를 읽게 하기

데스크톱, , 에서 codex-md-lab 경로를 확인해 요청합니다. 읽기/비교만 하고 예제 명령은 실행하지 않습니다. 파일명이 보인다고 읽은 증거는 아니므로 출처와 미완료 검사를 묻습니다.

자연어 요청: 이 실습 프로젝트의 Codex에 입력 · text
Read README.md and notes.md in this practice folder. Explain the purpose, the accepted result, and the checks explicitly still pending. Identify each source file. Verify both relative file links point to existing files. Do not edit anything or execute the example command.

README 흐름, notes의 Completed/Read/공백 조건, 브라우저 미실행을 설명해야 합니다. 예제를 실행했다고 하면 근거와 수정을 요구하세요. 명령이나 성공 조건의 기록이 실행 기록은 아닙니다. 읽기 결과와 독립적인 링크 확인을 남깁니다.

일반 .md와 AGENTS.md의 차이

파일용도사용법
README.md프로젝트 설명과 입구열거나 읽도록 요청
notes.md검증과 미완료작업에서 명시
AGENTS.md프로젝트 지침이름, 범위, 로드 규칙 따르기
SKILL.md스킬과 실행 정보확장자 변경만이 아닌 구조 따르기

이번에는 AGENTS.md를 만들지 않아 자동 규칙 로드를 검증한 것이 아닙니다. 에서 범위/검증, 에서 스킬을 배웁니다. Markdown 가독성과 도구의 파일 발견/사용 규칙은 별개입니다. 다른 사람 메모를 자신의 실행 지침과 혼동하지 않습니다.

실제 파일 두 개, 양방향 링크, 코드 표시, 누락 오류 복구, 조건과 미실행을 구분한 응답을 남깁니다. 글꼴/간격이 달라도 구조, 내용, 목적지는 같아야 합니다. VS Code 표시/링크는 공식 문서로 확인했고 원본 예제의 중첩 구분자와 다국어 코드 보존도 컴파일/복사로 검증합니다.

09. Markdown과 MD 파일 입문 — 작업 흐름을 설명하는 그림이며 제품 스크린샷이 아닙니다. Plain text → README.md → Preview
09. Markdown과 MD 파일 입문 — 작업 흐름을 설명하는 그림이며 제품 스크린샷이 아닙니다. Plain text → README.md → Preview · 사진: Mokaair (© Mokaair)
자세한 설명 보기

Plain text to README.md to Preview

전체 목차

  • 라이프스타일

    Codex 학습 센터: 전체 튜토리얼 목차

    설치와 첫 작업부터 MD 지침과 고급 연동까지 60개 강의, 열 개 단원을 계획합니다. 수준, 환경, 목표, 명령으로 다음 글을 찾고 미게시 항목의 상태를 확인할 수 있습니다.

  • 라이프스타일

    Worktree와 작업 격리

    Worktree는 하나의 Git 저장소에 다른 브랜치의 작업 폴더를 만듭니다. 파일이 분리되어도 DB, 포트와 외부 서비스는 공유될 수 있습니다.

  • 라이프스타일

    실습: 작은 웹사이트 만들기

    brief.md에서 Small Steps 할 일 사이트를 계획하고 추가·완료·삭제·필터·로컬 저장을 구현합니다. HTML·CSS·데이터 함수·화면 이벤트·시험을 분리하고 Node와 브라우저로 검증한 뒤 재시작·복원 인계 기록을 남깁니다.

  • 라이프스타일

    사용량과 효율: 재작업 줄이기

    조건, 모델 선택, 시간, 결과를 기록해 불필요한 재시도와 과도한 문맥을 줄입니다.

최신 여행 소식·가이드

출처

라이프스타일