Using submodules with Pages

You can use submodules with GitHub Pages with a few conditions.

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 your GitHub Pages site repository contains submodules, they will automatically be pulled in when the Page is built.

Submodule requirements

You can only use submodules with GitHub Pages sites that point to public repositories. Using a submodule that points to a private repository is not possible because the Pages server cannot access private repositories. If you're adding a submodule to a private GitHub Pages repository, your pages site will still be published publicly.

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

Ask a human

Can't find what you're looking for?

Contact us