위키
GitLab v19.5Offering: GitLab Self-Managed, GitLab Dedicated
요약
위키는 익숙한 형식으로 프로젝트 및 그룹 문서를 제공합니다. 각 위키는 별도의 Git 리포지터리입니다. 위키 페이지에는 사이드바가 표시되며, 이 사이드바는 사용자 지정할 수 있습니다. 프로젝트 위키에 접근하려면 다음을 수행합니다.
위키는 익숙한 형식으로 프로젝트 및 그룹 문서를 제공합니다. 위키 페이지는 다음과 같은 기능을 제공합니다.
- Markdown, RDoc, AsciiDoc, Org 형식으로 기술 문서, 가이드, 지식 베이스를 작성합니다.
- GitLab 프로젝트 및 그룹과 직접 통합되는 협업 문서를 만듭니다.
- 버전 관리와 협업을 위해 문서를 Git 리포지터리에 저장합니다.
- 사이드바 사용자 지정으로 사용자 지정 내비게이션과 구성을 지원합니다.
- 오프라인 접근과 공유를 위해 콘텐츠를 PDF 파일로 내보냅니다.
- 콘텐츠를 코드베이스와 분리해 유지하면서도 같은 프로젝트 안에 보관합니다.
- 피드백과 참여를 위해 페이지에서 이모지 반응을 지원합니다.
각 위키는 별도의 Git 리포지터리입니다. 위키 페이지는 GitLab 웹 인터페이스에서 만들고 편집할 수 있으며, Git을 사용해 로컬에서 작업할 수도 있습니다. Markdown으로 작성한 위키 페이지는 모든 Markdown 기능을 지원하고, 링크에는 위키 고유 동작을 제공합니다.
위키 페이지에는 사이드바가 표시되며, 이 사이드바는 사용자 지정할 수 있습니다.
프로젝트 위키 보기#
프로젝트 위키에 접근하려면 다음을 수행합니다.
- 상단 바에서 Search or go to를 선택하고 프로젝트를 찾습니다.
- 왼쪽 사이드바에서 Plan > Wiki를 선택합니다.
프로젝트의 왼쪽 사이드바에 Plan > Wiki가 없으면 프로젝트 관리자가 위키를 비활성화한 것입니다.
위키의 기본 브랜치 구성#
위키 리포지터리는 인스턴스 또는 그룹에서 기본 브랜치 이름을
상속합니다. 사용자 지정 브랜치 이름이 구성되어 있지 않으면 GitLab은 main을 사용합니다.
위키의 기본 브랜치 이름을 바꾸려면 리포지터리에서 기본 브랜치 이름을 업데이트합니다.
위키 홈 페이지 만들기#
히스토리
- 페이지 제목과 경로의 분리가 GitLab 17.2에서
wiki_front_matter및wiki_front_matter_title이라는 기능 플래그와 함께 도입되었습니다. 기본적으로 활성화되어 있습니다. - GitLab 17.3에서 기능 플래그
wiki_front_matter및wiki_front_matter_title이 제거되었습니다. - 몰입형 편집기:
- GitLab 19.1에서
wiki_immersive_editor라는 기능 플래그와 함께 도입되었습니다. 기본적으로 활성화되어 있습니다. - GitLab 19.2에서 일반 공개되었습니다. 기능 플래그
wiki_immersive_editor가 제거되었습니다.
위키를 만들면 처음에는 비어 있습니다. 처음 방문할 때 사용자가 위키를 볼 때 표시되는 홈 페이지를 만들 수 있습니다. 이 페이지를 위키의 홈 페이지로 사용하려면 특정 경로가 필요합니다. 홈 페이지를 만들려면 다음을 수행합니다.
- 상단 바에서 Search or go to를 선택하고 프로젝트 또는 그룹을 찾습니다.
- 왼쪽 사이드바에서 Plan > Wiki를 선택합니다.
- Create your first page를 선택합니다.
- 선택 사항. 홈 페이지의 Title을 변경합니다.
- GitLab은 이 첫 페이지의 경로가
home이어야 합니다. 이 경로에 있는 페이지가 위키의 시작 페이지 역할을 합니다. - 선택 사항. Edit page options ([chevron-down])를 선택해 다음을 수행합니다.
- 콘텐츠 영역에 홈 페이지의 환영 메시지를 추가합니다. 나중에 언제든지 편집할 수 있습니다.
- Create page를 선택합니다. 저장하기 전에 커밋 메시지를 추가하려면 Create page 옆의 화살표를 선택하고 Save changes with message를 선택합니다.
새 위키 페이지 만들기#
히스토리
- 페이지 제목과 경로의 분리가 GitLab 17.2에서
wiki_front_matter및wiki_front_matter_title이라는 기능 플래그와 함께 도입되었습니다. 기본적으로 활성화되어 있습니다. - GitLab 17.3에서 기능 플래그
wiki_front_matter및wiki_front_matter_title이 제거되었습니다. - 상단 바에서 위키 페이지를 만드는 기능이 GitLab 18.10에서 도입되었습니다.
- 몰입형 편집기:
- GitLab 19.1에서
wiki_immersive_editor라는 기능 플래그와 함께 도입되었습니다. 기본적으로 활성화되어 있습니다. - GitLab 19.2에서 일반 공개되었습니다. 기능 플래그
wiki_immersive_editor가 제거되었습니다.
사전 요구 사항:
- Developer, Maintainer 또는 Owner 권한.
프로젝트 또는 그룹에서 새 위키 페이지를 만들려면 다음을 수행합니다.
- 상단 바에서 Search or go to를 선택하고 그룹 또는 프로젝트를 찾습니다.
- 오른쪽 상단 모서리에서 Create new (+)를 선택한 다음 New wiki page를 선택합니다.
또는 다음을 수행합니다.
- 상단 바에서 Search or go to를 선택하고 프로젝트 또는 그룹을 찾습니다.
- 왼쪽 사이드바에서 Plan > Wiki를 선택합니다.
- 이 페이지 또는 다른 위키 페이지에서 Wiki actions (⋮)를 선택한 다음 New page를 선택합니다.
새 페이지 양식을 연 다음 아래 단계를 완료합니다.
- 편집기 헤더에서 새 페이지의 Title을 추가합니다.
- 선택 사항. Edit page options ([chevron-down])를 선택해 다음을 수행합니다.
- 선택 사항. 위키 페이지에 콘텐츠를 추가합니다.
- 선택 사항. 파일을 첨부하면 GitLab이 위키의 Git 리포지터리에 저장합니다.
- Create page를 선택합니다. 저장하기 전에 커밋 메시지를 추가하려면 Create page 옆의 화살표를 선택하고 Save changes with message를 선택합니다.
템플릿에서 만들기#
히스토리
- 템플릿에서 바로 새 위키 페이지를 만드는 기능이 GitLab 18.6에서 도입되었습니다.
프로젝트에 템플릿이 하나 이상 있으면 템플릿에서 새 위키 페이지를 만들 수 있습니다.
사전 요구 사항:
- 템플릿을 하나 이상 미리 만들어 두어야 합니다.
- 상단 바에서 Search or go to를 선택하고 프로젝트 또는 그룹을 찾습니다.
- 왼쪽 사이드바에서 Plan > Wiki를 선택합니다.
- Templates를 선택해 사용할 수 있는 모든 템플릿을 확인합니다.
- 사용할 템플릿 옆에서 Create from template을 선택합니다.
- 다음 상태로 새 페이지 양식이 열립니다.
- 콘텐츠 영역에 템플릿 콘텐츠가 미리 채워집니다.
- 템플릿 드롭다운 목록에서 해당 템플릿이 선택됩니다.
- 새 페이지의 제목을 입력합니다.
- 필요에 따라 콘텐츠를 수정합니다.
- Create page를 선택합니다.
- 상단 바에서 Search or go to를 선택하고 프로젝트 또는 그룹을 찾습니다.
- 왼쪽 사이드바에서 Plan > Wiki를 선택합니다.
- Templates를 선택해 사용할 수 있는 모든 템플릿을 확인합니다.
- 사용할 템플릿을 골라 선택합니다.
- 페이지 헤더에서 Create from template을 선택합니다.
- 현재 템플릿이 미리 선택되고 그 콘텐츠가 로드된 상태로 새 페이지 양식이 열립니다.
- 새 페이지의 제목을 입력합니다.
- 필요에 따라 콘텐츠를 수정합니다.
- Create page를 선택합니다.
- 상단 바에서 Search or go to를 선택하고 프로젝트 또는 그룹을 찾습니다.
- 왼쪽 사이드바에서 Plan > Wiki를 선택합니다.
- New page를 선택합니다.
- Choose a template 드롭다운 목록에서 원하는 템플릿을 선택합니다.
- 템플릿 콘텐츠가 콘텐츠 영역에 자동으로 로드됩니다.
- 페이지의 제목을 입력합니다.
- 필요에 따라 콘텐츠를 수정합니다.
- Create page를 선택합니다.
위키 페이지를 로컬에서 만들거나 편집하기#
위키는 Git 리포지터리를 기반으로 하므로, 다른 Git 리포지터리와 마찬가지로 로컬에 클론해 편집할 수 있습니다. 위키 리포지터리를 로컬에 클론하려면 다음을 수행합니다.
- 상단 바에서 Search or go to를 선택하고 프로젝트 또는 그룹을 찾습니다.
- 왼쪽 사이드바에서 Plan > Wiki를 선택합니다.
- Wiki actions (⋮)를 선택한 다음 Clone repository를 선택합니다.
- 화면의 안내를 따릅니다.
로컬에서 위키에 추가하는 파일은 사용하려는 마크업 언어에 따라 아래에서 지원하는 확장자 중 하나를 사용해야 합니다. 지원되지 않는 확장자의 파일은 GitLab에 푸시해도 표시되지 않습니다.
- Markdown 확장자:
.mdown,.mkd,.mkdn,.md,.markdown. - AsciiDoc 확장자:
.adoc,.ad,.asciidoc. - 기타 마크업 확장자:
.textile,.rdoc,.org,.creole,.wiki,.mediawiki,.rst.
페이지 경로의 특수 문자#
히스토리
- GitLab 16.7에서
wiki_front_matter및wiki_front_matter_title이라는 기능 플래그와 함께 front matter 기반 제목이 도입되었습니다. 기본적으로 비활성화되어 있습니다. - 기능 플래그
wiki_front_matter및wiki_front_matter_title이 GitLab 17.2에서 기본적으로 활성화되었습니다. - GitLab 17.3에서 기능 플래그
wiki_front_matter및wiki_front_matter_title이 제거되었습니다.
위키 페이지는 Git 리포지터리의 파일로 저장되며, 기본적으로 페이지의 파일 이름이 곧 제목입니다. 파일 이름의 특정 문자에는 특별한 의미가 있습니다.
- 페이지를 저장할 때 공백은 하이픈으로 변환됩니다.
- 페이지를 표시할 때 하이픈(
-)은 다시 공백으로 변환됩니다. - 슬래시(
/)는 경로 구분자로 쓰이며 제목에 표시할 수 없습니다. 제목에/문자가 든 파일을 만들면 GitLab이 그 경로를 구성하는 데 필요한 모든 하위 디렉터리를 만듭니다. 예를 들어 제목이docs/my-page이면 경로가/wikis/docs/my-page인 위키 페이지가 생성됩니다.
이러한 제약을 피하려면 페이지 콘텐츠 앞의 front matter 블록에 위키 페이지의 제목을 저장할 수도 있습니다. 예를 들면 다음과 같습니다.
---
title: Page title
---
파일 및 디렉터리 이름의 길이 제한#
많은 일반 파일 시스템은 파일 및 디렉터리 이름에 255바이트 제한을 둡니다. Git과 GitLab은 모두 이 제한을 넘는 경로를 지원합니다. 그러나 파일 시스템이 이 제한을 강제하면 이 제한을 넘는 파일 이름이 포함된 위키의 로컬 사본을 체크아웃할 수 없습니다. 이 문제를 막기 위해 GitLab 웹 인터페이스와 API는 다음 제한을 적용합니다.
- 파일 이름은 245바이트(파일 확장자용으로 10바이트를 남겨 둡니다).
- 디렉터리 이름은 255바이트.
ASCII 이외의 문자는 1바이트 이상을 차지합니다.
이 제한을 넘는 파일을 로컬에서 만드는 것은 여전히 가능하지만, 이후 팀원이 위키를 로컬에 체크아웃하지 못할 수 있습니다.
위키 페이지 편집#
히스토리
사전 요구 사항:
- Developer, Maintainer 또는 Owner 권한이 있어야 합니다.
위키 편집기는 다음을 포함하는 고정 헤더와 함께 열립니다.
- 페이지 제목. 인라인으로 편집할 수 있습니다.
- 페이지 경로나 형식을 변경하거나 템플릿을 선택하는 Edit page options ([chevron-down]).
- 위키 사이드바를 표시하거나 숨기는 사이드바 토글([sidebar]).
- 변경 사항을 저장하거나 버리는 Save changes 및 Cancel.
위키 페이지를 편집하려면 다음을 수행합니다.
- 상단 바에서 Search or go to를 선택하고 프로젝트 또는 그룹을 찾습니다.
- 왼쪽 사이드바에서 Plan > Wiki를 선택합니다.
- 편집할 페이지로 이동한 다음 Edit를 선택합니다.
- 콘텐츠를 편집합니다.
- Save changes를 선택합니다. 저장하기 전에 커밋 메시지를 추가하려면 Save changes 옆의 화살표를 선택하고 Save changes with message를 선택합니다.
페이지를 미리 보며 스크롤하면 페이지 상단의 고정 바가 Edit과 그 밖의 작업을 계속 사용할 수 있게 유지합니다.
위키 페이지의 저장하지 않은 변경 사항은 실수로 인한 데이터 손실을 막기 위해 로컬 브라우저 저장소에 보존됩니다.
목차 만들기#
히스토리
- 위키 사이드바의 목차가 GitLab 17.2에서 도입되었습니다.
콘텐츠에 제목이 있는 위키 페이지는 사이드바에 목차 섹션을 자동으로 표시합니다.
페이지 자체에 별도의 목차 섹션을 표시하도록 선택할 수도 있습니다. 위키 페이지의
하위 제목에서 목차를 생성하려면 [[_TOC_]] 태그를 사용합니다. 예시는
목차를 참고합니다.
위키 페이지에 반응하기#
히스토리
- GitLab 19.1에서 도입되었습니다.
위키 페이지에 이모지 반응을 바로 추가할 수 있습니다. 반응은 페이지 콘텐츠 아래, 댓글 섹션 위에 표시됩니다.
위키 페이지에 반응하려면 다음을 수행합니다.
- 상단 바에서 Search or go to를 선택하고 프로젝트 또는 그룹을 찾습니다.
- 왼쪽 사이드바에서 Plan > Wiki를 선택합니다.
- 반응을 추가할 페이지로 이동합니다.
- 페이지 콘텐츠 아래에서 기존 이모지를 선택해 반응을 추가하거나, 다른 이모지를 고르려면 Add reaction ([slight-smile])을 선택합니다.
반응을 제거하려면 이모지를 다시 선택합니다. 각 사용자는 페이지마다 유형별로 반응을 하나만 추가할 수 있습니다.
페이지에 첫 반응을 추가하면 GitLab이 해당 페이지의 알림을 구독하도록 설정합니다.
위키 페이지 삭제#
사전 요구 사항:
- Developer, Maintainer 또는 Owner 권한이 있어야 합니다.
- 상단 바에서 Search or go to를 선택하고 프로젝트 또는 그룹을 찾습니다.
- 왼쪽 사이드바에서 Plan > Wiki를 선택합니다.
- 삭제할 페이지로 이동합니다.
- Wiki actions (⋮)를 선택한 다음 Delete page를 선택합니다.
- 삭제를 확인합니다.
위키 페이지 이동 또는 이름 변경#
히스토리
- 이동하거나 이름을 변경한 위키 페이지의 리디렉션이 GitLab 17.1에서
wiki_redirection이라는 기능 플래그와 함께 도입되었습니다. 기본적으로 활성화되어 있습니다. - 페이지 제목과 경로의 분리가 GitLab 17.2에서
wiki_front_matter및wiki_front_matter_title이라는 기능 플래그와 함께 도입되었습니다. 기본적으로 활성화되어 있습니다. - GitLab 17.3에서 기능 플래그
wiki_redirection,wiki_front_matter,wiki_front_matter_title이 제거되었습니다.
GitLab 17.1 이상에서는 페이지를 이동하거나 이름을 변경하면 이전 페이지에서 새 페이지로
리디렉션이 자동으로 설정됩니다. 리디렉션 목록은 위키 리포지터리의
.gitlab/redirects.yml 파일에 저장됩니다.
사전 요구 사항:
- Developer, Maintainer 또는 Owner 권한이 있어야 합니다.
- 상단 바에서 Search or go to를 선택하고 프로젝트 또는 그룹을 찾습니다.
- 왼쪽 사이드바에서 Plan > Wiki를 선택합니다.
- 이동하거나 이름을 변경할 페이지로 이동합니다.
- Edit를 선택합니다.
- 편집기 헤더에서 Edit page options ([chevron-down])를 선택합니다.
- 페이지를 이동하려면 Path 필드를 변경합니다. 예를 들어
Company아래에About이라는 위키 페이지가 있고 이를 위키의 루트로 이동하려면 Path를About에서/About으로 변경합니다. - 페이지 이름을 변경하려면 Path를 변경합니다.
- Save changes를 선택합니다.
위키 페이지 내보내기#
위키 페이지를 PDF 파일로 내보낼 수 있습니다.
- 상단 바에서 Search or go to를 선택하고 프로젝트 또는 그룹을 찾습니다.
- 왼쪽 사이드바에서 Plan > Wiki를 선택합니다.
- 내보낼 페이지로 이동합니다.
- 오른쪽 상단에서 Wiki actions (⋮)를 선택한 다음 Print as PDF를 선택합니다.
위키 페이지의 PDF가 생성됩니다.
Draw.io를 사용하여 위키에서 다이어그램 만들기#
diagrams.net 통합을 사용하면 위키 페이지에 SVG 다이어그램을 만들어 삽입할 수 있습니다. 다이어그램 편집기는 일반 텍스트 편집기와 서식 있는 텍스트 편집기 모두에서 사용할 수 있습니다.
GitLab.com에서는 이 통합이 모든 사용자에게 활성화되어 있으며 추가 구성이 필요하지 않습니다.
GitLab Self-Managed에서는 무료 diagrams.net 웹사이트와 통합하거나, 오프라인 환경에서 자체 diagrams.net 사이트를 호스팅할 수 있습니다.
통합을 설정하려면 다음을 수행해야 합니다.
- 무료 diagrams.net 웹사이트와 통합할지, 자체 diagrams.net 서버를 구성할지 선택합니다.
- 통합을 활성화합니다.
통합을 완료하면 지정한 URL로 diagrams.net 편집기가 열립니다.
위키 페이지 템플릿#
새 페이지를 만들 때 사용하거나 기존 페이지에 적용할 템플릿을
만들 수 있습니다. 템플릿은 위키 리포지터리의 templates/
디렉터리에 저장되는 위키 페이지입니다.
템플릿 만들기#
사전 요구 사항:
- Developer, Maintainer 또는 Owner 권한이 있어야 합니다.
- 상단 바에서 Search or go to를 선택하고 프로젝트 또는 그룹을 찾습니다.
- 왼쪽 사이드바에서 Plan > Wiki를 선택합니다.
- Wiki actions (⋮)를 선택한 다음 Templates를 선택합니다.
- New Template을 선택합니다.
- 템플릿 제목, 형식, 콘텐츠를 입력합니다.
템플릿 경로는 제목에서 생성되며 편집할 수 없습니다. 템플릿 이름을 바꾸려면
제목을 변경합니다. 제목은 경로의 일부로만 저장되므로, 템플릿을 페이지에 적용해도
페이지 콘텐츠에 제목 메타데이터가 삽입되지 않습니다. 중첩 템플릿을 만들려면
제목에서 /를 경로 구분자로 사용합니다.
특정 형식의 템플릿은 같은 형식의 페이지에만 적용할 수 있습니다. 예를 들어 Markdown 템플릿은 Markdown 페이지에만 적용됩니다.
템플릿 적용#
위키 페이지를 만들 때나 편집할 때 템플릿을 적용할 수 있습니다.
사전 요구 사항:
- 템플릿을 하나 이상 미리 만들어 두어야 합니다.
- Content 섹션에서 Choose a template 드롭다운 목록을 선택합니다.
- 목록에서 템플릿을 선택합니다. 페이지에 이미 콘텐츠가 있으면 기존 콘텐츠를 덮어쓴다는 경고가 표시됩니다.
- Apply template을 선택합니다.
페이지 템플릿을 이전 버전으로 복원#
히스토리
- GitLab 18.6에서 도입되었습니다.
위키 페이지 템플릿을 기록에 있는 이전 버전 중 어느 것으로든 복원할 수 있습니다. 이렇게 하면 전체 버전 기록을 보존한 채 복원된 콘텐츠로 새 버전이 생성됩니다.
사전 요구 사항:
- Developer, Maintainer 또는 Owner 권한이 있어야 합니다.
위키 페이지 템플릿을 이전 버전으로 복원하려면 다음을 수행합니다.
- 상단 바에서 Search or go to를 선택하고 프로젝트 또는 그룹을 찾습니다.
- 왼쪽 사이드바에서 Plan > Wiki를 선택합니다.
- Wiki actions (⋮)를 선택한 다음 Templates를 선택합니다.
- 템플릿을 선택합니다.
- Wiki actions (⋮)를 선택한 다음 Template history를 선택합니다.
- 복원할 버전을 선택합니다.
- 오른쪽 상단에서 Restore this version을 선택합니다.
- 커밋 대화 상자에서 이 버전을 복원하는 이유를 설명하는 Commit message를 추가합니다.
- Restore를 선택합니다.
페이지 템플릿이 선택한 버전으로 복원됩니다. 이전 버전은 모두 페이지 기록에 남습니다.
같은 과정으로 위키 페이지를 복원할 수도 있습니다.
위키 페이지 구독#
위키 페이지 구독 기능을 사용하면 관심 있는 위키 페이지가 변경될 때 알림을 받을 수 있습니다. 이 기능은 중요한 문서의 업데이트를 팀원에게 계속 알려 협업을 강화할 수 있습니다.
누군가 다음을 수행할 때 알림을 받도록 특정 위키 페이지를 구독할 수 있습니다.
- 페이지에 댓글을 추가합니다
- 댓글에 답글을 답니다
위키 페이지 구독하기#
- 팔로우할 위키 페이지를 엽니다.
- 오른쪽 상단 모서리에서 Edit 옆에 있는 종 아이콘([notifications])을 선택합니다.
- 구독을 취소하려면 종 아이콘([notifications-off])을 다시 선택합니다.
구독 상태를 변경하면 GitLab이 확인 메시지를 표시합니다.
- 구독한 경우
Notifications turned on - 구독을 취소한 경우
Notifications turned off
구독 권한#
위키 페이지를 볼 수 있는 모든 사용자가 해당 페이지를 구독할 수 있습니다. 구독 상태는 개인별이며 다른 사용자에게 영향을 주지 않습니다.
알림 설정#
알림은 프로젝트 알림 설정을 따릅니다. 알림은 구성한 알림 채널로 전달됩니다.
위키 페이지의 기록 보기#
시간이 지남에 따른 위키 페이지의 변경 사항은 위키의 Git 리포지터리에 기록됩니다. 기록 페이지에는 다음이 표시됩니다.
- 페이지의 리비전.
- 페이지 작성자.
- 커밋 메시지.
- 마지막 업데이트.
- Page version 칼럼에서 리비전 번호를 선택해 볼 수 있는 이전 리비전.
위키 페이지의 변경 사항을 보려면 다음을 수행합니다.
- 상단 바에서 Search or go to를 선택하고 프로젝트 또는 그룹을 찾습니다.
- 왼쪽 사이드바에서 Plan > Wiki를 선택합니다.
- 기록을 확인할 페이지로 이동합니다.
- Wiki actions (⋮)를 선택한 다음 Page history를 선택합니다.
페이지 버전 간 변경 사항 보기#
버전별 diff 파일 보기와 비슷하게, 위키 페이지의 특정 버전에서 이루어진 변경 사항을 확인할 수 있습니다.
- 상단 바에서 Search or go to를 선택하고 프로젝트 또는 그룹을 찾습니다.
- 왼쪽 사이드바에서 Plan > Wiki를 선택합니다.
- 확인하려는 위키 페이지로 이동합니다.
- Wiki actions (⋮)를 선택한 다음 Page history를 선택해 모든 페이지 버전을 확인합니다.
- 확인하려는 버전의 Diff 칼럼에서 커밋 메시지를 선택합니다.
위키 페이지를 이전 버전으로 복원#
히스토리
- GitLab 18.6에서 도입되었습니다.
위키 페이지를 기록에 있는 이전 버전 중 어느 것으로든 복원할 수 있습니다. 이렇게 하면 전체 버전 기록을 보존한 채 복원된 콘텐츠로 새 버전이 생성됩니다.
사전 요구 사항:
- Developer, Maintainer 또는 Owner 권한이 있어야 합니다.
위키 페이지를 이전 버전으로 복원하려면 다음을 수행합니다.
- 상단 바에서 Search or go to를 선택하고 프로젝트 또는 그룹을 찾습니다.
- 왼쪽 사이드바에서 Plan > Wiki를 선택합니다.
- 복원할 페이지로 이동합니다.
- Wiki actions (⋮)를 선택한 다음 Page history를 선택합니다.
- 복원할 버전을 선택합니다.
- 오른쪽 상단에서 Restore this version을 선택합니다.
- 커밋 대화 상자에서 이 버전을 복원하는 이유를 설명하는 Commit message를 추가합니다.
- Restore를 선택합니다.
페이지가 선택한 버전으로 복원됩니다. 이전 버전은 모두 페이지 기록에 남습니다.
같은 과정으로 위키 페이지 템플릿을 복원할 수도 있습니다.
사이드바#
히스토리
- 사이드바에서 제목으로 검색하는 기능이 GitLab 17.1에서 도입되었습니다.
- 사이드바의 항목 15개 제한이 GitLab 17.2에서 제거되었습니다.
- GitLab 18.6에서 사이드바가 페이지의 오른쪽 상단에서 왼쪽 상단으로 이동했습니다.
- 플로팅 사이드바 토글이 GitLab 18.9에서
wiki_floating_sidebar_toggle이라는 플래그와 함께 도입되었습니다. 기본적으로 비활성화되어 있습니다. - 플로팅 사이드바 토글이 GitLab 18.11에서 일반 공개되었습니다. 기능 플래그
wiki_floating_sidebar_toggle이 제거되었습니다.
위키 페이지에는 위키의 페이지 목록이 담긴 사이드바가 표시되며, 목록은 중첩 트리로 표시되고 같은 수준의 페이지는 알파벳 순으로 나열됩니다.
사이드바의 검색 상자를 사용해 위키에서 제목으로 페이지를 찾을 수 있습니다. 페이지 왼쪽 상단 모서리에 있는 사이드바 토글([sidebar])로 사이드바를 열거나 닫을 수 있습니다.
성능상의 이유로 사이드바는 항목 5000개까지만 표시합니다. 모든 페이지 목록을 보려면 사이드바에서 View All Pages를 선택합니다.
사이드바 사용자 지정#
사이드바 내비게이션의 콘텐츠를 직접 편집할 수 있습니다.
사전 요구 사항:
- Developer, Maintainer 또는 Owner 권한이 있어야 합니다.
이 과정은 기본 사이드바 내비게이션을 완전히 대체하는
_sidebar라는 위키 페이지를 만듭니다.
- 상단 바에서 Search or go to를 선택하고 프로젝트 또는 그룹을 찾습니다.
- 왼쪽 사이드바에서 Plan > Wiki를 선택합니다.
- 페이지의 왼쪽 상단 모서리에서 Add custom sidebar (⚙️)를 선택합니다.
- 완료되면 Save changes를 선택합니다.
Markdown으로 서식을 지정한 _sidebar 예시입니다.
### Home
- [Hello World](hello)
- [Foo](foo)
- [Bar](bar)
---
- [Sidebar](_sidebar)
프로젝트 위키 활성화 또는 비활성화#
GitLab에서 위키는 기본적으로 활성화되어 있습니다. 프로젝트 관리자는 공유 및 권한의 안내에 따라 프로젝트 위키를 활성화하거나 비활성화할 수 있습니다.
GitLab Self-Managed 관리자는 추가 위키 설정을 구성할 수 있습니다.
그룹 설정에서 그룹 위키를 비활성화할 수 있습니다.
외부 위키 연결#
프로젝트의 왼쪽 사이드바에 외부 위키 링크를 추가하려면 다음을 수행합니다.
- 상단 바에서 Search or go to를 선택하고 프로젝트를 찾습니다.
- 왼쪽 사이드바에서 Settings > Integrations를 선택합니다.
- External wiki를 선택합니다.
- 외부 위키의 URL을 추가합니다.
- 선택 사항. Test settings를 선택합니다.
- Save changes를 선택합니다.
이제 프로젝트의 왼쪽 사이드바에서 External wiki 옵션을 볼 수 있습니다.
이 통합을 활성화해도 외부 위키 링크가 내부 위키 링크를 대체하지는 않습니다. 사이드바에서 내부 위키를 숨기려면 프로젝트의 위키를 비활성화합니다.
외부 위키 링크를 숨기려면 다음을 수행합니다.
- 상단 바에서 Search or go to를 선택하고 프로젝트를 찾습니다.
- 왼쪽 사이드바에서 Settings > Integrations를 선택합니다.
- External wiki를 선택합니다.
- Enable integration 아래에서 Active 체크박스를 선택 해제합니다.
- Save changes를 선택합니다.
프로젝트의 위키 비활성화#
프로젝트의 내부 위키를 비활성화하려면 다음을 수행합니다.
- 상단 바에서 Search or go to를 선택하고 프로젝트를 찾습니다.
- 왼쪽 사이드바에서 Settings > General을 선택합니다.
- Visibility, project features, permissions를 확장합니다.
- 아래로 스크롤해 Wiki 토글을 찾아 끕니다(회색).
- Save changes를 선택합니다.
이제 내부 위키가 비활성화되며, 사용자와 프로젝트 멤버는 다음과 같은 상태가 됩니다.
- 프로젝트 사이드바에서 위키 링크를 찾을 수 없습니다.
- 위키 페이지를 추가, 삭제, 편집할 수 없습니다.
- 위키 페이지를 볼 수 없습니다.
이전에 추가한 위키 페이지는 위키를 다시 활성화할 경우를 위해 보존됩니다. 다시 활성화하려면 위키를 비활성화한 과정을 반복하되 토글을 켭니다(파란색).
서식 있는 텍스트 편집기#
GitLab은 위키에서 GitLab Flavored Markdown을 위한 서식 있는 텍스트 편집 환경을 제공합니다.
지원 범위는 다음과 같습니다.
- 굵게, 기울임꼴, 블록 인용, 제목, 인라인 코드를 포함한 텍스트 서식 지정.
- 순서 있는 목록, 순서 없는 목록, 체크리스트 서식 지정.
- 표 구조 만들기 및 편집.
- 구문 강조가 적용된 코드 블록 삽입 및 서식 지정.
- Mermaid, PlantUML, Kroki 다이어그램 미리 보기.
서식 있는 텍스트 편집기 사용#
히스토리
- 새 위키 페이지를 만들거나 기존 페이지를 편집합니다.
- 형식으로 Markdown을 선택합니다. 형식을 변경하려면 편집기 헤더에서 Edit page options ([chevron-down])를 선택합니다.
- 편집기 헤더에서 Switch to rich text editing을 선택합니다.
- 서식 있는 텍스트 편집기에서 제공하는 여러 서식 옵션으로 페이지 콘텐츠를 구성합니다.
- 새 페이지는 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 콘솔로 프로젝트 위키 재생성#
이 작업은 위키의 모든 데이터를 삭제합니다.
데이터를 직접 변경하는 명령은 올바르게 실행되지 않거나 적절한 조건이 아닐 때 손상을 일으킬 수 있습니다. 만약을 위해 인스턴스 백업을 복원할 수 있도록 준비한 테스트 환경에서 실행하기를 강력히 권장합니다.
프로젝트 위키의 모든 데이터를 지우고 빈 상태로 다시 만들려면 다음을 수행합니다.
-
Rails 콘솔 세션을 시작합니다.
-
다음 명령을 실행합니다.
# 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
위키의 모든 데이터가 지워졌고, 위키를 사용할 준비가 되었습니다.