Using submodules with GitHub Pages

You can use submodules with GitHub Pages to include other projects in your site's code.

GitHub Pages is available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see "GitHub's products."

If the repository for your GitHub Pages site contains submodules, their contents will automatically be pulled in when your site is built.

You can only use submodules that point to public repositories, because the GitHub Pages server cannot access private repositories.

Use the https:// read-only URL for your submodules, including nested submodules. You can make this change in your .gitmodules file.

Further reading

Ask a human

Can't find what you're looking for?

Contact us