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
• Tweets

Introduction

• MkDocs
• websites that use MkDocs:
  • docs.traefik.io
  • fastapi.tiangolo.com
  • www.electron.build
  • etc
• dev.to: An amazing note-taking system with Markdown and Git Series' Articles

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
• dev.to: How we made the markdown toolbar

GitHub Pages

• pages.github.com
• opensource.com: How to create a documentation site with Docsify and GitHub Pages
• Access control for GitHub Pages
• dev.to: How to View Build Logs 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.

Tweets

??? note "Click to expand!"

<center>
<blockquote class="twitter-tweet"><p lang="en" dir="ltr">I really can&#39;t wait for code annotations to be generally available! They have the potential to transform the way we document code examples, allowing for rich text (incl. images, graphs, tables, etc.) to be co-located with code.<a href="https://t.co/vFiHRAwKx4">https://t.co/vFiHRAwKx4</a> <a href="https://t.co/f8UYmY3LjO">pic.twitter.com/f8UYmY3LjO</a></p>&mdash; Martin Donath (@squidfunk) <a href="https://twitter.com/squidfunk/status/1457299354386116610?ref_src=twsrc%5Etfw">November 7, 2021</a></blockquote> <script async src="https://platform.twitter.com/widgets.js" charset="utf-8"></script>
</center>