Skip to content

📚 Add GitHub repo link to docs sidebar#4

Merged
ubmarco merged 1 commit into
mainfrom
docs/sidebar-github-link
May 22, 2026
Merged

📚 Add GitHub repo link to docs sidebar#4
ubmarco merged 1 commit into
mainfrom
docs/sidebar-github-link

Conversation

@ubmarco
Copy link
Copy Markdown
Member

@ubmarco ubmarco commented May 22, 2026

Summary

  • Adds a Furo sidebar block linking to the GitHub repo (with repo slug and current version), mirroring the sphinx-codelinks docs.
  • New template docs/source/_static/_templates/furo/side-github.html slotted into html_sidebars between scroll-end and the variant selector.
  • New docs/source/_static/furo.css with .gh-source* styling; the icon is pinned to --color-foreground-primary so the GitHub mark stays monochrome (black on light, white on dark) instead of inheriting Furo's brand-purple link color. Body link colors are left at Furo defaults — narrower scope than codelinks, which overrides --color-link globally.

Test plan

  • `sphinx-build -nW --keep-going -b html -T -c docs docs/source docs/_build/html` builds clean.
  • Rendered `index.html` contains `` with the `useblocks/sphinx-mounts` label.
  • Visually verify the icon is black in light mode and white in dark mode.

Mirrors the sphinx-codelinks pattern: a Furo sidebar block that links to
the GitHub repo, with the repo slug and current version. The GitHub mark
is forced to follow the foreground color so it stays monochrome in both
light and dark mode (other link colors are left at Furo defaults).
@ubmarco ubmarco changed the title 📝 DOC: Add GitHub repo link to docs sidebar 📚 Add GitHub repo link to docs sidebar May 22, 2026
@ubmarco ubmarco merged commit 294526a into main May 22, 2026
11 checks passed
@ubmarco ubmarco deleted the docs/sidebar-github-link branch May 22, 2026 13:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant