ReadMe에 아티클 게시하기
API 키로 ReadMe 프로젝트를 연결하고, Clevera 아티클을 선택한 카테고리의 가이드로 게시하세요. 스크린샷은 ReadMe로 업로드됩니다. 콜아웃, 단계, 동영상이 변환되는 방식, 업데이트 작동 방식 및 일반적인 오류에 대해 알아보세요.
Clevera 아티클을 ReadMe 프로젝트의 가이드로 게시하고, 선택한 가이드 카테고리에 저장하세요. 스크린샷은 ReadMe로 업로드됩니다.
시작하기 전에
- Clevera: 워크스페이스가 Pro 또는 사용자 지정 플랜이어야 하며, ReadMe를 연결하려면 소유자 또는 관리자 권한이 있어야 합니다. 연결이 완료되면 아티클을 편집할 수 있는 누구나 게시할 수 있습니다. 다른 도구에 아티클 게시하기를 참조하세요.
- ReadMe: 관리 가능한 프로젝트가 있어야 하며, 가이드 섹션에 최소 하나의 카테고리가 있어야 합니다. 하나의 키로 하나의 프로젝트를 연결합니다.
- 현재 ReadMe 프로젝트: Clevera는 ReadMe Refactored 프로젝트에서 제공하는 ReadMe의 현재(v2) API를 통해 게시합니다. ReadMe의 이전 플랫폼을 사용하는 프로젝트는 연결할 수 없습니다.
- 버전: Clevera는 프로젝트의 메인(안정) 버전 가이드에 게시합니다.
- 아티클: 먼저 아티클을 생성하세요. 게시하면 아티클만 전송됩니다. 동영상을 포함하려면 아티클 내부에 배치하세요. 아티클에 동영상 표시하기를 참조하세요.
ReadMe API 키 찾기
ReadMe 프로젝트에서 Configuration → API Keys를 열고 키를 복사하세요(목록이 비어 있으면 새로 만드세요). 이 키는 해당 프로젝트에 대한 전체 액세스 권한을 부여하므로 비공개로 유지하세요.
ReadMe 연결
연결 창 열기
Clevera에서 사이드바의 워크스페이스 이름을 클릭하고 연동을 선택한 다음, ReadMe를 찾아 연결을 클릭하세요. ReadMe 연결 창에 "키를 붙여넣으세요. 저장하기 전에 키를 확인합니다."라는 메시지가 표시됩니다.
키 붙여넣기 및 확인
API 키에 키를 붙여넣고 키 확인을 클릭하세요. ReadMe가 키를 수락하면 "키가 수락되었습니다."라는 메시지와 함께 게시할 사이트 아래에 프로젝트가 표시됩니다.
연결
연결을 클릭하세요. "ReadMe가 연결되었습니다."라는 메시지가 표시되고 연결됨 아래에 프로젝트 이름과 함께 ReadMe가 나타납니다.
키는 Clevera 측에서 만료되지 않습니다. 다른 프로젝트를 연결하려면 ReadMe 연결에서 다시 연결을 사용하고 해당 프로젝트의 키를 붙여넣으세요. 기존 키가 대체됩니다.
ReadMe에 아티클 게시하기
게시 탭 열기
편집기에서 공유 → 게시를 클릭하고 게시 준비 완료 아래의 ReadMe 타일을 클릭하세요.
가이드 카테고리 선택
게시 위치 아래의 프로젝트에 연결된 프로젝트가 표시됩니다. 가이드 카테고리를 선택하세요. "아티클이 이 카테고리의 가이드 섹션에 게시됩니다." "아직 가이드 카테고리가 없습니다"라는 메시지가 보이면 먼저 ReadMe에서 카테고리를 만드세요.
게시
ReadMe에 게시를 클릭하세요. Clevera는 먼저 기존 사본을 찾습니다. 동일한 주소의 가이드가 이미 있으면 수행할 작업을 선택하세요(가이드 업데이트하기 참조). 완료되면 "ReadMe에 게시되었습니다."라는 메시지가 표시됩니다. ReadMe에서 열기를 클릭하여 가이드를 확인하세요.
게시가 진행되는 동안 공유 창을 닫아도 됩니다. 완료되면 알림이 표시됩니다.
가이드 주소는 제목에서 생성됩니다. "Set up billing"은 문서 사이트에서 /docs/set-up-billing이 됩니다. 다른 스크립트나 악센트가 포함된 제목은 라틴 문자로 먼저 표기됩니다. 주소가 이미 사용 중인 경우 ReadMe는 새 가이드에 약간 다른 주소를 부여합니다.
ReadMe에서 가이드가 표시되는 방식
가이드 제목은 아티클 제목과 같습니다. 가이드에는 아티클만 포함되며, 아티클의 원본 동영상은 추가되지 않습니다.
| Clevera | ReadMe |
|---|---|
| 제목, 단락 | 제목 및 텍스트 |
| 굵게, 기울임꼴, 취소선, 인라인 코드, 링크 | 유지됨. 다른 Clevera 페이지로의 링크는 텍스트만 유지됨. |
| 강조, 위첨자, 아래첨자 | 유지됨 |
| 글머리 기호 및 번호 매기기 목록, 체크리스트 | 목록 및 체크리스트 |
| 인용구 | 인용구 |
| 코드 블록 | 언어 및 코드 제목이 포함된 코드 블록 |
| 구분선 | 구분선 |
| 표 | 각 셀의 텍스트가 포함된 표 |
| 콜아웃 | 콜아웃 제목이 포함된 ReadMe 콜아웃: 정보 및 참고는 📘, 팁 및 성공은 👍, 경고는 🚧, 위험은 ❗️ |
| 번호 매기기 단계 | 번호 매기기 목록: 각 단계의 제목은 굵게 표시되고 내용은 그 아래에 중첩됨 |
| 탭 | 각 탭의 레이블은 굵게 표시되고 그 뒤에 내용이 옴. 코드만 포함된 탭은 ReadMe 코드 탭이 됨. |
| 접기 섹션 | 확장 가능한 섹션 |
| 카드 | 설명이 포함된 링크 목록; 카드 아이콘은 제외됨 |
| 수식 | 코드 |
| 스크린샷 | ReadMe로 업로드된 이미지, 캡션은 기울임꼴로 표시됨 |
| 아티클 내 동영상 및 임베드 | ReadMe 임베드. Clevera 동영상은 해당 동영상의 공유 링크가 켜져 있을 때만 포함됨. |
텍스트의 중괄호와 꺾쇠괄호는 이스케이프 처리되므로 ReadMe 페이지 형식에서 작성한 대로 표시됩니다.
스크린샷은 ReadMe로 업로드되므로 Clevera에서 아티클을 삭제해도 계속 작동합니다. 업로드에 실패한 스크린샷이나 아티클 내의 동영상 파일은 일정 시간이 지나면 만료되는 Clevera 링크로 유지됩니다. 다시 게시하여 갱신하세요.
가이드 업데이트하기
게시는 단방향으로만 진행됩니다. Clevera에서 아티클을 편집해도 가이드는 업데이트되지 않으며, ReadMe에서 편집한 내용은 Clevera로 돌아오지 않습니다. 아티클을 편집한 후 다시 게시하세요.
Clevera는 가이드 내 어디에서나 동일한 주소의 가이드를 찾고 "이 아티클은 이미 ReadMe에 있습니다."를 표시합니다. 보기를 클릭하여 열고 다음 중 하나를 선택하세요:
- 기존 아티클 업데이트는 해당 가이드를 덮어씁니다(동일한 주소, 새 제목 및 내용). ReadMe에서 업데이트를 클릭하세요.
- 새 아티클 만들기는 입력한 새 제목으로 고유한 주소를 가진 새 가이드를 만듭니다. 새 아티클 만들기를 클릭하세요.
마지막 게시 이후 ReadMe에서 변경된 내용은 Clevera가 가이드를 업데이트할 때 덮어쓰여집니다.
연결 해제 및 액세스 권한 취소
- Clevera에서 연동을 열고 ReadMe를 클릭한 다음 연결 해제를 선택하고 확인하세요. 이미 게시한 가이드는 ReadMe에 그대로 유지됩니다.
- ReadMe에서 Configuration → API Keys를 열고 Clevera에 제공한 키를 삭제하세요.
문제 해결
| 표시되는 메시지 | 해결 방법 |
|---|---|
| "먼저 키를 붙여넣으세요." | 키 필드가 비어 있습니다. |
| "유효하지 않은 API 키입니다. ReadMe API 키를 확인하세요." | 키가 잘못되었거나 삭제되었습니다. Configuration → API Keys에서 다시 복사하세요. |
| "ReadMe에서 프로젝트 정보를 가져오지 못했습니다." 또는 "키를 확인할 수 없습니다. 다시 시도하세요." | ReadMe가 응답하지 않거나, 프로젝트가 Clevera에 필요한 ReadMe Refactored에 있지 않습니다. 다시 시도하고 새 키를 사용해 보세요. 프로젝트가 ReadMe의 이전 플랫폼에 있는 경우 연결할 수 없습니다. |
| "API 키를 확인할 수 없습니다. ReadMe API 키를 확인하세요." 또는 "ReadMe에 연결하지 못했습니다. API 키를 확인하세요." | 키를 확인하고 다시 연결하세요. |
| "아직 가이드 카테고리가 없습니다" / "게시하려면 ReadMe에서 가이드 카테고리를 만드세요." | ReadMe의 가이드에 카테고리를 추가한 다음 게시 탭을 다시 여세요. |
| "먼저 카테고리를 선택하세요." 또는 "이 가이드를 게시할 ReadMe 카테고리를 선택하세요." | 게시하기 전에 가이드 카테고리를 선택하세요. |
| "이 항목을 볼 수는 있지만 게시할 수는 없습니다. 편집 권한이 있는 사람에게 요청하세요." | 게시하려면 아티클에 대한 편집 권한이 필요합니다. |
| "API 키를 찾을 수 없습니다. ReadMe를 다시 연결하세요." | 키를 사용하여 ReadMe를 다시 연결하세요. |
| "아티클 내용이 비어 있거나 유효하지 않습니다." | 아티클에 아직 내용이 없습니다. 아티클을 열고 확인한 후 게시하세요. |
| "ReadMe에 게시할 수 없습니다"와 ReadMe 메시지(슬러그 또는 카테고리 관련 등) | ReadMe가 가이드를 거부했습니다. 카테고리가 여전히 존재하는지 확인하거나 아티클 이름을 변경하고 다시 시도를 클릭하세요. |
| "ReadMe의 가이드를 업데이트하지 못했습니다." | 업데이트하려는 가이드가 ReadMe에서 삭제되었거나 이름이 변경되었습니다. 다시 게시하고 새 아티클 만들기를 선택하세요. |
| "ReadMe에 게시하지 못했습니다. 다시 시도하세요." | 다시 시도를 클릭하세요. 계속 실패하면 새 키로 다시 연결하세요. |