Help
cancel
Showing results for 
Search instead for 
Did you mean: 
Highlighted
Pilot Lvl 1
Message 1 of 2

How to add MkDocs to GitHub pages

Solved! Go to Solution.

I would like to host my API documentation through GitHub Pages and by using MkDocs with the Material theme.

 

But all the docs (including the ones from MkDocs themself) I found are too confusing for me.

So I would appreciate if anyone here would have an Idiot proof instruction on how you could set pages up using MkDocs, preferably without needing to install any software/tools on my own PC.

1 Reply
Highlighted
Solution
Community Manager
Message 2 of 2

Re: How to add MkDocs to GitHub pages

Hi @Andre601,

 

Thanks for being here! A community member created a GitHub Action to automate this, might be worth checking out for what you are trying to accomplish.

 

https://github.com/mhausenblas/mkdocs-deploy-gh-pages


I hope this helps,
Andrea

Mark helpful posts with Accept as Solution to help other users locate important info. Don't forget to give Kudos for great content!