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自动化 /学习生态系统中的内容更新。通过遵循以下步骤，您可以确保您的内容始终是最新的，并且可以由受众访问。