djangocms-git-md-page

DjangoCMS插件，用于显示git仓库中的Markdown页面。

安装

1. 将djangocms-git-md-plugin添加到需求中，并在环境中安装。

# setup.py
setup(
    install_requires=[
        # ...
        'djangocms-git-md-page',
    ]
)

2. 将git_md_page添加到INSTALLED_APPS

# settings.py
INSTALLED_APPS = [
    # ...
    'git_md_page',
]

3. 在urls中创建一个条目，用于接收来自GitHub的通知。

# urls.py
urlpatterns = [
    # ...
    path('git_md_page/', include('git_md_page.urls')),
]

4. 运行迁移

$ python manage.py migrate

使用方法

在CMS管理中，点击+符号添加新插件。该插件名为Git MD页面，位于其他部分。

首先，需要选择源仓库。可以从可用的选项中选择，或通过点击选择框旁边的+符号创建新的选择（新源仓库）。每个仓库由其地址和分支定义。在表单中，有提示说明应使用什么值。还有一个名为secret的另一个字段。其默认值是一个随机字符串，可以保留以供进一步使用。此secret值随后用于GitHub管理中的安全目的。

当成功选择仓库后，接下来填写所需MD文件的路径。

之后，需要在GitHub项目管理中设置一个webhook。每次仓库中文件的更改都会更新插件的页面内容。在您的GitHub项目管理中，点击设置（页面顶部的水平导航），Webhooks（左侧垂直导航），添加webhook（右上角的一个按钮）。

注意：如果垂直导航中没有Webhooks，则可能没有管理webhooks的权限，应要求项目所有者执行此操作或请求权限。

通过一个新的webhook，您将负载URL设置为https://your.domain/git_md_page/endpoints/git_update/<repository-id>/。其中your-domain是网页托管的服务器域名，<repository-id>将在后面进行解释。将ContentType设置为application/json，最后将Secret设置为您之前提到的django-cms web应用程序中存储库的Secret的相同值（默认情况下应该是随机字符串）。

最后要提到的是<repository-id>。获取此ID有些令人困惑。在django-cms网络管理编辑存储库实例，并检查URL地址。它应该看起来像https://your.domain/en/admin/git_md_page/gitrepository/1/change/?_to_field=id&_popup=1。其中gitrepository/1/（别名gitrepository/<repository-id>/）是重要的，因为它携带存储库标识符，即1。这个标识符随后在设置webhook时用于负载URL，如前所述。

有关GitHub webhooks的更多信息，请参阅文档。