InfoGrab Docs

위키

요약

위키는 친숙한 형식으로 프로젝트 및 그룹 문서를 제공합니다. 각 위키는 별개의 Git 저장소입니다. 위키 페이지에는 사용자 지정할 수 있는 사이드바가 표시됩니다. Plan > Wiki가 프로젝트의 왼쪽 사이드바에 나열되지 않으면 프로젝트 관리자가 비활성화한 것입니다.

위키는 친숙한 형식으로 프로젝트 및 그룹 문서를 제공합니다. 위키 페이지:

  • Markdown, RDoc, AsciiDoc 또는 Org 형식으로 기술 문서, 가이드, 지식 기반을 생성합니다.
  • GitLab 프로젝트 및 그룹과 직접 통합되는 협업 문서를 만듭니다.
  • 버전 제어 및 협업을 위해 Git 저장소에 문서를 저장합니다.
  • 사이드바 사용자 지정을 통해 사용자 지정 탐색 및 구성을 지원합니다.
  • 오프라인 액세스 및 공유를 위해 콘텐츠를 PDF 파일로 내보냅니다.
  • 코드베이스와 같은 프로젝트에 유지하면서 콘텐츠를 별도로 관리합니다.

각 위키는 별개의 Git 저장소입니다. GitLab 웹 인터페이스 또는 Git을 사용하여 로컬에서 위키 페이지를 만들고 편집할 수 있습니다. Markdown으로 작성된 위키 페이지는 모든 Markdown 기능을 지원하고 링크에 대한 위키별 동작을 제공합니다.

위키 페이지에는 사용자 지정할 수 있는 사이드바가 표시됩니다.

프로젝트 위키 보기#

프로젝트 위키에 액세스하려면:

  1. 상단 표시줄에서 Search or go to를 선택하고 프로젝트를 찾습니다.
  2. 위키를 표시하려면 다음 중 하나를 수행합니다:
    • 왼쪽 사이드바에서 Plan > Wiki를 선택합니다.
    • 프로젝트의 임의의 페이지에서 g+w 위키 키보드 단축키를 사용합니다.

Plan > Wiki가 프로젝트의 왼쪽 사이드바에 나열되지 않으면 프로젝트 관리자가 비활성화한 것입니다.

위키의 기본 브랜치 구성#

위키 저장소는 인스턴스 또는 그룹에서 기본 브랜치 이름을 상속합니다. 사용자 지정 브랜치 이름이 구성되지 않은 경우 GitLab은 main을 사용합니다. 위키의 기본 브랜치 이름을 변경하려면 저장소에서 기본 브랜치 이름을 업데이트하십시오.

위키 홈 페이지 만들기#

히스토리
  • GitLab 17.2에서 wiki_front_matterwiki_front_matter_title이라는 플래그와 함께 페이지 제목과 경로의 분리가 도입되었습니다. 기본적으로 활성화되어 있습니다.
  • GitLab 17.3에서 기능 플래그 wiki_front_matterwiki_front_matter_title이 제거되었습니다.

위키가 생성되면 비어 있습니다. 처음 방문할 때 위키를 볼 때 사용자에게 표시되는 홈 페이지를 만들 수 있습니다. 이 페이지는 위키의 홈 페이지로 사용하기 위해 특정 경로가 필요합니다. 이를 만들려면:

  1. 상단 표시줄에서 Search or go to를 선택하고 프로젝트 또는 그룹을 찾습니다.
  2. 왼쪽 사이드바에서 Plan > Wiki를 선택합니다.
  3. Create your first page를 선택합니다.
  4. 선택사항. 홈 페이지의 Title을 변경합니다.
  5. GitLab은 이 첫 번째 페이지의 경로를 home으로 요구합니다. 이 경로의 페이지가 위키의 첫 페이지 역할을 합니다.
  6. 텍스트 스타일을 위한 Format을 선택합니다.
  7. Content 섹션에서 홈 페이지의 환영 메시지를 추가합니다. 나중에 언제든지 편집할 수 있습니다.
  8. Commit message를 추가합니다. Git은 커밋 메시지가 필요하므로 직접 입력하지 않으면 GitLab이 하나를 만듭니다.
  9. Create page를 선택합니다.

새 위키 페이지 만들기#

히스토리
  • GitLab 17.2에서 wiki_front_matterwiki_front_matter_title이라는 플래그와 함께 페이지 제목과 경로의 분리가 도입되었습니다. 기본적으로 활성화되어 있습니다.
  • GitLab 17.3에서 기능 플래그 wiki_front_matterwiki_front_matter_title이 제거되었습니다.

사전 요건:

  • Developer, Maintainer 또는 Owner 역할.

프로젝트 또는 그룹에서 새 위키 페이지를 만들려면:

  1. 상단 표시줄에서 Search or go to를 선택하고 그룹 또는 프로젝트를 찾습니다.
  2. 오른쪽 상단 모서리에서 Create new (+)를 선택한 다음 New wiki page를 선택합니다.

또는:

  1. 상단 표시줄에서 Search or go to를 선택하고 프로젝트 또는 그룹을 찾습니다.
  2. 왼쪽 사이드바에서 Plan > Wiki를 선택합니다.
  3. 이 페이지 또는 다른 위키 페이지에서 Wiki actions (⋮), New page를 선택합니다.

새 페이지 양식을 열고 다음 단계를 완료합니다:

  1. 콘텐츠 형식을 선택합니다.
  2. 새 페이지의 Title을 추가합니다.
  3. 선택사항. Generate page path from title 체크 박스를 해제하고 페이지의 Path를 변경합니다. 페이지 경로는 하위 디렉토리 및 형식 지정을 위해 특수 문자를 사용하며 길이 제한이 있습니다.
  4. 선택사항. 위키 페이지에 콘텐츠를 추가합니다.
  5. 선택사항. 파일을 첨부하면 GitLab이 위키의 Git 저장소에 저장합니다.
  6. Commit message를 추가합니다. Git은 커밋 메시지가 필요하므로 직접 입력하지 않으면 GitLab이 하나를 만듭니다.
  7. Create page를 선택합니다.

템플릿에서 만들기#

히스토리
  • GitLab 18.6에서 템플릿에서 직접 새 위키 페이지 만들기가 도입되었습니다.

프로젝트에 템플릿이 하나 이상 있는 경우 템플릿을 사용하여 새 위키 페이지를 만들 수 있습니다.

사전 요건:

  • 이미 만든 템플릿이 하나 이상 있어야 합니다.
  1. 상단 표시줄에서 Search or go to를 선택하고 프로젝트 또는 그룹을 찾습니다.
  2. 왼쪽 사이드바에서 Plan > Wiki를 선택합니다.
  3. Templates를 선택하여 사용 가능한 모든 템플릿을 봅니다.
  4. 사용하려는 템플릿 옆에서 Create from template을 선택합니다.
  5. 새 페이지 양식이 다음과 함께 열립니다:
    • 콘텐츠 영역에 템플릿 콘텐츠가 미리 채워짐.
    • 템플릿 드롭다운 목록에 템플릿이 선택됨.
  6. 새 페이지의 제목을 입력합니다.
  7. 필요에 따라 콘텐츠를 수정합니다.
  8. Create page를 선택합니다.
  1. 상단 표시줄에서 Search or go to를 선택하고 프로젝트 또는 그룹을 찾습니다.
  2. 왼쪽 사이드바에서 Plan > Wiki를 선택합니다.
  3. Templates를 선택하여 사용 가능한 모든 템플릿을 봅니다.
  4. 사용하려는 템플릿을 선택합니다.
  5. 페이지 헤더에서 Create from template을 선택합니다.
  6. 새 페이지 양식이 현재 템플릿이 미리 선택되고 콘텐츠가 로드된 상태로 열립니다.
  7. 새 페이지의 제목을 입력합니다.
  8. 필요에 따라 콘텐츠를 수정합니다.
  9. Create page를 선택합니다.
  1. 상단 표시줄에서 Search or go to를 선택하고 프로젝트 또는 그룹을 찾습니다.
  2. 왼쪽 사이드바에서 Plan > Wiki를 선택합니다.
  3. New page를 선택합니다.
  4. Choose a template 드롭다운 목록에서 원하는 템플릿을 선택합니다.
  5. 템플릿 콘텐츠가 자동으로 콘텐츠 영역에 로드됩니다.
  6. 페이지의 제목을 입력합니다.
  7. 필요에 따라 콘텐츠를 수정합니다.
  8. Create page를 선택합니다.

위키 페이지를 로컬에서 만들거나 편집하기#

위키는 Git 저장소를 기반으로 하므로 로컬에 클론하고 다른 Git 저장소와 마찬가지로 편집할 수 있습니다. 위키 저장소를 로컬에 클론하려면:

  1. 상단 표시줄에서 Search or go to를 선택하고 프로젝트 또는 그룹을 찾습니다.
  2. 왼쪽 사이드바에서 Plan > Wiki를 선택합니다.
  3. Wiki actions (⋮), Clone repository를 선택합니다.
  4. 화면의 지시를 따릅니다.

위키에 로컬로 추가하는 파일은 사용하려는 마크업 언어에 따라 다음 지원 확장자 중 하나를 사용해야 합니다. 지원되지 않는 확장자의 파일은 GitLab에 푸시할 때 표시되지 않습니다:

  • Markdown 확장자: .mdown, .mkd, .mkdn, .md, .markdown.
  • AsciiDoc 확장자: .adoc, .ad, .asciidoc.
  • 기타 마크업 확장자: .textile, .rdoc, .org, .creole, .wiki, .mediawiki, .rst.

페이지 경로의 특수 문자#

히스토리
  • GitLab 16.7에서 wiki_front_matterwiki_front_matter_title이라는 플래그와 함께 프론트 매터 기반 제목이 도입되었습니다. 기본적으로 비활성화되어 있습니다.
  • GitLab 17.2에서 기능 플래그 wiki_front_matterwiki_front_matter_title이 기본적으로 활성화되었습니다.
  • GitLab 17.3에서 기능 플래그 wiki_front_matterwiki_front_matter_title이 제거되었습니다.

위키 페이지는 Git 저장소에 파일로 저장되며, 기본적으로 파일 이름이 제목이기도 합니다. 파일 이름의 특정 문자는 특별한 의미를 가집니다:

  • 공백은 페이지 저장 시 하이픈으로 변환됩니다.
  • 하이픈(-)은 페이지 표시 시 다시 공백으로 변환됩니다.
  • 슬래시(/)는 경로 구분자로 사용되며 제목에 표시할 수 없습니다. / 문자가 포함된 제목의 파일을 만들면 GitLab이 해당 경로를 만드는 데 필요한 모든 하위 디렉토리를 만듭니다. 예를 들어 docs/my-page 제목은 /wikis/docs/my-page 경로의 위키 페이지를 만듭니다.

이러한 제한을 우회하려면 페이지 콘텐츠 앞의 프론트 매터 블록에 위키 페이지의 제목을 저장할 수도 있습니다. 예:

---
title: Page title
---

파일 및 디렉토리 이름의 길이 제한#

많은 일반 파일 시스템에는 파일 및 디렉토리 이름에 대한 255바이트 제한이 있습니다. Git과 GitLab 모두 이러한 제한을 초과하는 경로를 지원합니다. 그러나 파일 시스템이 이러한 제한을 적용하는 경우 이 제한을 초과하는 파일 이름이 포함된 위키의 로컬 복사본을 체크아웃할 수 없습니다. 이 문제를 방지하기 위해 GitLab 웹 인터페이스와 API는 다음 제한을 적용합니다:

  • 파일 이름의 경우 245바이트 (파일 확장자를 위해 10바이트 예약).
  • 디렉토리 이름의 경우 255바이트.

ASCII가 아닌 문자는 1바이트 이상을 차지합니다.

로컬에서 이러한 제한을 초과하는 파일을 여전히 만들 수 있지만 팀원이 나중에 위키를 로컬에서 체크아웃하지 못할 수 있습니다.

위키 페이지 편집#

사전 요건:

  • Developer, Maintainer 또는 Owner 역할이 있어야 합니다.
  1. 상단 표시줄에서 Search or go to를 선택하고 프로젝트 또는 그룹을 찾습니다.
  2. 왼쪽 사이드바에서 Plan > Wiki를 선택합니다.
  3. 편집하려는 페이지로 이동하여 다음 중 하나를 수행합니다:
  4. 콘텐츠를 편집합니다.
  5. Save changes를 선택합니다.

위키 페이지에 대한 저장되지 않은 변경 사항은 실수로 인한 데이터 손실을 방지하기 위해 로컬 브라우저 스토리지에 보존됩니다.

목차 만들기#

히스토리
  • GitLab 17.2에서 위키 사이드바의 목차가 도입되었습니다.

내용에 제목이 있는 위키 페이지는 사이드바에 목차 섹션을 자동으로 표시합니다.

[[_TOC_]] 태그를 사용하여 위키 페이지의 하위 제목에서 별도의 목차 섹션을 선택적으로 표시하도록 선택할 수도 있습니다. 예시는 목차를 참조하십시오.

위키 페이지 삭제#

사전 요건:

  • Developer, Maintainer 또는 Owner 역할이 있어야 합니다.
  1. 상단 표시줄에서 Search or go to를 선택하고 프로젝트 또는 그룹을 찾습니다.
  2. 왼쪽 사이드바에서 Plan > Wiki를 선택합니다.
  3. 삭제하려는 페이지로 이동합니다.
  4. Wiki actions (⋮), Delete page를 선택합니다.
  5. 삭제를 확인합니다.

위키 페이지 이동 또는 이름 변경#

히스토리
  • GitLab 17.1에서 wiki_redirection이라는 플래그와 함께 이동 또는 이름이 변경된 위키 페이지에 대한 리디렉션이 도입되었습니다. 기본적으로 활성화되어 있습니다.
  • GitLab 17.2에서 wiki_front_matterwiki_front_matter_title이라는 플래그와 함께 페이지 제목과 경로의 분리가 도입되었습니다. 기본적으로 활성화되어 있습니다.
  • GitLab 17.3에서 기능 플래그 wiki_redirection, wiki_front_matterwiki_front_matter_title이 제거되었습니다.

GitLab 17.1 이상에서는 페이지를 이동하거나 이름을 변경하면 이전 페이지에서 새 페이지로의 리디렉션이 자동으로 설정됩니다. 리디렉션 목록은 위키 저장소의 .gitlab/redirects.yml 파일에 저장됩니다.

사전 요건:

  • Developer, Maintainer 또는 Owner 역할이 있어야 합니다.
  1. 상단 표시줄에서 Search or go to를 선택하고 프로젝트 또는 그룹을 찾습니다.
  2. 왼쪽 사이드바에서 Plan > Wiki를 선택합니다.
  3. 이동하거나 이름을 변경하려는 페이지로 이동합니다.
  4. Edit를 선택합니다.
  5. 페이지를 이동하려면 Path 필드에 새 경로를 추가합니다. 예를 들어 Company 아래에 About라는 위키 페이지가 있고 위키의 루트로 이동하려면 PathAbout에서 /About으로 변경합니다.
  6. 페이지 이름을 변경하려면 Path를 변경합니다.
  7. Save changes를 선택합니다.

위키 페이지 내보내기#

히스토리

위키 페이지를 PDF 파일로 내보낼 수 있습니다:

  1. 상단 표시줄에서 Search or go to를 선택하고 프로젝트 또는 그룹을 찾습니다.
  2. 왼쪽 사이드바에서 Plan > Wiki를 선택합니다.
  3. 내보내려는 페이지로 이동합니다.
  4. 오른쪽 상단에서 Wiki actions (⋮)를 선택한 다음 Print as PDF를 선택합니다.

위키 페이지의 PDF가 생성됩니다.

Draw.io를 사용하여 위키에서 다이어그램 만들기#

diagrams.net 통합을 통해 위키 페이지에서 SVG 다이어그램을 만들고 포함할 수 있습니다! 다이어그램 편집기는 일반 텍스트 편집기와 서식 있는 텍스트 편집기 모두에서 사용할 수 있습니다.

GitLab.com에서 이 통합은 모든 SaaS 사용자에게 활성화되어 있으며 추가 구성이 필요하지 않습니다.

GitLab Self-Managed에서는 무료 diagrams.net 웹사이트와 통합하거나 오프라인 환경에서 자체 diagrams.net 사이트를 호스팅할 수 있습니다.

통합을 설정하려면:

  1. 무료 diagrams.net 웹사이트와 통합하거나 diagrams.net 서버를 구성하도록 선택합니다.
  2. 통합을 활성화합니다.

통합을 완료한 후 다이어그램.net 편집기가 제공한 URL로 열립니다.

위키 페이지 템플릿#

히스토리
  • GitLab 16.10에서 도입되었습니다.

새 페이지를 만들거나 기존 페이지에 적용하기 위한 템플릿을 만들 수 있습니다. 템플릿은 위키 저장소의 templates/ 디렉토리에 저장된 위키 페이지입니다.

템플릿 만들기#

사전 요건:

  • Developer, Maintainer 또는 Owner 역할이 있어야 합니다.
  1. 상단 표시줄에서 Search or go to를 선택하고 프로젝트 또는 그룹을 찾습니다.
  2. 왼쪽 사이드바에서 Plan > Wiki를 선택합니다.
  3. Wiki actions (⋮), Templates를 선택합니다.
  4. New Template을 선택합니다.
  5. 일반 위키 페이지를 만드는 것처럼 템플릿 제목, 형식, 콘텐츠를 입력합니다.

특정 형식의 템플릿은 동일한 형식의 페이지에만 적용할 수 있습니다. 예를 들어 Markdown 템플릿은 Markdown 페이지에만 적용됩니다.

템플릿 적용#

위키 페이지를 만들거나 편집하는 경우 템플릿을 적용할 수 있습니다.

사전 요건:

  • 이미 만든 템플릿이 하나 이상 있어야 합니다.
  1. Content 섹션에서 Choose a template 드롭다운 목록을 선택합니다.
  2. 목록에서 템플릿을 선택합니다. 페이지에 이미 콘텐츠가 있으면 기존 콘텐츠가 재정의된다는 경고가 표시됩니다.
  3. Apply template을 선택합니다.

페이지 템플릿을 이전 버전으로 복원#

히스토리
  • GitLab 18.6에서 도입되었습니다.

히스토리에서 위키 페이지 템플릿을 임의의 이전 버전으로 복원할 수 있습니다. 이렇게 하면 전체 버전 기록을 보존하면서 복원된 콘텐츠로 새 버전이 만들어집니다.

사전 요건:

  • Developer, Maintainer 또는 Owner 역할이 있어야 합니다.

위키 페이지 템플릿을 이전 버전으로 복원하려면:

  1. 상단 표시줄에서 Search or go to를 선택하고 프로젝트 또는 그룹을 찾습니다.
  2. 왼쪽 사이드바에서 Plan > Wiki를 선택합니다.
  3. Wiki actions (⋮), Templates를 선택합니다.
  4. 템플릿을 선택합니다.
  5. Wiki actions (⋮), Template history를 선택합니다.
  6. 복원하려는 버전을 선택합니다.
  7. 오른쪽 상단에서 Restore this version을 선택합니다.
  8. 커밋 대화 상자에서 이 버전을 복원하는 이유를 설명하는 Commit message를 추가합니다.
  9. Restore를 선택합니다.

페이지 템플릿이 선택한 버전으로 복원됩니다. 모든 이전 버전은 페이지 기록에 남아 있습니다.

동일한 프로세스를 사용하여 위키 페이지를 복원할 수도 있습니다.

위키 페이지 구독#

위키 페이지 구독 기능을 사용하면 관심 있는 위키 페이지에 변경이 생길 때 알림을 받을 수 있습니다. 이 기능은 중요한 문서 업데이트에 대한 팀 구성원에게 정보를 제공하여 협업을 향상시킬 수 있습니다.

특정 위키 페이지를 구독하여 다음과 같은 경우 알림을 받을 수 있습니다:

  • 누군가 페이지에 댓글을 추가할 때
  • 댓글에 답변할 때

위키 페이지 구독#

  1. 팔로우하려는 위키 페이지를 엽니다.
  2. 오른쪽 상단 모서리에서 Edit 옆에 있는 종 아이콘 ([notifications])을 선택합니다.
  3. 다시 종 아이콘 ([notifications-off])을 선택하여 구독을 취소합니다.

구독 상태를 변경하면 GitLab이 확인 메시지를 표시합니다:

  • 구독된 경우, Notifications turned on
  • 구독 취소된 경우, Notifications turned off

구독 권한#

위키 페이지를 볼 수 있는 액세스 권한이 있는 모든 사용자가 구독할 수 있습니다. 구독 상태는 개인적이며 다른 사용자에게 영향을 미치지 않습니다.

알림 설정#

알림은 프로젝트 알림 설정을 따릅니다. 구성된 알림 채널을 통해 전달됩니다.

위키 페이지의 기록 보기#

시간이 지남에 따른 위키 페이지의 변경 사항이 위키의 Git 저장소에 기록됩니다. 기록 페이지는 다음을 표시합니다:

  • 페이지의 개정 번호.
  • 페이지 작성자.
  • 커밋 메시지.
  • 마지막 업데이트.
  • Page version 열에서 개정 번호를 선택하여 이전 개정.

위키 페이지의 변경 사항을 보려면:

  1. 상단 표시줄에서 Search or go to를 선택하고 프로젝트 또는 그룹을 찾습니다.
  2. 왼쪽 사이드바에서 Plan > Wiki를 선택합니다.
  3. 기록을 보려는 페이지로 이동합니다.
  4. Wiki actions (⋮), Page history를 선택합니다.

페이지 버전 간 변경 사항 보기#

버전이 지정된 diff 파일 보기와 유사하게 위키 페이지의 특정 버전에서 이루어진 변경 사항을 볼 수 있습니다:

  1. 상단 표시줄에서 Search or go to를 선택하고 프로젝트 또는 그룹을 찾습니다.
  2. 왼쪽 사이드바에서 Plan > Wiki를 선택합니다.
  3. 관심 있는 위키 페이지로 이동합니다.
  4. Wiki actions (⋮), Page history를 선택하여 모든 페이지 버전을 봅니다.
  5. 관심 있는 버전의 Diff 열에서 커밋 메시지를 선택합니다.

위키 페이지를 이전 버전으로 복원#

히스토리
  • GitLab 18.6에서 도입되었습니다.

히스토리에서 위키 페이지를 임의의 이전 버전으로 복원할 수 있습니다. 이렇게 하면 전체 버전 기록을 보존하면서 복원된 콘텐츠로 새 버전이 만들어집니다.

사전 요건:

  • Developer, Maintainer 또는 Owner 역할이 있어야 합니다.

위키 페이지를 이전 버전으로 복원하려면:

  1. 상단 표시줄에서 Search or go to를 선택하고 프로젝트 또는 그룹을 찾습니다.
  2. 왼쪽 사이드바에서 Plan > Wiki를 선택합니다.
  3. 복원하려는 페이지로 이동합니다.
  4. Wiki actions (⋮), Page history를 선택합니다.
  5. 복원하려는 버전을 선택합니다.
  6. 오른쪽 상단에서 Restore this version을 선택합니다.
  7. 커밋 대화 상자에서 이 버전을 복원하는 이유를 설명하는 Commit message를 추가합니다.
  8. Restore를 선택합니다.

페이지가 선택한 버전으로 복원됩니다. 모든 이전 버전은 페이지 기록에 남아 있습니다.

동일한 프로세스를 사용하여 위키 페이지 템플릿을 복원할 수도 있습니다.

사이드바#

히스토리
  • GitLab 17.1에서 사이드바에서 제목으로 검색이 도입되었습니다.
  • GitLab 17.2에서 사이드바의 15개 항목 제한이 제거되었습니다.
  • GitLab 18.6에서 사이드바가 페이지의 오른쪽 상단에서 왼쪽 상단으로 이동되었습니다.
  • GitLab 18.9에서 wiki_floating_sidebar_toggle이라는 플래그와 함께 부동 사이드바 토글이 도입되었습니다. 기본적으로 비활성화되어 있습니다.

위키 페이지에는 위키의 페이지 목록이 포함된 사이드바가 표시되며, 중첩 트리로 표시되고 형제 페이지는 알파벳 순서로 나열됩니다.

사이드바의 검색 상자를 사용하여 위키에서 제목으로 페이지를 찾을 수 있습니다. 페이지의 왼쪽 상단 모서리에 있는 사이드바 토글 ([sidebar])을 사용하여 사이드바를 열거나 닫을 수 있습니다.

성능상의 이유로 사이드바는 5000개 항목 표시로 제한됩니다. 모든 페이지 목록을 보려면 사이드바에서 View All Pages를 선택합니다.

사이드바 사용자 지정#

사이드바 탐색의 내용을 수동으로 편집할 수 있습니다.

사전 요건:

  • Developer, Maintainer 또는 Owner 역할이 있어야 합니다.

이 프로세스는 기본 사이드바 탐색을 완전히 대체하는 _sidebar라는 위키 페이지를 만듭니다:

  1. 상단 표시줄에서 Search or go to를 선택하고 프로젝트 또는 그룹을 찾습니다.
  2. 왼쪽 사이드바에서 Plan > Wiki를 선택합니다.
  3. 페이지의 왼쪽 상단 모서리에서 Add custom sidebar (⚙️)를 선택합니다.
  4. 완료되면 Save changes를 선택합니다.

Markdown으로 형식이 지정된 _sidebar 예시:

### Home

- [Hello World](hello)
- [Foo](foo)
- [Bar](bar)

---

- [Sidebar](_sidebar)

프로젝트 위키 활성화 또는 비활성화#

위키는 GitLab에서 기본적으로 활성화되어 있습니다. 프로젝트 관리자공유 및 권한의 지침에 따라 프로젝트 위키를 활성화하거나 비활성화할 수 있습니다.

GitLab Self-Managed의 관리자는 추가 위키 설정을 구성할 수 있습니다.

그룹 설정에서 그룹 위키를 비활성화할 수 있습니다.

외부 위키 연결#

프로젝트의 왼쪽 사이드바에서 외부 위키 링크를 추가하려면:

  1. 상단 표시줄에서 Search or go to를 선택하고 프로젝트를 찾습니다.
  2. Settings > Integrations를 선택합니다.
  3. External wiki를 선택합니다.
  4. 외부 위키의 URL을 추가합니다.
  5. 선택사항. Test settings를 선택합니다.
  6. Save changes를 선택합니다.

이제 프로젝트의 왼쪽 사이드바에서 External wiki 옵션을 볼 수 있습니다.

이 통합을 활성화하면 외부 위키 링크가 내부 위키 링크를 대체하지 않습니다. 사이드바에서 내부 위키를 숨기려면 프로젝트의 위키를 비활성화하십시오.

외부 위키 링크를 숨기려면:

  1. 상단 표시줄에서 Search or go to를 선택하고 프로젝트를 찾습니다.
  2. Settings > Integrations를 선택합니다.
  3. External wiki를 선택합니다.
  4. Enable integration 아래에서 Active 체크 박스를 선택 해제합니다.
  5. Save changes를 선택합니다.

프로젝트의 위키 비활성화#

프로젝트의 내부 위키를 비활성화하려면:

  1. 상단 표시줄에서 Search or go to를 선택하고 프로젝트를 찾습니다.
  2. Settings > General을 선택합니다.
  3. Visibility, project features, permissions를 펼칩니다.
  4. 아래로 스크롤하여 Wiki 토글을 찾아 끄기(회색)로 설정합니다.
  5. Save changes를 선택합니다.

내부 위키가 비활성화되었으며 사용자 및 프로젝트 구성원은:

  • 프로젝트의 사이드바에서 위키 링크를 찾을 수 없습니다.
  • 위키 페이지를 추가, 삭제 또는 편집할 수 없습니다.
  • 위키 페이지를 볼 수 없습니다.

위키를 다시 활성화하고 싶을 경우를 대비하여 이전에 추가된 위키 페이지는 보존됩니다. 다시 활성화하려면 위키를 비활성화하는 프로세스를 반복하되 토글을 켜기(파란색)로 설정합니다.

서식 있는 텍스트 편집기#

히스토리
  • GitLab 16.2에서 콘텐츠 편집기에서 서식 있는 텍스트 편집기로 이름이 변경되었습니다.

GitLab은 위키에서 GitLab Flavored Markdown을 위한 서식 있는 텍스트 편집 경험을 제공합니다.

지원 항목:

  • 굵게, 이탤릭체, 블록 인용, 제목, 인라인 코드를 포함한 텍스트 서식.
  • 순서가 있는 목록, 순서가 없는 목록, 체크리스트 서식.
  • 표 구조 만들기 및 편집.
  • 구문 강조를 사용하여 코드 블록 삽입 및 서식.
  • Mermaid, PlantUML, Kroki 다이어그램 미리 보기.

서식 있는 텍스트 편집기 사용#

  1. 새 위키 페이지를 만들거나 기존 페이지를 편집합니다.
  2. 형식으로 Markdown을 선택합니다.
  3. Content 아래의 왼쪽 하단 모서리에서 Switch to rich text editing을 선택합니다.
  4. 서식 있는 텍스트 편집기에서 사용 가능한 다양한 서식 옵션을 사용하여 페이지 콘텐츠를 사용자 지정합니다.
  5. 새 페이지의 경우 Create page를 선택하고, 기존 페이지의 경우 Save changes를 선택합니다.

일반 텍스트로 다시 전환하려면 Switch to plain text editing을 선택합니다.

참조:

GitLab Flavored Markdown 지원#

서식 있는 텍스트 편집기에서 모든 GitLab Flavored Markdown 콘텐츠 유형 지원은 진행 중입니다. CommonMark 및 GitLab Flavored Markdown 지원에 대한 지속적인 개발 상태를 보려면 다음을 읽으십시오:

위키 이벤트 추적#

GitLab은 위키 생성, 삭제, 업데이트 이벤트를 추적합니다. 이러한 이벤트는 다음 페이지에 표시됩니다:

위키에 대한 커밋은 저장소 분석에 계산되지 않습니다.

문제 해결#

Apache 역방향 프록시를 사용한 페이지 슬러그 렌더링#

페이지 슬러그는 ERB::Util.url_encode 메서드를 사용하여 인코딩됩니다. Apache 역방향 프록시를 사용하는 경우 Apache 구성의 ProxyPass 줄에 nocanon 인수를 추가하여 페이지 슬러그가 올바르게 렌더링되도록 할 수 있습니다.

Rails 콘솔로 프로젝트 위키 재생성#

Warning

이 작업은 위키의 모든 데이터를 삭제합니다.

데이터를 직접 변경하는 모든 명령은 올바르게 실행되지 않거나 적절한 조건에서 실행되지 않으면 손상을 일으킬 수 있습니다. 만약의 경우 복원할 준비가 된 인스턴스 백업을 유지하면서 테스트 환경에서 실행하는 것을 강력히 권장합니다.

프로젝트 위키에서 모든 데이터를 지우고 빈 상태로 다시 만들려면:

  1. Rails 콘솔 세션을 시작합니다.

  2. 다음 명령을 실행합니다:

    # Enter your project's path
    p = Project.find_by_full_path('<username-or-group>/<project-name>')
    
    # This command deletes the wiki project from the filesystem.
    p.wiki.repository.remove
    
    # Refresh the wiki repository state.
    p.wiki.repository.expire_exists_cache
    

위키의 모든 데이터가 지워졌으며 위키를 사용할 준비가 되었습니다.

관련 주제#

위키

Tier: Free, Premium, Ultimate
Offering: GitLab Self-Managed, GitLab Dedicated
원문 보기
요약

위키는 친숙한 형식으로 프로젝트 및 그룹 문서를 제공합니다. 각 위키는 별개의 Git 저장소입니다. 위키 페이지에는 사용자 지정할 수 있는 사이드바가 표시됩니다. Plan > Wiki가 프로젝트의 왼쪽 사이드바에 나열되지 않으면 프로젝트 관리자가 비활성화한 것입니다.

위키는 친숙한 형식으로 프로젝트 및 그룹 문서를 제공합니다. 위키 페이지:

  • Markdown, RDoc, AsciiDoc 또는 Org 형식으로 기술 문서, 가이드, 지식 기반을 생성합니다.
  • GitLab 프로젝트 및 그룹과 직접 통합되는 협업 문서를 만듭니다.
  • 버전 제어 및 협업을 위해 Git 저장소에 문서를 저장합니다.
  • 사이드바 사용자 지정을 통해 사용자 지정 탐색 및 구성을 지원합니다.
  • 오프라인 액세스 및 공유를 위해 콘텐츠를 PDF 파일로 내보냅니다.
  • 코드베이스와 같은 프로젝트에 유지하면서 콘텐츠를 별도로 관리합니다.

각 위키는 별개의 Git 저장소입니다. GitLab 웹 인터페이스 또는 Git을 사용하여 로컬에서 위키 페이지를 만들고 편집할 수 있습니다. Markdown으로 작성된 위키 페이지는 모든 Markdown 기능을 지원하고 링크에 대한 위키별 동작을 제공합니다.

위키 페이지에는 사용자 지정할 수 있는 사이드바가 표시됩니다.

프로젝트 위키 보기#

프로젝트 위키에 액세스하려면:

  1. 상단 표시줄에서 Search or go to를 선택하고 프로젝트를 찾습니다.
  2. 위키를 표시하려면 다음 중 하나를 수행합니다:
    • 왼쪽 사이드바에서 Plan > Wiki를 선택합니다.
    • 프로젝트의 임의의 페이지에서 g+w 위키 키보드 단축키를 사용합니다.

Plan > Wiki가 프로젝트의 왼쪽 사이드바에 나열되지 않으면 프로젝트 관리자가 비활성화한 것입니다.

위키의 기본 브랜치 구성#

위키 저장소는 인스턴스 또는 그룹에서 기본 브랜치 이름을 상속합니다. 사용자 지정 브랜치 이름이 구성되지 않은 경우 GitLab은 main을 사용합니다. 위키의 기본 브랜치 이름을 변경하려면 저장소에서 기본 브랜치 이름을 업데이트하십시오.

위키 홈 페이지 만들기#

히스토리
  • GitLab 17.2에서 wiki_front_matterwiki_front_matter_title이라는 플래그와 함께 페이지 제목과 경로의 분리가 도입되었습니다. 기본적으로 활성화되어 있습니다.
  • GitLab 17.3에서 기능 플래그 wiki_front_matterwiki_front_matter_title이 제거되었습니다.

위키가 생성되면 비어 있습니다. 처음 방문할 때 위키를 볼 때 사용자에게 표시되는 홈 페이지를 만들 수 있습니다. 이 페이지는 위키의 홈 페이지로 사용하기 위해 특정 경로가 필요합니다. 이를 만들려면:

  1. 상단 표시줄에서 Search or go to를 선택하고 프로젝트 또는 그룹을 찾습니다.
  2. 왼쪽 사이드바에서 Plan > Wiki를 선택합니다.
  3. Create your first page를 선택합니다.
  4. 선택사항. 홈 페이지의 Title을 변경합니다.
  5. GitLab은 이 첫 번째 페이지의 경로를 home으로 요구합니다. 이 경로의 페이지가 위키의 첫 페이지 역할을 합니다.
  6. 텍스트 스타일을 위한 Format을 선택합니다.
  7. Content 섹션에서 홈 페이지의 환영 메시지를 추가합니다. 나중에 언제든지 편집할 수 있습니다.
  8. Commit message를 추가합니다. Git은 커밋 메시지가 필요하므로 직접 입력하지 않으면 GitLab이 하나를 만듭니다.
  9. Create page를 선택합니다.

새 위키 페이지 만들기#

히스토리
  • GitLab 17.2에서 wiki_front_matterwiki_front_matter_title이라는 플래그와 함께 페이지 제목과 경로의 분리가 도입되었습니다. 기본적으로 활성화되어 있습니다.
  • GitLab 17.3에서 기능 플래그 wiki_front_matterwiki_front_matter_title이 제거되었습니다.

사전 요건:

  • Developer, Maintainer 또는 Owner 역할.

프로젝트 또는 그룹에서 새 위키 페이지를 만들려면:

  1. 상단 표시줄에서 Search or go to를 선택하고 그룹 또는 프로젝트를 찾습니다.
  2. 오른쪽 상단 모서리에서 Create new (+)를 선택한 다음 New wiki page를 선택합니다.

또는:

  1. 상단 표시줄에서 Search or go to를 선택하고 프로젝트 또는 그룹을 찾습니다.
  2. 왼쪽 사이드바에서 Plan > Wiki를 선택합니다.
  3. 이 페이지 또는 다른 위키 페이지에서 Wiki actions (⋮), New page를 선택합니다.

새 페이지 양식을 열고 다음 단계를 완료합니다:

  1. 콘텐츠 형식을 선택합니다.
  2. 새 페이지의 Title을 추가합니다.
  3. 선택사항. Generate page path from title 체크 박스를 해제하고 페이지의 Path를 변경합니다. 페이지 경로는 하위 디렉토리 및 형식 지정을 위해 특수 문자를 사용하며 길이 제한이 있습니다.
  4. 선택사항. 위키 페이지에 콘텐츠를 추가합니다.
  5. 선택사항. 파일을 첨부하면 GitLab이 위키의 Git 저장소에 저장합니다.
  6. Commit message를 추가합니다. Git은 커밋 메시지가 필요하므로 직접 입력하지 않으면 GitLab이 하나를 만듭니다.
  7. Create page를 선택합니다.

템플릿에서 만들기#

히스토리
  • GitLab 18.6에서 템플릿에서 직접 새 위키 페이지 만들기가 도입되었습니다.

프로젝트에 템플릿이 하나 이상 있는 경우 템플릿을 사용하여 새 위키 페이지를 만들 수 있습니다.

사전 요건:

  • 이미 만든 템플릿이 하나 이상 있어야 합니다.
  1. 상단 표시줄에서 Search or go to를 선택하고 프로젝트 또는 그룹을 찾습니다.
  2. 왼쪽 사이드바에서 Plan > Wiki를 선택합니다.
  3. Templates를 선택하여 사용 가능한 모든 템플릿을 봅니다.
  4. 사용하려는 템플릿 옆에서 Create from template을 선택합니다.
  5. 새 페이지 양식이 다음과 함께 열립니다:
    • 콘텐츠 영역에 템플릿 콘텐츠가 미리 채워짐.
    • 템플릿 드롭다운 목록에 템플릿이 선택됨.
  6. 새 페이지의 제목을 입력합니다.
  7. 필요에 따라 콘텐츠를 수정합니다.
  8. Create page를 선택합니다.
  1. 상단 표시줄에서 Search or go to를 선택하고 프로젝트 또는 그룹을 찾습니다.
  2. 왼쪽 사이드바에서 Plan > Wiki를 선택합니다.
  3. Templates를 선택하여 사용 가능한 모든 템플릿을 봅니다.
  4. 사용하려는 템플릿을 선택합니다.
  5. 페이지 헤더에서 Create from template을 선택합니다.
  6. 새 페이지 양식이 현재 템플릿이 미리 선택되고 콘텐츠가 로드된 상태로 열립니다.
  7. 새 페이지의 제목을 입력합니다.
  8. 필요에 따라 콘텐츠를 수정합니다.
  9. Create page를 선택합니다.
  1. 상단 표시줄에서 Search or go to를 선택하고 프로젝트 또는 그룹을 찾습니다.
  2. 왼쪽 사이드바에서 Plan > Wiki를 선택합니다.
  3. New page를 선택합니다.
  4. Choose a template 드롭다운 목록에서 원하는 템플릿을 선택합니다.
  5. 템플릿 콘텐츠가 자동으로 콘텐츠 영역에 로드됩니다.
  6. 페이지의 제목을 입력합니다.
  7. 필요에 따라 콘텐츠를 수정합니다.
  8. Create page를 선택합니다.

위키 페이지를 로컬에서 만들거나 편집하기#

위키는 Git 저장소를 기반으로 하므로 로컬에 클론하고 다른 Git 저장소와 마찬가지로 편집할 수 있습니다. 위키 저장소를 로컬에 클론하려면:

  1. 상단 표시줄에서 Search or go to를 선택하고 프로젝트 또는 그룹을 찾습니다.
  2. 왼쪽 사이드바에서 Plan > Wiki를 선택합니다.
  3. Wiki actions (⋮), Clone repository를 선택합니다.
  4. 화면의 지시를 따릅니다.

위키에 로컬로 추가하는 파일은 사용하려는 마크업 언어에 따라 다음 지원 확장자 중 하나를 사용해야 합니다. 지원되지 않는 확장자의 파일은 GitLab에 푸시할 때 표시되지 않습니다:

  • Markdown 확장자: .mdown, .mkd, .mkdn, .md, .markdown.
  • AsciiDoc 확장자: .adoc, .ad, .asciidoc.
  • 기타 마크업 확장자: .textile, .rdoc, .org, .creole, .wiki, .mediawiki, .rst.

페이지 경로의 특수 문자#

히스토리
  • GitLab 16.7에서 wiki_front_matterwiki_front_matter_title이라는 플래그와 함께 프론트 매터 기반 제목이 도입되었습니다. 기본적으로 비활성화되어 있습니다.
  • GitLab 17.2에서 기능 플래그 wiki_front_matterwiki_front_matter_title이 기본적으로 활성화되었습니다.
  • GitLab 17.3에서 기능 플래그 wiki_front_matterwiki_front_matter_title이 제거되었습니다.

위키 페이지는 Git 저장소에 파일로 저장되며, 기본적으로 파일 이름이 제목이기도 합니다. 파일 이름의 특정 문자는 특별한 의미를 가집니다:

  • 공백은 페이지 저장 시 하이픈으로 변환됩니다.
  • 하이픈(-)은 페이지 표시 시 다시 공백으로 변환됩니다.
  • 슬래시(/)는 경로 구분자로 사용되며 제목에 표시할 수 없습니다. / 문자가 포함된 제목의 파일을 만들면 GitLab이 해당 경로를 만드는 데 필요한 모든 하위 디렉토리를 만듭니다. 예를 들어 docs/my-page 제목은 /wikis/docs/my-page 경로의 위키 페이지를 만듭니다.

이러한 제한을 우회하려면 페이지 콘텐츠 앞의 프론트 매터 블록에 위키 페이지의 제목을 저장할 수도 있습니다. 예:

---
title: Page title
---

파일 및 디렉토리 이름의 길이 제한#

많은 일반 파일 시스템에는 파일 및 디렉토리 이름에 대한 255바이트 제한이 있습니다. Git과 GitLab 모두 이러한 제한을 초과하는 경로를 지원합니다. 그러나 파일 시스템이 이러한 제한을 적용하는 경우 이 제한을 초과하는 파일 이름이 포함된 위키의 로컬 복사본을 체크아웃할 수 없습니다. 이 문제를 방지하기 위해 GitLab 웹 인터페이스와 API는 다음 제한을 적용합니다:

  • 파일 이름의 경우 245바이트 (파일 확장자를 위해 10바이트 예약).
  • 디렉토리 이름의 경우 255바이트.

ASCII가 아닌 문자는 1바이트 이상을 차지합니다.

로컬에서 이러한 제한을 초과하는 파일을 여전히 만들 수 있지만 팀원이 나중에 위키를 로컬에서 체크아웃하지 못할 수 있습니다.

위키 페이지 편집#

사전 요건:

  • Developer, Maintainer 또는 Owner 역할이 있어야 합니다.
  1. 상단 표시줄에서 Search or go to를 선택하고 프로젝트 또는 그룹을 찾습니다.
  2. 왼쪽 사이드바에서 Plan > Wiki를 선택합니다.
  3. 편집하려는 페이지로 이동하여 다음 중 하나를 수행합니다:
  4. 콘텐츠를 편집합니다.
  5. Save changes를 선택합니다.

위키 페이지에 대한 저장되지 않은 변경 사항은 실수로 인한 데이터 손실을 방지하기 위해 로컬 브라우저 스토리지에 보존됩니다.

목차 만들기#

히스토리
  • GitLab 17.2에서 위키 사이드바의 목차가 도입되었습니다.

내용에 제목이 있는 위키 페이지는 사이드바에 목차 섹션을 자동으로 표시합니다.

[[_TOC_]] 태그를 사용하여 위키 페이지의 하위 제목에서 별도의 목차 섹션을 선택적으로 표시하도록 선택할 수도 있습니다. 예시는 목차를 참조하십시오.

위키 페이지 삭제#

사전 요건:

  • Developer, Maintainer 또는 Owner 역할이 있어야 합니다.
  1. 상단 표시줄에서 Search or go to를 선택하고 프로젝트 또는 그룹을 찾습니다.
  2. 왼쪽 사이드바에서 Plan > Wiki를 선택합니다.
  3. 삭제하려는 페이지로 이동합니다.
  4. Wiki actions (⋮), Delete page를 선택합니다.
  5. 삭제를 확인합니다.

위키 페이지 이동 또는 이름 변경#

히스토리
  • GitLab 17.1에서 wiki_redirection이라는 플래그와 함께 이동 또는 이름이 변경된 위키 페이지에 대한 리디렉션이 도입되었습니다. 기본적으로 활성화되어 있습니다.
  • GitLab 17.2에서 wiki_front_matterwiki_front_matter_title이라는 플래그와 함께 페이지 제목과 경로의 분리가 도입되었습니다. 기본적으로 활성화되어 있습니다.
  • GitLab 17.3에서 기능 플래그 wiki_redirection, wiki_front_matterwiki_front_matter_title이 제거되었습니다.

GitLab 17.1 이상에서는 페이지를 이동하거나 이름을 변경하면 이전 페이지에서 새 페이지로의 리디렉션이 자동으로 설정됩니다. 리디렉션 목록은 위키 저장소의 .gitlab/redirects.yml 파일에 저장됩니다.

사전 요건:

  • Developer, Maintainer 또는 Owner 역할이 있어야 합니다.
  1. 상단 표시줄에서 Search or go to를 선택하고 프로젝트 또는 그룹을 찾습니다.
  2. 왼쪽 사이드바에서 Plan > Wiki를 선택합니다.
  3. 이동하거나 이름을 변경하려는 페이지로 이동합니다.
  4. Edit를 선택합니다.
  5. 페이지를 이동하려면 Path 필드에 새 경로를 추가합니다. 예를 들어 Company 아래에 About라는 위키 페이지가 있고 위키의 루트로 이동하려면 PathAbout에서 /About으로 변경합니다.
  6. 페이지 이름을 변경하려면 Path를 변경합니다.
  7. Save changes를 선택합니다.

위키 페이지 내보내기#

히스토리

위키 페이지를 PDF 파일로 내보낼 수 있습니다:

  1. 상단 표시줄에서 Search or go to를 선택하고 프로젝트 또는 그룹을 찾습니다.
  2. 왼쪽 사이드바에서 Plan > Wiki를 선택합니다.
  3. 내보내려는 페이지로 이동합니다.
  4. 오른쪽 상단에서 Wiki actions (⋮)를 선택한 다음 Print as PDF를 선택합니다.

위키 페이지의 PDF가 생성됩니다.

Draw.io를 사용하여 위키에서 다이어그램 만들기#

diagrams.net 통합을 통해 위키 페이지에서 SVG 다이어그램을 만들고 포함할 수 있습니다! 다이어그램 편집기는 일반 텍스트 편집기와 서식 있는 텍스트 편집기 모두에서 사용할 수 있습니다.

GitLab.com에서 이 통합은 모든 SaaS 사용자에게 활성화되어 있으며 추가 구성이 필요하지 않습니다.

GitLab Self-Managed에서는 무료 diagrams.net 웹사이트와 통합하거나 오프라인 환경에서 자체 diagrams.net 사이트를 호스팅할 수 있습니다.

통합을 설정하려면:

  1. 무료 diagrams.net 웹사이트와 통합하거나 diagrams.net 서버를 구성하도록 선택합니다.
  2. 통합을 활성화합니다.

통합을 완료한 후 다이어그램.net 편집기가 제공한 URL로 열립니다.

위키 페이지 템플릿#

히스토리
  • GitLab 16.10에서 도입되었습니다.

새 페이지를 만들거나 기존 페이지에 적용하기 위한 템플릿을 만들 수 있습니다. 템플릿은 위키 저장소의 templates/ 디렉토리에 저장된 위키 페이지입니다.

템플릿 만들기#

사전 요건:

  • Developer, Maintainer 또는 Owner 역할이 있어야 합니다.
  1. 상단 표시줄에서 Search or go to를 선택하고 프로젝트 또는 그룹을 찾습니다.
  2. 왼쪽 사이드바에서 Plan > Wiki를 선택합니다.
  3. Wiki actions (⋮), Templates를 선택합니다.
  4. New Template을 선택합니다.
  5. 일반 위키 페이지를 만드는 것처럼 템플릿 제목, 형식, 콘텐츠를 입력합니다.

특정 형식의 템플릿은 동일한 형식의 페이지에만 적용할 수 있습니다. 예를 들어 Markdown 템플릿은 Markdown 페이지에만 적용됩니다.

템플릿 적용#

위키 페이지를 만들거나 편집하는 경우 템플릿을 적용할 수 있습니다.

사전 요건:

  • 이미 만든 템플릿이 하나 이상 있어야 합니다.
  1. Content 섹션에서 Choose a template 드롭다운 목록을 선택합니다.
  2. 목록에서 템플릿을 선택합니다. 페이지에 이미 콘텐츠가 있으면 기존 콘텐츠가 재정의된다는 경고가 표시됩니다.
  3. Apply template을 선택합니다.

페이지 템플릿을 이전 버전으로 복원#

히스토리
  • GitLab 18.6에서 도입되었습니다.

히스토리에서 위키 페이지 템플릿을 임의의 이전 버전으로 복원할 수 있습니다. 이렇게 하면 전체 버전 기록을 보존하면서 복원된 콘텐츠로 새 버전이 만들어집니다.

사전 요건:

  • Developer, Maintainer 또는 Owner 역할이 있어야 합니다.

위키 페이지 템플릿을 이전 버전으로 복원하려면:

  1. 상단 표시줄에서 Search or go to를 선택하고 프로젝트 또는 그룹을 찾습니다.
  2. 왼쪽 사이드바에서 Plan > Wiki를 선택합니다.
  3. Wiki actions (⋮), Templates를 선택합니다.
  4. 템플릿을 선택합니다.
  5. Wiki actions (⋮), Template history를 선택합니다.
  6. 복원하려는 버전을 선택합니다.
  7. 오른쪽 상단에서 Restore this version을 선택합니다.
  8. 커밋 대화 상자에서 이 버전을 복원하는 이유를 설명하는 Commit message를 추가합니다.
  9. Restore를 선택합니다.

페이지 템플릿이 선택한 버전으로 복원됩니다. 모든 이전 버전은 페이지 기록에 남아 있습니다.

동일한 프로세스를 사용하여 위키 페이지를 복원할 수도 있습니다.

위키 페이지 구독#

위키 페이지 구독 기능을 사용하면 관심 있는 위키 페이지에 변경이 생길 때 알림을 받을 수 있습니다. 이 기능은 중요한 문서 업데이트에 대한 팀 구성원에게 정보를 제공하여 협업을 향상시킬 수 있습니다.

특정 위키 페이지를 구독하여 다음과 같은 경우 알림을 받을 수 있습니다:

  • 누군가 페이지에 댓글을 추가할 때
  • 댓글에 답변할 때

위키 페이지 구독#

  1. 팔로우하려는 위키 페이지를 엽니다.
  2. 오른쪽 상단 모서리에서 Edit 옆에 있는 종 아이콘 ([notifications])을 선택합니다.
  3. 다시 종 아이콘 ([notifications-off])을 선택하여 구독을 취소합니다.

구독 상태를 변경하면 GitLab이 확인 메시지를 표시합니다:

  • 구독된 경우, Notifications turned on
  • 구독 취소된 경우, Notifications turned off

구독 권한#

위키 페이지를 볼 수 있는 액세스 권한이 있는 모든 사용자가 구독할 수 있습니다. 구독 상태는 개인적이며 다른 사용자에게 영향을 미치지 않습니다.

알림 설정#

알림은 프로젝트 알림 설정을 따릅니다. 구성된 알림 채널을 통해 전달됩니다.

위키 페이지의 기록 보기#

시간이 지남에 따른 위키 페이지의 변경 사항이 위키의 Git 저장소에 기록됩니다. 기록 페이지는 다음을 표시합니다:

  • 페이지의 개정 번호.
  • 페이지 작성자.
  • 커밋 메시지.
  • 마지막 업데이트.
  • Page version 열에서 개정 번호를 선택하여 이전 개정.

위키 페이지의 변경 사항을 보려면:

  1. 상단 표시줄에서 Search or go to를 선택하고 프로젝트 또는 그룹을 찾습니다.
  2. 왼쪽 사이드바에서 Plan > Wiki를 선택합니다.
  3. 기록을 보려는 페이지로 이동합니다.
  4. Wiki actions (⋮), Page history를 선택합니다.

페이지 버전 간 변경 사항 보기#

버전이 지정된 diff 파일 보기와 유사하게 위키 페이지의 특정 버전에서 이루어진 변경 사항을 볼 수 있습니다:

  1. 상단 표시줄에서 Search or go to를 선택하고 프로젝트 또는 그룹을 찾습니다.
  2. 왼쪽 사이드바에서 Plan > Wiki를 선택합니다.
  3. 관심 있는 위키 페이지로 이동합니다.
  4. Wiki actions (⋮), Page history를 선택하여 모든 페이지 버전을 봅니다.
  5. 관심 있는 버전의 Diff 열에서 커밋 메시지를 선택합니다.

위키 페이지를 이전 버전으로 복원#

히스토리
  • GitLab 18.6에서 도입되었습니다.

히스토리에서 위키 페이지를 임의의 이전 버전으로 복원할 수 있습니다. 이렇게 하면 전체 버전 기록을 보존하면서 복원된 콘텐츠로 새 버전이 만들어집니다.

사전 요건:

  • Developer, Maintainer 또는 Owner 역할이 있어야 합니다.

위키 페이지를 이전 버전으로 복원하려면:

  1. 상단 표시줄에서 Search or go to를 선택하고 프로젝트 또는 그룹을 찾습니다.
  2. 왼쪽 사이드바에서 Plan > Wiki를 선택합니다.
  3. 복원하려는 페이지로 이동합니다.
  4. Wiki actions (⋮), Page history를 선택합니다.
  5. 복원하려는 버전을 선택합니다.
  6. 오른쪽 상단에서 Restore this version을 선택합니다.
  7. 커밋 대화 상자에서 이 버전을 복원하는 이유를 설명하는 Commit message를 추가합니다.
  8. Restore를 선택합니다.

페이지가 선택한 버전으로 복원됩니다. 모든 이전 버전은 페이지 기록에 남아 있습니다.

동일한 프로세스를 사용하여 위키 페이지 템플릿을 복원할 수도 있습니다.

사이드바#

히스토리
  • GitLab 17.1에서 사이드바에서 제목으로 검색이 도입되었습니다.
  • GitLab 17.2에서 사이드바의 15개 항목 제한이 제거되었습니다.
  • GitLab 18.6에서 사이드바가 페이지의 오른쪽 상단에서 왼쪽 상단으로 이동되었습니다.
  • GitLab 18.9에서 wiki_floating_sidebar_toggle이라는 플래그와 함께 부동 사이드바 토글이 도입되었습니다. 기본적으로 비활성화되어 있습니다.

위키 페이지에는 위키의 페이지 목록이 포함된 사이드바가 표시되며, 중첩 트리로 표시되고 형제 페이지는 알파벳 순서로 나열됩니다.

사이드바의 검색 상자를 사용하여 위키에서 제목으로 페이지를 찾을 수 있습니다. 페이지의 왼쪽 상단 모서리에 있는 사이드바 토글 ([sidebar])을 사용하여 사이드바를 열거나 닫을 수 있습니다.

성능상의 이유로 사이드바는 5000개 항목 표시로 제한됩니다. 모든 페이지 목록을 보려면 사이드바에서 View All Pages를 선택합니다.

사이드바 사용자 지정#

사이드바 탐색의 내용을 수동으로 편집할 수 있습니다.

사전 요건:

  • Developer, Maintainer 또는 Owner 역할이 있어야 합니다.

이 프로세스는 기본 사이드바 탐색을 완전히 대체하는 _sidebar라는 위키 페이지를 만듭니다:

  1. 상단 표시줄에서 Search or go to를 선택하고 프로젝트 또는 그룹을 찾습니다.
  2. 왼쪽 사이드바에서 Plan > Wiki를 선택합니다.
  3. 페이지의 왼쪽 상단 모서리에서 Add custom sidebar (⚙️)를 선택합니다.
  4. 완료되면 Save changes를 선택합니다.

Markdown으로 형식이 지정된 _sidebar 예시:

### Home

- [Hello World](hello)
- [Foo](foo)
- [Bar](bar)

---

- [Sidebar](_sidebar)

프로젝트 위키 활성화 또는 비활성화#

위키는 GitLab에서 기본적으로 활성화되어 있습니다. 프로젝트 관리자공유 및 권한의 지침에 따라 프로젝트 위키를 활성화하거나 비활성화할 수 있습니다.

GitLab Self-Managed의 관리자는 추가 위키 설정을 구성할 수 있습니다.

그룹 설정에서 그룹 위키를 비활성화할 수 있습니다.

외부 위키 연결#

프로젝트의 왼쪽 사이드바에서 외부 위키 링크를 추가하려면:

  1. 상단 표시줄에서 Search or go to를 선택하고 프로젝트를 찾습니다.
  2. Settings > Integrations를 선택합니다.
  3. External wiki를 선택합니다.
  4. 외부 위키의 URL을 추가합니다.
  5. 선택사항. Test settings를 선택합니다.
  6. Save changes를 선택합니다.

이제 프로젝트의 왼쪽 사이드바에서 External wiki 옵션을 볼 수 있습니다.

이 통합을 활성화하면 외부 위키 링크가 내부 위키 링크를 대체하지 않습니다. 사이드바에서 내부 위키를 숨기려면 프로젝트의 위키를 비활성화하십시오.

외부 위키 링크를 숨기려면:

  1. 상단 표시줄에서 Search or go to를 선택하고 프로젝트를 찾습니다.
  2. Settings > Integrations를 선택합니다.
  3. External wiki를 선택합니다.
  4. Enable integration 아래에서 Active 체크 박스를 선택 해제합니다.
  5. Save changes를 선택합니다.

프로젝트의 위키 비활성화#

프로젝트의 내부 위키를 비활성화하려면:

  1. 상단 표시줄에서 Search or go to를 선택하고 프로젝트를 찾습니다.
  2. Settings > General을 선택합니다.
  3. Visibility, project features, permissions를 펼칩니다.
  4. 아래로 스크롤하여 Wiki 토글을 찾아 끄기(회색)로 설정합니다.
  5. Save changes를 선택합니다.

내부 위키가 비활성화되었으며 사용자 및 프로젝트 구성원은:

  • 프로젝트의 사이드바에서 위키 링크를 찾을 수 없습니다.
  • 위키 페이지를 추가, 삭제 또는 편집할 수 없습니다.
  • 위키 페이지를 볼 수 없습니다.

위키를 다시 활성화하고 싶을 경우를 대비하여 이전에 추가된 위키 페이지는 보존됩니다. 다시 활성화하려면 위키를 비활성화하는 프로세스를 반복하되 토글을 켜기(파란색)로 설정합니다.

서식 있는 텍스트 편집기#

히스토리
  • GitLab 16.2에서 콘텐츠 편집기에서 서식 있는 텍스트 편집기로 이름이 변경되었습니다.

GitLab은 위키에서 GitLab Flavored Markdown을 위한 서식 있는 텍스트 편집 경험을 제공합니다.

지원 항목:

  • 굵게, 이탤릭체, 블록 인용, 제목, 인라인 코드를 포함한 텍스트 서식.
  • 순서가 있는 목록, 순서가 없는 목록, 체크리스트 서식.
  • 표 구조 만들기 및 편집.
  • 구문 강조를 사용하여 코드 블록 삽입 및 서식.
  • Mermaid, PlantUML, Kroki 다이어그램 미리 보기.

서식 있는 텍스트 편집기 사용#

  1. 새 위키 페이지를 만들거나 기존 페이지를 편집합니다.
  2. 형식으로 Markdown을 선택합니다.
  3. Content 아래의 왼쪽 하단 모서리에서 Switch to rich text editing을 선택합니다.
  4. 서식 있는 텍스트 편집기에서 사용 가능한 다양한 서식 옵션을 사용하여 페이지 콘텐츠를 사용자 지정합니다.
  5. 새 페이지의 경우 Create page를 선택하고, 기존 페이지의 경우 Save changes를 선택합니다.

일반 텍스트로 다시 전환하려면 Switch to plain text editing을 선택합니다.

참조:

GitLab Flavored Markdown 지원#

서식 있는 텍스트 편집기에서 모든 GitLab Flavored Markdown 콘텐츠 유형 지원은 진행 중입니다. CommonMark 및 GitLab Flavored Markdown 지원에 대한 지속적인 개발 상태를 보려면 다음을 읽으십시오:

위키 이벤트 추적#

GitLab은 위키 생성, 삭제, 업데이트 이벤트를 추적합니다. 이러한 이벤트는 다음 페이지에 표시됩니다:

위키에 대한 커밋은 저장소 분석에 계산되지 않습니다.

문제 해결#

Apache 역방향 프록시를 사용한 페이지 슬러그 렌더링#

페이지 슬러그는 ERB::Util.url_encode 메서드를 사용하여 인코딩됩니다. Apache 역방향 프록시를 사용하는 경우 Apache 구성의 ProxyPass 줄에 nocanon 인수를 추가하여 페이지 슬러그가 올바르게 렌더링되도록 할 수 있습니다.

Rails 콘솔로 프로젝트 위키 재생성#

Warning

이 작업은 위키의 모든 데이터를 삭제합니다.

데이터를 직접 변경하는 모든 명령은 올바르게 실행되지 않거나 적절한 조건에서 실행되지 않으면 손상을 일으킬 수 있습니다. 만약의 경우 복원할 준비가 된 인스턴스 백업을 유지하면서 테스트 환경에서 실행하는 것을 강력히 권장합니다.

프로젝트 위키에서 모든 데이터를 지우고 빈 상태로 다시 만들려면:

  1. Rails 콘솔 세션을 시작합니다.

  2. 다음 명령을 실행합니다:

    # Enter your project's path
    p = Project.find_by_full_path('<username-or-group>/<project-name>')
    
    # This command deletes the wiki project from the filesystem.
    p.wiki.repository.remove
    
    # Refresh the wiki repository state.
    p.wiki.repository.expire_exists_cache
    

위키의 모든 데이터가 지워졌으며 위키를 사용할 준비가 되었습니다.

관련 주제#