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

Add MkDocs site for the documentation #819

Open
Karneades opened this issue Nov 7, 2024 · 1 comment
Open

Add MkDocs site for the documentation #819

Karneades opened this issue Nov 7, 2024 · 1 comment

Comments

@Karneades
Copy link

Karneades commented Nov 7, 2024

Hi Kelsey

Thanks a lot for your project and documentation around Kubernetes.

As I came across your repo, I just wondered, what do you think about a MkDocs variant of your documentation repo? Would you be interested in making the docs available as a GitHub page?

For a quick test I just added the introduction from the readme to the docs and the MkDocs config file (see commit). It has some Previous and Next buttons in the footer, a simple side navigation and a powerful search from MkDocs. If we go with such a static site generator, we can remove the manual "Next" links at the end of each file.

@Karneades Karneades changed the title Add MkDocs site the documentation Add MkDocs site for the documentation Nov 8, 2024
@Karneades
Copy link
Author

Karneades commented Nov 14, 2024

Changes to fork since initial post:

  • add link to GitHub
  • add buttons to jump quickly to GitHub for editing the page at hand
  • add workflow for building and deploying the site to the gh_pages branch directly after merge to master/main which is then pushed to the GitHub pages site.

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

No branches or pull requests

1 participant