이것은 무엇인가
EpoCanvas Docs는 EpoCanvas 프로젝트의 공식 설명 프로젝트입니다. 쉽게 말하면: 이 저장소가 전달하는 것은 바로 “설명 문서” 그 자체이며, 지금 여러분이 보고 있는 웹사이트 전체가 바로 그 결과물입니다. 저장소에는 다른 소프트웨어의 기능 코드가 없고, 여러분이 찾고 있는 “제품”이 바로 이 문서 사이트입니다.
“설명 프로젝트”의 의미
이 말에는 두 가지 층위가 있고, 둘 다 동시에 성립합니다:
- 그것은 하나의 설명서입니다. 내용은 “무엇인지, 어떻게 쓰는지, 어떻게 고치는지, 어떻게 온라인에 올리는지”를 중심으로 구성됩니다: 읽기 화면 조작 방법, 새 문서 작성 방법, 설정을 어디서 바꾸는지, 배포 명령어가 무엇인지. 이 문서를 쓰는 목적은 단 하나입니다 — EpoCanvas를 받은 사람이 이곳저곳 물어보지 않고도 문서만 따라 하면 일을 해낼 수 있도록 하는 것입니다.
- 그 자체가 바로 실행할 수 있는 웹사이트 시스템이기도 합니다. 저장소를 로컬로 clone한 뒤
pnpm install과pnpm run dev두 명령어만 실행하면, 지금 눈앞에 있는 것과 똑같은 사이트를 얻을 수 있습니다. 전체 코드는 Astro 5와 Starlight를 기반으로 하며 MIT 라이선스로 배포되므로, 통째로 가져가서 자신의 프로젝트 문서 사이트로 바꿀 수 있습니다.
한 가지 놓치기 쉬운 특징이 있습니다: 이 문서가 소개하는 모든 기능을 여러분은 바로 지금 직접 사용하고 있습니다. 3열 읽기 레이아웃, Ctrl + K 사이트 전체 검색, 오른쪽 위에서 10개 언어를 그 자리에서 전환하는 기능 — 문서에서 설명하는 것은 바로 이 사이트가 자체적으로 구현한 능력이므로, 읽으면서 시험해 보면 확인할 수 있습니다.
정확히 어떤 역할을 하는가
독자 유형별로 나누어 보면, 이 설명 프로젝트는 세 가지 일을 담당합니다:
| 당신은 누구인가 | 어떤 도움을 주는가 | 어디서 시작할지 권장 |
|---|---|---|
| 자료만 찾아보는 독자 | 특정 기능의 사용법, 특정 오류의 해결 방법을 찾기 | 상단 검색창 또는 Ctrl + K 사이트 전체 검색으로 해당 장으로 바로 이동 |
| 자신의 문서 사이트를 만들고 싶은 개발자 | 바로 실행할 수 있는 완전한 문서 사이트 소스 코드와 배포 절차 제공 | 제품 소개 → 빠른 시작 → 배포 |
| 문서를 작성하는 작성자 | 파일 위치, 서식 작성 방법, 이미지 배치 방법, 게시 방법 규정 | 「문서 작성 및 콘텐츠 관리」 그룹 아래의 세 장 |
한 문장으로 요약하면: 사용자는 이해할 수 있게, 개발자는 가져갈 수 있게, 작성자는 따를 기준이 있게.
이 프로젝트에 포함된 내용
사이드바는 다섯 그룹으로 나뉘며, 각각 하나의 질문에 답합니다:
- 제품 개요와 입문: 이것은 어떤 것인가? 로컬에서 어떻게 실행하는가?
- 핵심 기능과 사용 가이드: 읽기 화면, 검색, 다국어, 내비게이션의 구체적인 사용법은?
- 문서 작성 및 콘텐츠 관리: 새 문서는 어떻게 쓰는가? Markdown 조판과 렌더링에는 어떤 규칙이 있는가?
- 설정 및 커스터마이징: 사이트 제목, 내비게이션 메뉴, 테마 색상은 어디서 바꾸는가? 컴포넌트는 어떻게 고치는가?
- 배포 및 운영: 어떻게 온라인에 게시하고, 도메인을 연결하고, SEO와 버전 관리를 하는가?
각 문서는 독립적으로 찾아볼 수 있으므로 순서대로 통독할 필요가 없습니다.
자주 겪는 두 가지 오해
오해 하나: “이것은 어떤 소프트웨어의 설명서니까, 그 소프트웨어 자체를 찾아가야겠다.” 이 저장소에는 문서 사이트의 소스 코드만 있고 다른 소프트웨어의 코드는 없습니다. 문서가 실제로 설명하는 대상은 바로 이 문서 사이트 시스템 자체의 사용, 커스터마이징, 배포입니다.
오해 둘: “이것은 읽기 전용 웹사이트라서 내려받아도 별 소용이 없다.” 정반대입니다. 소스 코드는 GitHub에 완전히 공개되어 있고, 로컬에서 명령어 두 개면 실행됩니다. 템플릿으로 삼아 자신의 프로젝트 문서 사이트로 바꾸는 것은 바로 이 프로젝트가 설계된 용도 중 하나입니다.
다음 단계
- 제품의 위치, 핵심 기능, 기술 선택에 대한 완전한 소개를 보려면 **제품 소개 및 핵심 가치**를 읽어 주세요.
- 바로 로컬에서 사이트를 실행해 보려면 **빠른 시작 (3분 만에 실행)**을 읽어 주세요.
- 특정 문제만 찾아보려면 상단 검색창이나
Ctrl + K로 키워드를 검색하세요.