awesome-kubernetes/docs/mkdocs.md

MkDocs, Mardkown & GitHub Pages

• Introduction
• Material for MkDocs
• Markdown and Markdown Cheat Sheet
• GitHub Pages
• GitBook
• Alternatives. Jekyll open source static site generator

Introduction

• MkDocs
• websites that use MkDocs:
  • docs.traefik.io
  • fastapi.tiangolo.com
  • www.electron.build
  • etc

Material for MkDocs

• Material for MkDocs

Markdown and Markdown Cheat Sheet

• Markdown Tables Generator
• markdownguide.org
  • Markdown Cheat Sheet 1
• guides.github.com: Markdown Cheat Sheet 2
• Markdown Cheat Sheet 3
• Markdown Cheat Sheet 4

GitHub Pages

• pages.github.com
• opensource.com: How to create a documentation site with Docsify and GitHub Pages
• Access control for GitHub Pages

GitBook

• gitbook.com
  • Example

Alternatives. Jekyll open source static site generator

• opensource.com: Build your website with Jekyll Jekyll is an open source static site generator. You can write your content in Markdown, use HTML/CSS for structure and presentation, and Jekyll compiles it all into static HTML.