Replies: 4 comments 5 replies
-
To be honest, I would just go and setup a GitHub Action. It doesn't take up much time and it's fairly easy to achieve. Material for MkDocs even does have an explanation on how you do it: https://squidfunk.github.io/mkdocs-material/publishing-your-site/#with-github-actions The most important part is just, that you need to trigger MkDocs' |
Beta Was this translation helpful? Give feedback.
-
GitHub just "bundles" Jekyll support, so it has an "unfair" advantage in that. If you have no way to run a site generator, then you're literally limited to whatever GitHub provides, that being either straight up the file browsing UI, or Jekyll. The only other thing I could think of is a "dual" approach where for preview you'd be relying on GitHub but what's deployed in the end is MkDocs. But the Markdown flavors have some large differences, so that'd just be a confusing mess. |
Beta Was this translation helpful? Give feedback.
-
Sorry to resurrect the dead but I am in the same boat. I don't have access to our companies Github instance to just "add" Actions, nor would the internal infra team want to incur a production change for my workflow alone. I am currently going to just try and write a cron job to run on a server that will do this but thought I would ask to see if you resolved this? |
Beta Was this translation helpful? Give feedback.
-
@syeda-git / @oprypin / @Andre601 / @unites / @sban2009 , I have added below which worked for me: If GitHub Actions cannot be utilized, you can manually deploy your MkDocs project to GitHub Pages by following these steps:
git checkout --orphan gh-pages
git rm -rf .
mv site/* .
rmdir site
git add .
git commit -m "Deploy MkDocs to GitHub Pages"
git push origin gh-pages
Your MkDocs documentation should now be accessible at |
Beta Was this translation helpful? Give feedback.
-
Hello,
I am evaluating tools for my company. MkDocs has many advantages. One of the use cases is to edit the source files in GitHub itself and when you commit the changes, the GitHub Pages site is refreshed. So, GitHub automatically builds the changes and deploys it to GitHub pages in the background. My company's GitHub does not yet support GitHub Actions and we don't want invest time and effort now at setting up a CI/CD tool.
I heard that with Jekyll the above use case is possible. Maybe because GitHub Pages is also based on Jekyll. Is there a way to achieve this capability with MkDocs or MkDocs with Material?
I read these docs:
https://www.mkdocs.org/user-guide/deploying-your-docs/
https://squidfunk.github.io/mkdocs-material/publishing-your-site/
Let me know if you have questions.
Thanks...
Syed
Beta Was this translation helpful? Give feedback.
All reactions