Have a look at this GitHub Doc. It's an instruction to how you can add a profile excerpt to your GitHub profile, which will automatically show, when people browse to your handle.
- Read the description on the link above
- Create a repo which has the same name as your handle, make it public and and a
README.md
file
- Start by copying the content from the file you just created in teh previosu exercise, and paste it into the
README.md
file, in the repo that has the name of your handle.
Hints:
👉 Try to hover over the link above (hover = hold your cursor still over the link, but don't click it). See the link description that emerges? Where did that come from? 1
👉 Did you see the foot note above!
👉 Noticed how links in .md
files on GitHub always opens in the same (current) tab - The GitHub Flavored MarkDown syntax doesn't support to spec a link to be opened in a new window or tab (KramDown does!). But no problem! Hold down <CTRL>
on Windows or <CMD>
on Mac while you click the link, and it opens in a new tab.
MarkDown is supported in all GitHub documentation:
.md
files- Issue descriptions and comments
- Discussions
- Annotated reviews
- Wiki pages
- GitHub pages (static web sites)
Both Chat GPT and Bing Chat supports generating output in MarkDown.
- Ask Chat GPT anything and append "... and by the way, please type the output in MarkDown" to your prompt. Then copy the output from the chat into a new
.md
file her in this repo. It appears that anything you get from prompt engineering can be pasted directly into your GitHub documentation, discussions or chats.
Footnotes
-
You can do amazing stuf in MarkDown - GitHub uses it's own variant GitHub Flavored MarkDown The basics are really simple, but the full capabilities of the syntax are quite advanced. At the core is KramDown - the most common MarkDown implementation - KramDown supports Footnotes! There you have it! - Confused yet? ↩