content

README指南：使用GitHub Webhooks更新 /學習生態系統

本指南概述了在 /學習生態系統（我們的內容中心）中管理更新的過程，使用github webhooks在我們的全文搜索索引中自動化內容更新，並在JavaScript中呈現Markdown文件。

概述

/學習生態系統中的每個文件夾都代表頁面或部分。這些文件夾包含構成頁面內容的標記文件（.md）。當對這些Markdown文件進行更改時，將激活GitHub觸發器，將更新的文件發送到預定義的Webhook。然後，此Webhook在我們的全文搜索索引中更新內容。最後，在網站上的JavaScript中渲染了更新的Markdown內容。

先決條件

• GitHub存儲庫，其標記內容在文件夾中構成。
• 訪問您的Web服務器或託管服務以設置Webhook偵聽器。
• 設置的全文搜索服務（如Elasticsearch）為您的內容索引。
• JavaScript的基本知識用於在網絡上渲染Markdown文件。

步驟1：組織您的內容

1. 在github存儲庫中的文件夾中構建內容，每個文件夾代表 /學習生態系統中的頁面或部分。
2. 確保所有內容都寫在降價文件（.md）中，並正確命名以反映其目的或內容。

步驟2：設置GitHub Webhook

1. 在您的github存儲庫中，轉到Settings > Webhooks > Add webhook 。
2. 輸入有效載荷URL。此URL應指向服務器上的Webhook偵聽器，將收到更新。
3. 選擇內容類型作為application/json 。
4. Just the push event 。
5. 確保選擇Active複選框並創建Webhook。

步驟3：創建Webhook偵聽器

1. 在您的服務器上，創建一個腳本，該腳本在GitHub Webhook設置中指定的URL上聽到發布請求。
2. 收到發布請求後，解析JSON有效載荷以識別更新的Markdown文件。
3. 對於每個更新的文件，請在您的全文搜索索引中更新其相應的內容。

示例（偽代碼）：

 app . post ( '/webhook-url' , ( req , res ) => {
  const updatedFiles = req . body . commits . map ( commit => commit . modified ) ;
  updatedFiles . forEach ( file => {
    updateSearchIndex ( file ) ;
  } ) ;
  res . status ( 200 ) . send ( 'Update received' ) ;
} ) ; 

步驟4：更新全文搜索索引

1. 從更新的Markdown文件中提取內容。
2. 在您的全文搜索索引中更新內容，以確保其可搜索並正確索引。

步驟5：JavaScript中渲染Markdown

1. 使用marked.js為js之類的JavaScript庫將Markdown內容轉換為HTML。
2. 如果需要，請從全文搜索索引或直接從GitHub存儲庫中獲取更新的Markdown內容。
3. 在 /學習生態系統中的適當頁面上渲染HTML內容。

示例（JavaScript）：

 fetch ( 'path/to/markdown.md' )
  . then ( response => response . text ( ) )
  . then ( markdown => {
    const htmlContent = marked ( markdown ) ;
    document . getElementById ( 'content' ) . innerHTML = htmlContent ;
  } ) ; 

結論

本指南提供了一種簡化的方法，可以使用github webhooks，全文搜索索引和JavaScript自動化 /學習生態系統中的內容更新。通過遵循以下步驟，您可以確保您的內容始終是最新的，並且可以由受眾訪問。