Snippets · Gitlab 中文文檔

# Snippets > 原文：[https://docs.gitlab.com/ee/user/snippets.html](https://docs.gitlab.com/ee/user/snippets.html) * [Personal snippets](#personal-snippets) * [Project snippets](#project-snippets) * [Create a snippet](#create-a-snippet) * [Versioned Snippets](#versioned-snippets) * [File names](#file-names) * [Cloning snippets](#cloning-snippets) * [Limitations](#limitations) * [Discover snippets](#discover-snippets) * [Snippet comments](#snippet-comments) * [Downloading snippets](#downloading-snippets) * [Embedded snippets](#embedded-snippets) # Snippets[](#snippets "Permalink") 借助 GitLab 代碼片段，您可以存儲和與其他用戶共享代碼和文本. [![GitLab Snippet](https://img.kancloud.cn/c1/bf/c1bfd069879c609043fb19d66fd30d6b_808x649.png)](img/gitlab_snippet_v13_0.png) 可以使用[摘要 API](../api/snippets.html)來維護[摘要](../api/snippets.html) . 片段類型有兩種： * 個人摘要. * 項目摘要. ## Personal snippets[](#personal-snippets "Permalink") 個人代碼段與任何項目均無關，可以完全獨立地創建. 可以設置 3 種可見性級別，公共，內部和私有. 有關更多信息，請參見[公共訪問](../public_access/public_access.html) . ## Project snippets[](#project-snippets "Permalink") 項目摘要始終與特定項目相關. 有關更多信息，請參見[項目功能](project/index.html#project-features) . ## Create a snippet[](#create-a-snippet "Permalink") 要創建個人代碼段，請點擊加號圖標（），然后從下拉菜單中選擇" **新建代碼段** "： [![New personal snippet from non-project pages](https://img.kancloud.cn/2a/e0/2ae093c4377537845c41b2afa0f2fd67_1746x406.png)](img/new_personal_snippet_v12_10.png) 如果您在項目頁面上，但要創建一個新的個人代碼段，請點擊加號圖標（），然后從下拉菜單的下部選擇**新代碼段** （在 GitLab.com 上為**GitLab** ；在自托管實例上為**您的**實例）： [![New personal snippet from project pages](https://img.kancloud.cn/17/5f/175fc8542428e245144d1c698dffe521_1639x653.png)](img/new_personal_snippet_from_project_v12_10.png) 要創建項目摘要，請導航到您的項目頁面，然后點擊加號圖標（），然后從下拉菜單的上方選擇**新建代碼段** （ **此項目** ）. [![New personal snippet from project pages](https://img.kancloud.cn/e7/3a/e73a404fca50b2976eb8f9e9d1d11e98_1654x659.png)](img/new_project_snippet_from_project_v12_10.png) 從那里添加**Title** ， **Description**和帶有適當擴展名的**文件**名（例如`example.rb` ， `index.html` ）. **警告：**確保添加文件名以突出顯示代碼并避免此[粘貼錯誤](https://gitlab.com/gitlab-org/gitlab/-/issues/22870) . ## Versioned Snippets[](#versioned-snippets "Permalink") 在 GitLab 13.0 中[引入](https://gitlab.com/groups/gitlab-org/-/epics/239) . 從 13.0 開始，片段（個人片段和項目片段）默認都啟用了版本控制. 這意味著在創建代碼段時，所有代碼段都將獲得自己的基礎存儲庫，并使用`master`分支進行初始化. 每當保存對代碼段的更改時，都會記錄對 master 分支的新提交. 提交消息是自動生成的. 該代碼段的存儲庫默認情況下只有一個分支（母版），不支持將其刪除或創建其他分支. 現有代碼段將在 13.0 中自動遷移. 它們的當前內容將被保存為對代碼段存儲庫的初始提交. ### File names[](#file-names "Permalink") 代碼段支持基于為其提供的文件名和擴展名突出顯示語法. 盡管可以在不指定文件名和擴展名的情況下提交代碼段，但它需要一個有效的名稱，以便可以將內容作為文件創建在代碼段的存儲庫中. 如果用戶未將文件名和擴展名歸于代碼段，則 GitLab 會自動以`snippetfile<x>.txt`格式添加文件名，其中`<x>`代表添加到文件的數字，從 1 開始.添加了更多沒有屬性文件名的代碼段. 從早期版本的 GitLab 升級到 13.0 時，不支持文件名的現有代碼片段將重命名為兼容格式. 例如，如果代碼段的文件名是`http://a-weird-filename.me` ，它將被更改為`http-a-weird-filename-me` ，以包含在代碼段的存儲庫中. 由于代碼段是通過 ID 存儲的，因此更改其文件名不會破壞該代碼段的直接鏈接或嵌入式鏈接. ### Cloning snippets[](#cloning-snippets "Permalink") 可以使用 SSH 或 HTTPS 將片段克隆為常規的 Git 存儲庫. 單擊摘要內容上方的" **復制"**按鈕以復制您選擇的 URL. [![Clone Snippet](https://img.kancloud.cn/23/ba/23bab0c6ee4732baad41cda2ff06d214_2207x483.png)](img/snippet_clone_button_v13_0.png) 這使您可以獲取代碼段存儲庫的本地副本，并根據需要進行更改. 您可以提交這些更改并將其推送到遠程 master 分支. ### Limitations[](#limitations "Permalink") * 不支持二進制文件. * 不支持創建或刪除分支. 只有默認的*主人* . 使用分支. * 代碼段存儲庫中不支持 Git 標簽. * 片段的存儲庫僅限于一個文件. 嘗試推送多個文件將導致錯誤. * 修訂在 GitLab UI 上對用戶*尚不*可見，但計劃在以后的迭代中添加. 有關更新，請參見[修訂標簽問題](https://gitlab.com/gitlab-org/gitlab/-/issues/39271) . * 默認情況下， [摘要](../administration/snippets/index.html#snippets-content-size-limit)的[最大大小為](../administration/snippets/index.html#snippets-content-size-limit) 50 MB. ## Discover snippets[](#discover-snippets "Permalink") 在 GitLab 中發現片段的主要方法有兩種. 要瀏覽對您可見的所有代碼片段，您可以通過頂部導航轉到 GitLab 實例的代碼片段儀表板. 對于 GitLab.com，您可以在[這里](https://gitlab.com/dashboard/snippets)找到它. 這會將您導航到一個概述，該概述顯示您創建的摘要，并允許您瀏覽所有摘要. 如果要發現屬于特定項目的摘錄，則可以通過項目頁面上的左側導航導航到摘錄頁面. 項目片段被啟用，默認情況下可用，但他們可以通過導航到項目的**設置** ，擴大**知名度，項目功能，權限**和向下滾動到**片段**被禁用. 從那里，您可以切換以禁用它們，或從下拉菜單中選擇其他可見性級別. ## Snippet comments[](#snippet-comments "Permalink") 在 GitLab 9.2 中[引入](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/12910) . 使用 GitLab 代碼片段，您可以參與有關該代碼段的對話，從而促進用戶之間的協作. ## Downloading snippets[](#downloading-snippets "Permalink") 您可以下載代碼段的原始內容. 默認情況下，將下載帶有 Linux 樣式的行尾（ `LF` ）的代碼段. 如果要保留原始的行尾，則需要添加參數`line_ending=raw` （例如， `https://gitlab.com/snippets/SNIPPET_ID/raw?line_ending=raw` : `line_ending=raw` ）. 如果使用 GitLab Web 界面創建了代碼段，則原始行結尾類似于 Windows（ `CRLF` ）. ## Embedded snippets[](#embedded-snippets "Permalink") 在 GitLab 10.8 中引入. 公開片段不僅可以共享，還可以嵌入任何網站中. 這樣，您可以在多個地方重用 GitLab 代碼段，并且對源代碼的任何更改都會自動反映在嵌入式代碼段中. To embed a snippet, first make sure that: * 該項目是公開的（如果是項目摘要） * 摘要是公開的 * 在" **項目">"設置">"權限"中** ，將片段權限設置為" **具有訪問**權限的**所有人"** 滿足以上條件后，"嵌入"部分將出現在您的代碼片段中，您只需單擊"復制"按鈕即可. 這將復制一個單行腳本，您可以將其添加到任何網站或博客文章中. 示例代碼如下所示： ``` <script src="https://gitlab.com/namespace/project/snippets/SNIPPET_ID.js"></script> ``` 嵌入式代碼段的外觀如下：嵌入的代碼片段帶有一個標題，該標題顯示文件名（如果已定義），代碼片段大小，到 GitLab 的鏈接以及實際的代碼片段內容. 標頭中的操作使用戶可以查看原始格式的代碼段并下載.