Wiki · Gitlab 中文文檔

# Wiki > 原文：[https://docs.gitlab.com/ee/user/project/wiki/](https://docs.gitlab.com/ee/user/project/wiki/) * [First time creating the Home page](#first-time-creating-the-home-page) * [Creating a new wiki page](#creating-a-new-wiki-page) * [Attachment storage](#attachment-storage) * [Special characters in page titles](#special-characters-in-page-titles) * [Length restrictions for file and directory names](#length-restrictions-for-file-and-directory-names) * [Editing a wiki page](#editing-a-wiki-page) * [Adding a table of contents](#adding-a-table-of-contents) * [Deleting a wiki page](#deleting-a-wiki-page) * [Moving a wiki page](#moving-a-wiki-page) * [Viewing a list of all created wiki pages](#viewing-a-list-of-all-created-wiki-pages) * [Viewing the history of a wiki page](#viewing-the-history-of-a-wiki-page) * [Viewing the changes between page versions](#viewing-the-changes-between-page-versions) * [Wiki activity records](#wiki-activity-records) * [Limitations](#limitations) * [Enable or disable Wiki Events](#enable-or-disable-wiki-events-core-only) * [Adding and editing wiki pages locally](#adding-and-editing-wiki-pages-locally) * [Customizing sidebar](#customizing-sidebar) # Wiki[](#wiki "Permalink") 每個 GitLab 項目都內置了一個稱為 Wiki 的獨立文檔系統. 默認情況下，所有新項目都啟用此功能，您可以在項目的**Wiki**下找到它. 如果您不想將文檔保留在存儲庫中，但確實希望將其保留在代碼所在的項目中，則 Wiki 非常方便. 您可以在 Web 界面中或[使用 Git 在本地](#adding-and-editing-wiki-pages-locally)創建 Wiki 頁面，因為每個 Wiki 都是單獨的 Git 存儲庫. ## First time creating the Home page[](#first-time-creating-the-home-page "Permalink") 首次訪問 Wiki 時，系統將指示您創建主頁. 必須創建主頁，因為它是查看 Wiki 時的登錄頁面. 您只需要填寫**內容**部分，然后單擊**創建頁面** . 您以后可以隨時對其進行編輯，因此繼續寫歡迎信息. [![New home page](https://img.kancloud.cn/e9/a9/e9a9201b5bc65b6720bd37c264f4ee9b_725x519.png)](img/wiki_create_home_page.png) ## Creating a new wiki page[](#creating-a-new-wiki-page "Permalink") **注意：**需要開發者[權限](../../permissions.html) . 通過單擊可在所有 Wiki 頁面中找到的" **新頁面"**按鈕來創建新頁面. 系統將要求您為新的 Wiki 頁面填寫標題. 您可以通過在標題中使用" /"指示子目錄來為 Wiki 頁面指定完整路徑. 任何丟失的目錄將自動創建. 例如， `docs/my-page`的標題將創建一個 Wiki 頁面，其路徑為`/wikis/docs/my-page` . 輸入頁面名稱后，就該填寫其內容了. GitLab Wiki 支持 Markdown，RDoc，AsciiDoc 和 Org. 對于基于 Markdown 的頁面，所有[Markdown 功能](../../markdown.html)均受支持，對于鏈接，則存在一些[特定](../../markdown.html#wiki-specific-markdown)于[Wiki 的](../../markdown.html#wiki-specific-markdown)行為. 在 Web 界面中，提交消息是可選的，但是 GitLab Wiki 是基于 Git 的，并且需要提交消息，因此如果您不輸入消息，則會為您創建一條. When you’re ready, click the **建立頁面** and the new page will be created. [![New page](https://img.kancloud.cn/59/7f/597f2319349f7a1e699aabd8b2b1b5af_735x519.png)](img/wiki_create_new_page.png) ### Attachment storage[](#attachment-storage "Permalink") 在 GitLab 11.3 中[引入](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/33475) . 從 GitLab 11.3 開始，通過 GitLab 界面上載到 Wiki 的任何文件都將存儲在 Wiki Git 存儲庫中，如果您在本地克隆 Wiki 存儲庫，該文件將可用. GitLab 11.3 之前的所有上傳文件都存儲在 GitLab 本身中. 如果希望它們成為 Wiki 的 Git 存儲庫的一部分，則必須再次上傳它們. ### Special characters in page titles[](#special-characters-in-page-titles "Permalink") Wiki 頁面作為文件存儲在 Git 存儲庫中，因此某些字符具有特殊含義： * 存儲頁面時，空格會轉換為連字符. * 顯示頁面時，連字符（ `-` ）轉換回空格. * 不能使用斜杠（ `/` ），因為它們用作路徑分隔符. ### Length restrictions for file and directory names[](#length-restrictions-for-file-and-directory-names "Permalink") 在 GitLab 12.8 中[引入](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/24364) . 許多常見的文件系統[的文件名和目錄名限制為 255 個字節](https://en.wikipedia.org/wiki/Comparison_of_file_systems#Limits) ，盡管 Git 和 GitLab 都支持超出這些限制的路徑，但是它們的存在使這些文件系統上的用戶無法在本地檢出 Wiki 存儲庫. 為了避免這種情況，通過 GitLab Web 界面和 API 編輯頁面時會強制執行以下限制： * 頁面標題為 245 個字節（文件擴展名保留 10 個字節）. * 255 個字節的目錄名稱. 請注意： * 非 ASCII 字符占用多個字節. * 仍然可以通過 Git 在本地創建超出限制的文件和目錄，但這可能會在其他人的計算機上中斷. ## Editing a wiki page[](#editing-a-wiki-page "Permalink") **注意：**需要開發者[權限](../../permissions.html) . 要編輯頁面，只需單擊" **編輯"**按鈕. 從那里開始，您可以更改其內容. 完成后，單擊" **保存更改"**以使更改生效. ### Adding a table of contents[](#adding-a-table-of-contents "Permalink") 要從 Wiki 頁面中的標題生成目錄，請使用`[[_TOC_]]`標簽. 有關示例，請參閱[目錄](../../markdown.html#table-of-contents) . ## Deleting a wiki page[](#deleting-a-wiki-page "Permalink") **注意：**需要維護者[權限](../../permissions.html) . 僅在編輯頁面時才能找到" **刪除"**按鈕. 單擊它并確認您要刪除頁面. ## Moving a wiki page[](#moving-a-wiki-page "Permalink") 通過在[編輯](#editing-a-wiki-page)表單的 Wiki 頁面標題中指定完整路徑，可以將 Wiki 頁面從一個目錄移動到另一個目錄. [![Moving a page](https://img.kancloud.cn/75/2d/752d92c08a2ed6b2dae7c1262abce7db_1280x364.png)](img/wiki_move_page_1.png) [![After moving a page](https://img.kancloud.cn/4f/9d/4f9dcc61b48b5b73af121cd946b79f4e_1273x253.png)](img/wiki_move_page_2.png) 為了將 Wiki 頁面移動到根目錄，必須在 Wiki 頁面標題前加上斜杠（ `/` ）字符. ## Viewing a list of all created wiki pages[](#viewing-a-list-of-all-created-wiki-pages "Permalink") 每個 Wiki 都有一個側邊欄，從中可以找到所創建頁面的簡短列表. 該列表按字母順序排列. [![Wiki sidebar](https://img.kancloud.cn/e2/71/e27192b01a8cefa8ad97c98f47227f77_290x245.png)](img/wiki_sidebar.png) 如果頁面很多，則不會在側邊欄中列出所有頁面. 單擊**查看所有頁面**以**查看所有頁面** . ## Viewing the history of a wiki page[](#viewing-the-history-of-a-wiki-page "Permalink") Wiki 頁面隨時間的變化記錄在 Wiki 的 Git 存儲庫中，您可以通過單擊**Page history**按鈕來查看它們. 從歷史記錄頁面中，您可以看到頁面的修訂版（Git commit SHA），其作者，提交消息以及上次更新時間. 要查看頁面的先前版本的外觀，請在" **頁面版本"**列中單擊修訂號. [![Wiki page history](https://img.kancloud.cn/9a/52/9a52ff28187eff481d53568f74ac629b_1180x250.png)](img/wiki_page_history.png) ### Viewing the changes between page versions[](#viewing-the-changes-between-page-versions "Permalink") 在 GitLab 13.2 中[引入](https://gitlab.com/gitlab-org/gitlab/-/issues/15242) . 類似于版本化的差異文件視圖，您可以看到在給定的 Wiki 頁面版本中所做的更改： 1. 導航到您感興趣的 Wiki 頁面. 2. 單擊**頁面歷史記錄**以查看所有頁面版本. 3. 單擊" **更改"**列中的提交消息以獲取您感興趣的版本： [![Wiki page changes](https://img.kancloud.cn/74/13/741347384a684c3451c4309e790c62a6_1180x790.png)](img/wiki_page_diffs_v13_2.png) ## Wiki activity records[](#wiki-activity-records "Permalink") 版本歷史 * 在 GitLab 12.10 中[引入](https://gitlab.com/gitlab-org/gitlab/-/issues/14902) . * 它部署在功能標記后面，默認情況下處于禁用狀態. * 在 GitLab.com 上啟用了它. * 要在 GitLab 自管實例中使用它，請讓 GitLab 管理員[啟用它](#enable-or-disable-wiki-events-core-only) . Wiki 事件（創建，刪除和更新）由 GitLab 跟蹤，并顯示在[用戶個人資料](../../profile/index.html#user-profile) ， [組](../../group/index.html#view-group-activity)和[項目](../index.html#project-activity)活動頁面上. ### Limitations[](#limitations "Permalink") 只有在瀏覽器中或通過 API 進行的編輯才會記錄其活動. 當前在活動列表中未列出通過 Git 進行和推送的編輯. ### Enable or disable Wiki Events[](#enable-or-disable-wiki-events-core-only "Permalink") Wiki 事件活動正在開發中，尚未準備好用于生產. 它部署在**默認情況下禁用**的功能標志的后面. [有權訪問 GitLab Rails 控制臺的 GitLab 管理員](../../../administration/troubleshooting/navigating_gitlab_via_rails_console.html#starting-a-rails-console-session)可以為您的實例啟用它. 歡迎您對其進行測試，但使用風險自負. 要啟用它： ``` Feature.enable(:wiki_events) ``` 禁用它： ``` Feature.disable(:wiki_events) ``` ## Adding and editing wiki pages locally[](#adding-and-editing-wiki-pages-locally "Permalink") 由于 Wiki 基于 Git 存儲庫，因此您可以像在其他所有 Git 存儲庫中一樣在本地克隆它們并進行編輯. 在右側欄上，單擊" **克隆存儲庫"，**然后按照屏幕上的說明進行操作. 根據您要使用的標記語言，您在本地添加到 Wiki 的文件必須具有以下受支持的擴展名之一，否則當推送到 GitLab 時將不會顯示這些文件： * Markdown 擴展名： `.mdown` ， `.mkd` ， `.mkdn` ， `.md` ， `.markdown` . * AsciiDoc 擴展名： `.adoc` ， `.ad` ， `.asciidoc` . * 其他標記擴展名： `.textile` ， `.rdoc` ， `.org` ， `.creole` ， `.wiki` ， `.mediawiki` ， `.rst` . ## Customizing sidebar[](#customizing-sidebar "Permalink") 在項目的 Wiki 頁面上，有一個右側導航，默認情況下呈現帶有層次結構的完整 Wiki 頁面列表. 要自定義邊欄，您可以創建一個名為`_sidebar`的文件以完全替換默認導航. **警告：**除非您從自定義導航鏈接`_sidebar`文件，否則要進行編輯，必須輸入以下內容直接從瀏覽器的地址欄中訪問： `https://gitlab.com/<namespace>/<project_name>/-/wikis/_sidebar` : `_sidebar` /- `https://gitlab.com/<namespace>/<project_name>/-/wikis/_sidebar` （對于自我管理的 GitLab 實例，將`gitlab.com`替換為實例的 URL）. `_sidebar`示例（使用 Markdown 格式）： ``` ### [Home](home) - [Hello World](hello) - [Foo](foo) - [Bar](bar) --- - [Sidebar](_sidebar) ``` 計劃支持使用自定義側面導航顯示生成的目錄.