Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Deploy tutorial as static MkDocs site to GitHub pages #831

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

Karneades
Copy link

Add GitHub pages workflows to generate and deploy the tutorial as a static MkDocs site on GitHub pages.

The site is generated from the current markdown files and has

  • Previous and Next buttons in the footer
  • a simple side navigation
  • a powerful search from MkDocs using the MkDocs theme materials.
  • link to GitHub edit page from the individual pages
    • add buttons to jump quickly to GitHub for editing the page at hand
  • workflow for building and deploying the site to the gh_pages branch directly after merge to master which is then pushed to the GitHub pages site as static site.

We can afterwards remove the "Next" links at the end of each file as this is obsolete with the Next button.

Demo: https://karneades.github.io/kubernetes-the-hard-way/

Closes #819

@Karneades Karneades changed the title Add GitHub pages workflow to generate site using MkDocs Deploy tutorial static site generated by MkDocs to GitHub pages Jan 7, 2025
@Karneades Karneades changed the title Deploy tutorial static site generated by MkDocs to GitHub pages Deploy tutorial as static site generated by MkDocs to GitHub pages Jan 7, 2025
@Karneades Karneades changed the title Deploy tutorial as static site generated by MkDocs to GitHub pages Deploy tutorial as static MkDocs site to GitHub pages Jan 7, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add MkDocs site for the documentation
1 participant