Static Site Editor · Gitlab 中文文檔

# Static Site Editor > 原文：[https://docs.gitlab.com/ee/user/project/static_site_editor/](https://docs.gitlab.com/ee/user/project/static_site_editor/) * [Use cases](#use-cases) * [Requirements](#requirements) * [How it works](#how-it-works) * [Getting started](#getting-started) * [Set up your project](#set-up-your-project) * [Use the Static Site Editor to edit your content](#use-the-static-site-editor-to-edit-your-content) * [Limitations](#limitations) # Static Site Editor[](#static-site-editor "Permalink") 版本歷史 * 在 GitLab 12.10 中[引入](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/28758) . * 在 GitLab 13.0 中[引入](https://gitlab.com/gitlab-org/gitlab/-/issues/214559)了所見即所得的編輯器. * 支持通過 GitLab 13.1 中[引入](https://gitlab.com/gitlab-org/gitlab/-/issues/216640)的 WYSIWYG 編輯器添加圖像. * Markdown 前端問題隱藏在 GitLab 13.1 中[引入](https://gitlab.com/gitlab-org/gitlab/-/issues/216834)的 WYSIWYG 編輯器中. * 支持 GitLab 13.2 中[引入的](https://gitlab.com/gitlab-org/gitlab/-/issues/223171) `*.md.erb`文件. **危險：**在 GitLab 13.0 中，我們對靜態站點編輯器的 URL 結構進行了[重大更改](https://gitlab.com/gitlab-org/gitlab/-/issues/213282) . 請按照此[代碼段中](https://gitlab.com/gitlab-org/project-templates/static-site-editor-middleman/snippets/1976539)的說明使用最新更改來更新您的項目. 靜態站點編輯器使用戶可以在靜態網站上編輯內容，而無需事先了解基礎模板語言，站點體系結構或 Git 命令. 您的項目的貢獻者可以快速編輯 Markdown 頁面，并將更改提交審核. ## Use cases[](#use-cases "Permalink") 靜態站點編輯器允許協作者無縫地將更改提交到靜態站點文件. 例如： * 非技術合作者可以直接從瀏覽器中輕松編輯頁面；他們不需要知道 Git 和您的項目的詳細信息就能做出貢獻. * 最近雇用的團隊成員可以快速編輯內容. * 臨時協作者可以從一個項目跳到另一個項目并快速編輯頁面，而不必克隆或派生需要提交更改的每個項目. ## Requirements[](#requirements "Permalink") * 為了使用靜態站點編輯器功能，您的項目需要使用[靜態站點編輯器 Middleman 模板](https://gitlab.com/gitlab-org/project-templates/static-site-editor-middleman)進行預配置. * 該編輯器需要登錄到 GitLab，并且必須是該項目的成員（具有 Developer 或更高權限級別）. ## How it works[](#how-it-works "Permalink") 靜態網站編輯器尚處于開發的早期階段，目前僅適用于 Middleman 網站. 您必須使用特定的站點模板才能開始使用它. 項目模板配置為使用[GitLab Pages](../pages/index.html)部署[Middleman](https://middlemanapp.com/)靜態網站. 網站啟動并運行后，您將在其頁面的左下角看到一個" **編輯此頁面"**按鈕： [![Edit this page button](https://img.kancloud.cn/81/a7/81a7490529e42050da09959a233e5d42_1894x1146.png)](img/edit_this_page_button_v12_10.png) 單擊它后，GitLab 將打開一個編輯器窗口，從中可以直接編輯內容. 準備就緒后，只需單擊一下按鈕即可提交更改： [![Static Site Editor](https://img.kancloud.cn/4f/94/4f94e24371791bed209a57a42daf64cb_2586x990.png)](img/wysiwyg_editor_v13_0.png) 當編輯者在后臺提交更改時，GitLab 會自動創建一個新分支，提交更改并打開合并請求. 編輯者將直接進入合并請求，然后可以將其分配給同事進行審查. ## Getting started[](#getting-started "Permalink") 首先，設置項目. 完成后，您可以使用靜態站點編輯器輕松地編輯您的內容. ### Set up your project[](#set-up-your-project "Permalink") 1. 首先，從" [靜態站點編輯器-中間人"](https://gitlab.com/gitlab-org/project-templates/static-site-editor-middleman)模板創建一個新項目. 您可以將其[派生](../repository/forking_workflow.html#creating-a-fork)或[從模板創建一個新項目](../../../gitlab-basics/create-project.html#built-in-templates) . 2. 編輯`data/config.yml`文件，添加項目的路徑. 3. 編輯文件將觸發 CI / CD 管道，以使用 GitLab Pages 部署項目. 4. 管道完成后，從項目的左側菜單轉到**"設置">"頁面"**以找到新網站的 URL. 5. 訪問您的網站并查看屏幕的左下角，以查看新的" **編輯此頁面"**按鈕. 滿足[要求的](#requirements)任何人都可以編輯頁面內容，而無需事先了解 Git 或您網站的代碼庫. **注意：**從 GitLab 13.1 開始，Markdown 文件的 YAML 前端問題被隱藏在 WYSIWYG 編輯器中，以避免意外更改. 要對其進行編輯，請使用 Markdown 編輯模式，常規的 GitLab 文件編輯器或 Web IDE. ### Use the Static Site Editor to edit your content[](#use-the-static-site-editor-to-edit-your-content "Permalink") 例如，假設您是一家大型公司的新近聘用的技術作家，并且該公司的產品已添加了新功能. 1. 您被分配了更新文檔的任務. 2. 您訪問頁面并看到需要編輯的內容. 3. 單擊生產站點上的" **編輯此頁面"**按鈕. 4. 該文件在"靜態站點編輯器"中以" **所見即所得"**模式打開. 如果您想編輯原始 Markdown，則可以在右下角切換**Markdown**模式. 5. 您在此處編輯文件，然后單擊" **提交更改"** . 6. 將自動創建一個新的合并請求，然后將其分配給您的同事進行審核. ## Limitations[](#limitations "Permalink") * 靜態站點編輯器仍然不能快速添加到現有的 Middleman 站點. 跟隨此[史詩](https://gitlab.com/groups/gitlab-org/-/epics/2784)進行更新.