Arcane Lexicon provides GitHub integration through SiteConfig.githubUrl and SiteConfig.editBranch.

Edit This Page Links#

When githubUrl is configured and showEditLink is true, pages include an edit link.

SiteConfig(
  name: 'My Docs',
  githubUrl: 'https://github.com/myorg/myproject',
  editBranch: 'main',
  showEditLink: true,
)

Edit URL shape:

{githubUrl}/edit/{editBranch}/{contentDirectory}/{pagePath}.md

Example:

https://github.com/acme/docs/edit/main/content/guide/basics/installation.md

Repository Link in Navigation Bar#

When githubUrl is present and the top/bottom navigation bar is enabled, the default KBTopBar renders a GitHub icon link.

SiteConfig(
  name: 'My Docs',
  githubUrl: 'https://github.com/myorg/myproject',
  navigationBarEnabled: true,
)

Changelog Release Links#

KBChangelog can generate release links when you pass githubUrl.

KBChangelog(
  versions: changelogVersions,
  githubUrl: 'https://github.com/myorg/myproject',
)

Release URL shape:

{githubUrl}/releases/tag/v{version}

Notes on Sidebar Footer Fields#

sidebarFooter and sidebarFooterUrl exist on SiteConfig, but the default KBLayout path does not currently render them. Use a custom layout if you need them displayed.