Multi-branch deployment

[opensource-coder909]

Hi there

How can I deploy my mkdocs-material site on different branches at the same time so a person can view my mkdocs documentation in different branch versions?

Greedings

[kamilkrzyskow]

Hello @opensource-coder909,
I don't quite understand the wording of deploying to different branches. If you mean a git branch then it's typically the source of the site not the destination. Also GitHub supports only one GitHub Pages instance for a given repository so you'd have to provide more details.

MkDocs generates static HTML files, so as long as you properly set the root of the page via the site_url option, then you could include multiple sites on one GitHub Pages instance which would differ in the root directory.

You can look at versioning, which applies the same principle of having multiple versions of the page available:

• https://squidfunk.github.io/mkdocs-material/setup/setting-up-versioning/#setting-up-versioning
• https://mkdocs-material.github.io/example-versioning/latest/

Each branch you have could be a different version.