Experience Manager Guides和Edge Delivery Services
Adobe Experience Manager Guides允许您通过基于GitHub的专用发布配置文件直接将DITA内容发布到Edge Delivery Services (EDS)。 此功能使组织能够提供高性能、响应式文档体验,同时在Experience Manager Guides中维护基于DITA的创作工作流。
有关在Adobe Experience Manager中使用EDS的详细信息,请查看Edge Delivery Services概述。
要支持从Experience Manager Guides发布到EDS,您必须完成GitHub和Experience Manager Guides中的一系列配置步骤。 以下各节将依次概述每个步骤,并解释它们如何在整个发布工作流程中协同工作。
若要快速视频演练,请查看AEM Guides中的发布。
为EDS设置和配置GitHub
本节介绍如何设置和配置GitHub以与EDS一起使用。 它介绍如何使用Adobe样板创建存储库,通过AEM代码同步将GitHub连接到Adobe Experience Manager,配置所需的GitHub和OAuth应用程序,以及定义用于发布内容的存储库装入点。
为EDS创建GitHub存储库
EDS需要一个具有预定义结构的GitHub存储库。 Adobe提供了专为Experience Manager Guides用户设计的官方模板存储库。
执行以下步骤可创建存储库:
-
打开Experience Manager Guides样板模板存储库aem-guides-boilerplate。
-
使用此模板创建新存储库。 了解从模板创建存储库。 确保将存储库可见性设置为Public,以便EDS可以访问该存储库。
存储库现已创建并与样板模板结构保持一致。
创建新的OAuth应用程序
在Experience Manager Guides中创建EDS发布配置文件时,需要使用OAuth应用程序对用户进行身份验证。 它使用 客户端ID 和 客户端密钥 启用安全登录流程。
执行以下步骤可创建新的OAuth应用程序:
-
在GitHub上,导航到左侧边栏并选择开发人员设置。
-
在左侧边栏中,选择OAuth应用程序。
-
选择新建OAuth应用程序。
{width="650"}
-
通过提供以下强制性详细信息注册您的应用程序:
- 应用程序名称:输入EDS存储库的名称
- 主页URL:输入Experience Manager Guides实例的URL。 (有关示例URL格式,请参阅创建新的GitHub应用程序部分的步骤4)。
- 授权回调URL:与主页URL相同
-
选择 启用设备流 选项,然后选择 注册应用程序 以完成注册。
{width="650"}
您的应用程序现已准备就绪。 记下客户端ID。 在Experience Manager Guides中配置发布配置文件时,您现在或以后最多可以生成五个客户端密钥。
在EDS存储库中配置装载点URL
EDS从存储库根目录的fstab.yaml文件中定义的装入点 URL中读取内容。 此URL将EDS指向Experience Manager Guides发布所生成内容的位置。
要在fstab.yaml文件中配置挂载点URL,请执行以下操作:
-
在GitHub存储库中,打开
fstab.yaml文件。 -
使用以下格式更新
url值:code language-text https://guides.adobe.com/eds-workers/<account type>/<git acc domain>/<git username>/<git repo>/<branch>/<root folder>下表介绍了URL中的每个字段:
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2 字段 描述 https://guides.adobe.com/eds-workersExperience Manager Guides用于向EDS发布内容的工作者URL。 请勿更改此值。 <account type>Git帐户的类型。 设置为 github。<git acc domain>Git帐户的域。 设置为 github.com。<git username>您的GitHub用户名。 <git repo>您为EDS创建的GitHub存储库的名称。 <branch>要发布内容的分支。 默认值为 main。 如果您在GitHub上更改分支名称,请在此处并在Experience Manager Guides的EDS发布配置文件中更新它。<root folder>提交已发布文件的存储库的根文件夹。 默认值为 docs。 如果您在GitHub上更改文件夹名称,请在此处并在Experience Manager Guides的EDS发布配置文件中更新它。例如,如果您的GitHub用户名是
my-username,存储库名称为my-eds-repo,则fstab.yaml文件将显示如下:code language-yaml mountpoints: /: url: https://guides.adobe.com/eds-workers/github/github.com/my-username/my-eds-repo/main/docs type: markup {width="650"}
note NOTE 如果您继续使用以前的URL格式( https://guides.adobe.com/eds-workers/<git username>/<git repo>/<branch>/<root folder>),则帐户类型和域默认为github和github.com。 -
重复步骤2和3,从通过AEM代码同步部分将GitHub连接到Adobe以授权存储库。
通过AEM代码同步将GitHub连接到Adobe
Adobe Experience Manager使用名为 AEM Code Sync 的GitHub应用程序将内容从Experience Manager Guides推送到GitHub。
执行以下步骤以安装和配置 AEM代码同步 应用程序:
-
导航到AEM代码同步页面,然后选择安装。
AEM代码同步监视存储库更改并确保将更新正确推送到GitHub。
note NOTE 安装应用程序时,请确保您使用的是拥有存储库的同一GitHub帐户。
-
在下一页上,授予对您创建的存储库的访问权限。 选择仅选择存储库,然后从下拉列表中选择您的存储库。
{width="350"}
-
选择安装并授权。
您将被重定向到GitHub设置页面。
-
查看源代码详细信息并选择下一步。
-
在 内容源 页面上,配置以下设置:
- 内容源类型:选择其他(自带标记)。
- 内容源URL:查看
fstab.yaml文件中配置为装入点URL的URL。 如果您尚未更新文件中的URL,可以在此处更新它。 - 文件扩展名:将默认
.html后缀更改为.htm。
确保已选择使用其他内容源。
-
在 用户 页面上,根据需要添加用户,然后选择下一步。
-
查看配置摘要并选择保存。
成功注册后,将显示确认页面。 您可以从此页面复制并保存您网站的 预览 和实时 URL。
为EDS设置和配置GitLab
有关将GitLab配置为Edge Delivery Services的发布存储库的说明,请查看为EDS设置和配置GitLab。
在Experience Manager中创建并配置EDS的发布配置文件
以下各节将依次概述每个步骤,并解释如何在Experience Manager Guides中设置EDS发布配置文件、配置输出预设以及使用EDS生成输出。
创建GitHub或GitLab的EDS发布配置文件
-
转到Workspace设置 > 发布配置文件。
-
选择 + 图标以创建新的发布配置文件并提供以下详细信息:
-
服务器类型*:从下拉列表中选择Git (Edge Delivery服务)。
-
名称*:输入发布配置文件的名称。
-
Git帐户类型*:从下拉列表中选择 GitHub 或GitLab,具体取决于您的Git存储库提供程序。
-
实例URL*:输入GitHub或GitLab实例的URL,例如
https://github.com或https://gitlab.com。 -
存储库名称*:输入GitHub或GitLab存储库的名称。
-
用户名*:输入您的GitHub或GitLab用户名。
-
分支名称:设置为
main(默认)。 -
根文件夹*:设置为
docs(默认)。 -
站点所有者(仅GitLab):输入Edge Delivery Services站点的所有者。
-
站点存储库(仅GitLab):输入与Edge Delivery Services站点关联的存储库名称。
-
HLX API密钥:输入用于EDS配置的HLX API密钥。 要支持Experience Manager Guides as a Cloud Service 2026.11.0版本中引入的未发布功能,需要此密钥。 此外,如果内容大小超过100个文件,则需要密钥才能将内容发布到EDS。
-
身份验证凭据:提供基于所选Git帐户类型的凭据:
- GitHub:输入从您的GitHub OAuth应用程序获得的 客户端ID* 和客户端密钥*。 有关详细信息,请参阅创建新的OAuth应用程序。
- GitLab:输入为您的GitLab帐户生成的Access token*。
-
-
(仅限GitHub)选择 登录 以进行身份验证。 对于GitLab,无需登录,因为访问令牌将用于身份验证。
{width="650"}
-
选择保存。 对于GitHub,在成功进行身份验证后,保存选项可用。
您的EDS发布配置文件现已配置完成。
创建EDS的输出预设并生成输出
-
在地图控制台中打开您的地图。
-
在 输出预设 选项卡中,选择 + 以创建新的输出预设。
-
在 新建输出预设 对话框中,提供以下详细信息:
- 类型:选择Edge Delivery服务
- 名称:提供此预设的名称
-
选择添加。
{width="650"}
-
打开新创建的EDS输出预设,并配置以下字段:
-
条件筛选:选择 无 生成输出而不进行筛选,或选择 使用DITAVAL 应用条件筛选。
-
发布子文件夹:输入在其中发布输出的子文件夹的名称。 子文件夹在存储库的根文件夹下创建,其名称显示在指向已发布内容的EDS链接中。 例如,如果根文件夹为
docs,而发布子文件夹为product-guide,则内容将发布到docs/contents/product-guide。 -
发布配置文件:选择在上一部分中配置的GitHub或GitLab发布配置文件。
{width="650"}
-
-
选择保存,然后选择生成输出。
<root folder>/contents/<publish subfolder>文件夹中。此时会生成EDS输出。 内容以简洁的响应布局显示。 它包括常规元素,例如页面标题、痕迹导航、正文内容以及主题中使用的任何块。 左侧的目录(从地图生成)可帮助您跨主题导航,而右侧的迷你目录会突出显示当前页面中的部分。 整个输出完全响应,确保跨设备优化、一致的读取体验。
使用EDS块自定义输出
EDS使用blocks来控制内容的不同部分的样式和显示方式。 您可以修改现有块或创建自定义块。
以下列出的示例指导您完成自定义现有块并创建新块以设置Experience Manager Guides中最终EDS输出的样式。
自定义痕迹导航块以更新其文本颜色
跨页面使用痕迹导航,以帮助用户了解它们在文档中的位置。 由于此块在整个网站中始终显示,因此更新其样式可以统一更新设计。
执行以下步骤可自定义痕迹导航块以更新其文本颜色:
-
转到您的GitHub存储库并打开
blocks文件夹。 -
选择 痕迹导航 块。
{width="650"}
-
打开
css文件并更新文本颜色。 -
将更改提交到GitHub。
-
刷新实时网站以查看更新。
更新EDS脚本以在发布的输出中创建自定义元素
在某些情况下,您可能希望仅设置内容特定部分的样式。 请使用自定义块执行以下步骤来实现这一点。
-
打开主题文件并选择标记元素中的文本。
在以下屏幕截图中,选择了
example标记中的内容。
{width="650"}
-
要配置
example标记中的文本,请执行以下操作:- 导航到内容属性。
- 添加
outputclass属性。 - 将其值设置为
example eds-force-block。 - 选择添加。
{width="650"}
-
保存并重新生成输出。
-
在
blocks目录中创建一个与outputclass同名的新文件夹。 了解将文件添加到存储库。 {width="650"}
-
添加必需的
css和可选的js文件。 {width="650"}
-
提交更改并重新生成输出。
所选内容现在显示块中定义的自定义样式。