Slab is founded by engineers — so one of the first integrations we built and use religiously is GitHub.
Why integrate with GitHub?
Sync Markdown files (*.md) to Slab to organize and search them alongside your other documentation.
Mention GitHub Issues and Pull Requests and view context such as open status, assignee etc in directly in Slab.
Search GitHub Issues and Pull Requests from within Slab.
Sync or mirror GitHub markdown files
Engineering teams often store Getting Started and troubleshooting guides in GitHub as markdown files or READMEs, but this leads to silos between your GitHub content and the rest of your documentation.
With Slab you can sync READMEs and all .md files from GitHub, and organize and search them in the same way you would posts in Slab. You can add topics, verify GitHub posts, add them to series, share them (including publicly), and export them!
If you try to edit it, we'll kick you back to GitHub so you can keep your version control on those mission critical docs.
💡 Tip: You can even import READMEs from multiple different repositories.
✏️ Note: To enable this feature, a one-time setup by your admin is required. See the Admin setup guide below for details.
Mentions in Slab posts
To mention a GitHub issue, copy its link from your browser address bar. Paste the link inside a Slab post, and you will see it automatically unfurled into a dynamic mention! Hovering over the mention will open a preview with more details.
✏️ Note: To enable this feature, a one-time setup by your admin is required. See the Admin setup guide below for details.
Team Unified Search
Any teammate can use Unified Search to search their GitHub pull requests within Slab!
✏️ Note: To enable this feature, a one-time setup by your admin is required. See the Admin setup guide below for details.
Admin setup guide
As an admin, you can set up the GitHub integration for your team to use, and control their permissions:
Click your team name in the top-left corner of the sidebar.
Click Team settings in the dropdown menu.
Click on the Integrations tab, and find GitHub in the list of integrations.
Click Modify or Enable and follow the instructions in the modal to finish enabling the integration.
Under the Mentions tab, you can control which repositories your team can mention from.
Under the Search tab, you can control which repositories your team can search in.
Under the Sync tab, you can control which repositories to sync markdown files from.