how to put workshop on github

obsidian tips

• obsidian

Material for mkdocs

https://github.com/squidfunk/mkdocs-material

review local

mkdocs serve

status in front matter

• get icons: https://pictogrammers.com/library/mdi/

• copy paste to extra.css

• emoji and icons, search from here

  • https://squidfunk.github.io/mkdocs-material/reference/icons-emojis/#using-emojis

plugins for mkdocs

• https://github.com/mkdocs/catalog
• For full documentation visit mkdocs.org

enable discussion

• start from this page (link)
• generate config file (link)
• add comment: true to all pages (link)

awesome pages plugin

• https://github.com/lukasgeiter/mkdocs-awesome-pages-plugin

highlight block

in material for mkdocs

• https://squidfunk.github.io/mkdocs-material/reference/admonitions/
  

  !!! warning "This is a github note"
  ??? note "right-click & open-in-new-tab: "
  

• sample

This is a github note

in hosted on github

[!WARNING]
This is a github note

[!IMPORTANT]
Crucial information necessary for users to succeed.

[!NOTE]
Critical content demanding immediate user attention due to potential risks.

[!example]

remove custom domain

• remove static/CNAME file
  • this file include line: aws-labs.panlm.xyz
• remove custom domain from github Pages page
• rename repo name to git-ghpages
• change in config.toml
  • baseURL –> https://panlm.github.io/git-ghpages/

hosted on github page

• https://gohugo.io/hosting-and-deployment/hosting-on-github/

build local

• https://aws-samples.github.io/aws-modernization-workshop-sample/20_build/1_setup/

git submodule init
git submodule update

other