Experience Manager Guides and Edge Delivery Services

Open the Experience Manager Guides boilerplate template repository aem-guides-boilerplate.

Create a new repository using this template. Learn about Creating a repository from a template. Ensure that the repository visibility is set to Public so it can be accessed by EDS.

On GitHub, navigate to the left sidebar and select Developer settings.

In the left sidebar, select OAuth Apps.

Select New OAuth App.

{width="650"}

Register your application by providing the following mandatory details:

• Application name: Enter the name of your EDS repository
• Homepage URL: Enter the URL to the Experience Manager Guides instance. (For sample URL format, refer to step 4 of Create a new GitHub App section).
• Authorization callback URL: Same as Homepage URL

Select the Enable Device Flow option and then select Register application to complete the registration.

{width="650"}

In your GitHub repository, open the fstab.yaml file.

Update the url value using the following format:

https://guides.adobe.com/eds-workers/<account type>/<git acc domain>/<git username>/<git repo>/<branch>/<root folder>

The following table describes each field in the URL:

For example, if your GitHub user name is my-username and your repository name is my-eds-repo, the fstab.yaml file appears as follows:

mountpoints:
  /:
    url: https://guides.adobe.com/eds-workers/github/github.com/my-username/my-eds-repo/main/docs
    type: markup

{width="650"}

Repeat steps 2 and 3 from the Connect GitHub to Adobe via AEM Code Sync section to authorize the repository.

Navigate to the AEM Code Sync page and select Install.

AEM Code Sync monitors repository changes and ensures that updates are correctly pushed to GitHub.

On next page, grant access to the repository you created. Select Only select repositories, and then select your repository from the dropdown.

{width="350"}

Select Install and Authorize.

You are redirected to the GitHub setup page.

Review the source code details and select Next.

On the Content source page, configure the following settings:

• Content source type: Select Other (bring your own markup).
• Content source URL: Review the URL configured as the mountpoint URL in the fstab.yaml file. If you have not updated the URL in the file, you can update it here.
• File extension: Change the default .html suffix to .htm.

Ensure that Use a different content source is selected.

On the Users page, add users if required, and select Next.

Review the configuration summary and select Save.

After successful registration, a confirmation page appears. You can copy and save the Preview and Live URLs for your website from this page.

Go to Workspace settings > Publish profiles.

Select the + icon to create a new publish profile and provide the following details:

• Server type*: Select Git (Edge Delivery Service) from the dropdown.

• Name*: Enter a name for the publish profile.

• Git account type*: Select GitHub or GitLab from the dropdown, depending on your Git repository provider.

• Instance URL*: Enter the URL of your GitHub or GitLab instance, for example, https://github.com or https://gitlab.com.

• Repository name*: Enter the name of your GitHub or GitLab repository.

• User name*: Enter your GitHub or GitLab username.

• Branch name: Set to main (default).

• Root folder*: Set to docs (default).

• Site owner (GitLab only): Enter the owner of the Edge Delivery Services site.

• Site repo (GitLab only): Enter the repository name associated with the Edge Delivery Services site.

• HLX API key: Enter the HLX API key for your EDS configuration. This key is required to support the Unpublished feature introduced in the 2026.11.0 release of Experience Manager Guides as a Cloud Service. Also, the key is required for publishing the content to EDS if the content size is more than 100 files.

• Authentication credentials: Provide the credentials based on the selected Git account type:

  • GitHub: Enter the Client ID* and Client secret* obtained from your GitHub OAuth App. Refer to Create a new OAuth App for details.
  • GitLab: Enter the Access token* generated for your GitLab account.

(GitHub only) Select Login to authenticate. For GitLab, no login is required because the access token is used for authentication.

{width="650"}

Select Save. For GitHub, the Save option is available after successful authentication.

Open your map in Map console.

In the Output presets tab, select + to create a new output preset.

In the New output preset dialog, provide the following details:

• Type: Select Edge Delivery Service
• Name: Provide a name for this preset

Select Add.

{width="650"}

Open the newly created EDS output preset and configure the following fields:

• Conditional filtering: Select None to generate output without filtering or Using DITAVAL to apply conditional filtering.

• Publish subfolder: Enter the name of the subfolder in which the output is published. The subfolder is created in your repository under the root folder, and its name appears in the EDS links to the published content. For example, if the root folder is docs and the publish subfolder is product-guide, the content is published to docs/contents/product-guide.

• Publish profile: Select the GitHub or GitLab publish profile configured in the previous section.

  {width="650"}

Select Save, and then Generate output.

Go to your GitHub repository and open the blocks folder.

Select the breadcrumbs block.

{width="650"}

Open the css file and update the text color.

Commit the changes to GitHub.

Refresh the live website to view the updates.

Open the topic file and select the text inside a tag element.

In the following screenshot, the content inside the example tag is selected.
{width="650"}

To configure the text inside the example tag:

• Navigate to Content properties.
• Add the outputclass attribute.
• Set its value to example eds-force-block.
• Select Add.
  {width="650"}

Save and regenerate the output.

Create a new folder with the same name as the outputclass inside the blocks directory. Learn about adding files to a repository.

{width="650"}

Add the required css and optional js files.

{width="650"}

Commit changes and regenerate output.