MkDocs, Mardkown & GitHub Pages

1. Introduction
2. Material for MkDocs
3. Markdown and Markdown Cheat Sheet
4. GitHub Pages
5. GitBook
6. Alternatives. Jekyll open source static site generator
7. Videos
8. 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
• build5nines.com: GitHub Actions: Run Pandoc to convert Markdown to Word Document
• thomasthornton.cloud: Deploying MkDocs to GitHub Pages with GitHub Actions

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
• r-bloggers.com: How to use R Markdown (part one) R Markdown is a dynamic file format that allows you to make documents containing normal text alongside chunks of embedded R code.
• opensource.com: An introduction to Markdown
• github.blog: Include diagrams in your Markdown files with Mermaid A picture tells a thousand words. Now you can quickly create and edit diagrams in markdown using words with Mermaid support in your Markdown files.
• theverge.com: Google Docs is getting more Markdown support
• popsci.com: Google’s expanded Markdown feature could change how you work Google has expanded support for Markdown in Google Docs, Slides, and Drawings, and if you don’t understand what that means, that’s ok. If you do, you probably have had one of two reactions: “Cool, but that’s not enough” or “I’ll never use that.” You might be right in either case, but you should give Markdown a chance. You might just have the perfect use for it.
• readme.so The easiest way to create a README
• github.com/Ileriayo/markdown-badges: Markdown Badges Badges for your personal developer branding, profile, and projects.

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.
• freecodecamp.org: Documentation Libraries to Help You Write Good Docs Good project documentation is key to success for every company, startup, or individual project. Without documentation, it’s much harder for new developers or others to use your project.

Videos

Click to expand!

Tweets

Click to expand!

I really can'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.https://t.co/vFiHRAwKx4 pic.twitter.com/f8UYmY3LjO

— Martin Donath (@squidfunk) November 7, 2021