Skip to content

GitHub

Connect GitHub so markdown documentation in your repositories—READMEs, docs folders, and guides—can power Mention alongside your other sources.

What gets synced

Mention discovers Markdown files (names ending in .md) in repositories you grant access to. It uses each repo’s default branch and walks the file tree so nested docs folders are included.

Other file types in the repo are not imported through this integration; the focus is markdown documentation.

How to connect

  1. Add GitHub as a source in Mention.
  2. Complete GitHub’s app installation flow: you will install the Mention app and choose which repositories (or the whole org) the app may access.
  3. After installation, browse the listed .md files and activate the ones you want Mention to use.

If you are unsure where your team authorizes apps, your GitHub org admin may need to approve the installation. See also Connecting sources.

Things to know

  • Only repositories included in the app installation can appear in Mention.
  • Private repos work as long as the installation has access; permissions follow GitHub’s rules for that installation.
  • File last-updated information comes from the repo history, which helps you spot stale docs in the product.

Sync behavior

Repository file listings and file contents are refreshed on a daily schedule. Run a manual refresh after merges or doc releases if you need Mention to see changes immediately.

Activation limit

You can activate up to 2,000 markdown files per GitHub integration (across all connected repositories).