Files
awesome-kubernetes/docs/mkdocs.md
Inaki Fernandez 1adf22bf46 Nov 2nd
2021-11-02 20:16:01 +01:00

39 lines
2.2 KiB
Markdown

# MkDocs, Mardkown & GitHub Pages
- [Introduction](#introduction)
- [Material for MkDocs](#material-for-mkdocs)
- [Markdown and Markdown Cheat Sheet](#markdown-and-markdown-cheat-sheet)
- [GitHub Pages](#github-pages)
- [GitBook](#gitbook)
- [Alternatives. Jekyll open source static site generator](#alternatives-jekyll-open-source-static-site-generator)
## Introduction
- [MkDocs](https://www.mkdocs.org/)
- [websites that use MkDocs](https://www.wappalyzer.com/technologies/documentation-tools/mkdocs):
- [docs.traefik.io](https://docs.traefik.io/)
- [fastapi.tiangolo.com](https://fastapi.tiangolo.com/)
- [www.electron.build](https://www.electron.build/)
- etc
- [dev.to: An amazing note-taking system with Markdown and Git Series' Articles](https://dev.to/scottshipp/series/15100)
## Material for MkDocs
- [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/)
## Markdown and Markdown Cheat Sheet
- [Markdown Tables Generator](https://www.tablesgenerator.com/markdown_tables)
- [markdownguide.org](https://www.markdownguide.org/)
- [Markdown Cheat Sheet 1](https://www.markdownguide.org/cheat-sheet/)
- [guides.github.com: Markdown Cheat Sheet 2](https://guides.github.com/pdfs/markdown-cheatsheet-online.pdf)
- [Markdown Cheat Sheet 3](https://3os.org/markdownCheatSheet/welcome/)
- [Markdown Cheat Sheet 4](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet)
## GitHub Pages
- [pages.github.com](https://pages.github.com/)
- [opensource.com: How to create a documentation site with Docsify and GitHub Pages](https://opensource.com/article/20/7/docsify-github-pages)
- [Access control for GitHub Pages](https://github.blog/changelog/2021-01-21-access-control-for-github-pages/)
## GitBook
- [gitbook.com](https://www.gitbook.com/)
- [Example](https://redhat-connect.gitbook.io/certified-operator-guide/)
## Alternatives. Jekyll open source static site generator
- [opensource.com: Build your website with Jekyll](https://opensource.com/article/21/9/build-website-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.