learn-markdown-with-phoebe / Session 4 of 4
Learn Markdown with Phoebe · Session 4 of 4

Ship it: your page, live on GitHub

Three sessions of drafting and polishing come down to today: the about-me page in your editor becomes your public GitHub profile, visible to anyone on Earth who looks you up. One repo, one paste, one commit. Bring your finished draft and something to celebrate with.

🔴 Hands-on GitHub account (free) Bring your finished draft 45 min live + self-study
0-3 · Welcome 3-15 · Concepts 15-40 · Publish lab 40-45 · Show + tell
Part 0

The moment

Everything so far happened in a browser tab only you could see. Today that changes. Your page - headings, photo, table, badges, Mermaid diagram, all of it - goes live at a real public URL. This is the shortest concept block of the course on purpose: today is for shipping, not studying.

Live - presented in session Self-study - read after class ★ Build-along demo The project: YOUR page, LIVE
★ What you walk out with today Your markdown page live at github.com/yourusername - the first thing anyone sees when they look you up on GitHub. Plus the skills that got it there: creating a repo, editing in the GitHub web editor, previewing, and committing. From here on, every edit you make is published in seconds.
Part 1 · covers GitHub web-editor basics

GitHub in 5 minutes, no trauma 5 min live

You do not need to be a programmer to use GitHub, and today you will not touch a terminal or type a single git command. Two ideas and three buttons are the whole toolkit.

LiveWhat GitHub is, for a non-coder2 min▶

Strip away the developer mystique and GitHub is a place that stores text files and renders markdown beautifully. That's genuinely all you need it to be today. Two words of vocabulary:

  • Repo (repository): a folder with a name. Yours will hold exactly one file.
  • Commit: a save, with a short note attached saying what changed. That's it - "commit" is developer for "save with a memo".

Your markdown file needs zero changes to work there. GitHub speaks GFM - the exact flavor you've been writing since Session 2.

LiveThe web editor: three buttons, no terminal2 min▶

Everything today happens on github.com in your browser:

  • The pencil ✏️ on any file opens it for editing, right on the page.
  • The Preview tab shows the rendered result before you save - GitHub's version of your split-pane right side, one click away.
  • The Commit button saves, with your note. The moment you commit, the change is live.

Edit, preview, commit. That loop is the entire workflow, and you'll run it three times before this session ends.

Self-studyWhat version history buys you2 min read▶

Every commit is kept, forever. Click History on any file and you can see every version you ever saved, who saved it, and when. Nothing is ever overwritten - which means fearless editing: you cannot destroy your page, only add versions of it. Made a mess? Open History, view the last good version, copy it back, commit again.

Every commit is kept - nothing is ever destroyed, only added commit 1 SAVED my page, v1 commit 2 OOPS typo, broken link commit 3 RESTORED copied v1 back History: copy the last good version back Nothing is ever overwritten - a bad commit is just one more version, never a destroyed one.
🔍 Click to zoom - History turns every mistake into a two-click fix, never a disaster
Real world

This is why the world's documentation lives on GitHub: the entire Python docs, Microsoft's docs, most open-source READMEs. Thousands of strangers edit the same markdown files, and version history means no edit is ever a risk. The safety net you get on your one-file profile repo is the same one protecting projects with a million users.

Part 2 · covers GitHub Docs: managing your profile README

The magic repo 4 min live

GitHub has one special trick: create a repo named exactly your username, and its README takes over the top of your public profile page. GitHub's docs call it a "special repository" - we call it the magic repo. Four conditions, all required.

LiveThe username/username trick: ALL FOUR requirements2 min · recite these▶

Straight from GitHub's docs - your profile README shows only when all four hold:

  • 1 · Name match: the repository's name matches your GitHub username exactly. Username octocat needs repo octocat/octocat.
  • 2 · Public: the repository is public.
  • 3 · Right file, right place: a file named README.md sits in the root of the repository.
  • 4 · Not empty: the README.md contains any content at all.

Miss any one and the profile simply shows nothing - no error, no hint. Memorize the four and you can debug any invisible profile in a minute.

All four requirements must hold, or nothing shows 1 Name matches your username exactly 2 Repository is public 3 README.md sits in the root 4 README.md has real content ALL FOUR TRUE? yes ✓ README shows on your profile no ✗ Shows nothing no error, no hint Miss any one of the four and the profile simply shows nothing - no error, no hint anywhere.
🔍 Click to zoom - four small checks gate one big outcome, and there is no partial credit
LiveThe creation flow, in one breath1 min▶

New repository → name it your username → Public → check "Add a README file" → Create.

Two nice surprises when the name matches: GitHub shows a banner telling you that you've found the special repository, and the "Add a README file" checkbox pre-populates the README with a starter template. You'll see both live in Demo 1 - and then replace the template with three sessions of your own work.

Self-studyHow a profile README can vanish2 min read▶

The four requirements also read as a troubleshooting list. GitHub hides or removes your profile README when:

  • The file is empty - content deleted, even accidentally, and the section disappears.
  • The repo goes private - flip the visibility and the profile goes blank until you flip it back.
  • The names stop matching - rename your account or the repo without renaming the other, and the magic breaks silently.

Legacy quirk: if a matching repo was created before July 2020 (before this feature launched), it won't show automatically - there's a manual "Share to profile" step in the repo settings. You won't hit this with a fresh repo; you might when helping a colleague with an old account.

Part 3 · covers Markdown Guide getting-started: flavors + tools

Where markdown takes you next 3 min live

Today closes the course, not your markdown career. A quick honest map of the territory: what transfers everywhere, and where you'll use it next week without noticing.

LiveThe flavors reality: what you learned travels1.5 min▶

Every app implements markdown slightly differently - the variants are called flavors. The honest picture:

  • CommonMark core (Session 1's elements) works everywhere, full stop.
  • GFM (tables, checklists, emoji, Mermaid - Sessions 2-3) works on GitHub and most modern tools.
  • Every app has quirks at the edges - when something fancy fails, suspect the flavor before you suspect yourself.

Rule of thumb: what you learned in this course maps roughly 95% everywhere. The remaining 5% is a quick check of the app's docs, and the deep-dive flavor map (DD2) if you want the whole landscape.

LiveYour new superpowers map1.5 min▶
  • Notes: Obsidian and Notion are markdown underneath - your notes just became portable and future-proof.
  • Docs at work: team wikis, project READMEs, internal docs - most of it is markdown, and you now write it natively.
  • AI chats: your prompts and the AI's answers ARE markdown. Structure a prompt with headings and lists and the model follows your structure; read an answer's raw markdown and you see exactly how it organized its thinking. The deep dive on this is DD1: Markdown for AI work.
Real world

A project manager from an earlier cohort started writing status updates as markdown checklists in the team Slack. Same content as before - but scannable. Within a month the whole team had copied the format, and her "how do you make those" answer was this course. Markdown spreads because reading it sells it.

Self-studyEditors, publishing paths, and GitHub's social syntax3 min read▶
  • Editors tour: StackEdit and Dillinger you know (browser, free). Next steps: iA Writer for beautiful focused writing, VS Code with its built-in markdown preview if you drift toward code.
  • Publishing paths (teaser): markdown files can become entire websites - GitHub Pages hosts them free, Jekyll and MkDocs turn folders of .md into blogs and documentation sites. That's the DD2 rabbit hole.
  • GitHub's social syntax: in issues and discussions, @username notifies a person and #123 auto-links to issue number 123. Not needed for your profile page - very needed the first time you collaborate.
Part 4 · the lab, previewed

The shipping pipeline 1 min live

Four stops between your draft and the internet. This is the whole lab - look how short the distance is.

1 · Your draft open in StackEdit 2 · New repo username/username 3 · Paste + commit preview first, then save 4 · LIVE 🎉 your public profile page Demo 1 covers stop 2, Demo 2 covers stops 3-4, Demo 3 is the victory lap around stop 4. Total distance from draft to live: about two minutes once you know the way. Everything else today is savoring it.
🔍 Click to zoom - the shipping pipeline: draft, repo, commit, live
Demo 1 of 3

Create the magic repo ★ 8 min · everyone creates

Sign in at github.com and note your exact username - it's in the top-right avatar menu and in your profile URL. You're about to type it as a repo name, and requirement 1 says exactly.

Click the + in the top bar → New repository. In "Repository name", type your username. Watch for the banner: GitHub tells you that you've found the special repository. That's the confirmation the magic is on.

Make sure Public is selected (requirement 2) and check "Add a README file" (requirements 3 and 4 in one checkbox - the file exists, in the root, with starter content).

Click Create repository. You land in your new repo with a pre-populated README already rendering. Now open your profile page in a new tab - github.com/yourusername - and there it is, the template, live on your profile. All four requirements: met.

Nothing showed up? Run the four-requirement checklist in order: name matches exactly? public? README.md in the root? file has content? One of those four is your answer - every time.
Demo 2 of 3

The ship ★ 12 min · this is the moment

In your new repo, click README.md, then the pencil ✏️ to edit. Select all the template content and delete it - it did its job; your page is better.

Switch to your StackEdit tab, select your whole about-me page, copy. Back in GitHub: paste. Three sessions of work, one paste.

Click the Preview tab. This is the Session 3 trust-the-syntax payoff: the badges and the Mermaid diagram that stayed raw in StackEdit render right here. Scroll the whole page. Check the photo, the table, the collapsible section.

Anything off? Flip back to the editing tab, fix it, preview again. This edit-preview loop is exactly your split-pane editor with one extra click.

Happy? Click Commit changes, write the message my page, v1, and commit. Now open your profile tab and refresh. IT'S LIVE.

📱 Phone-out moment: take out your phone, open github.com/yourusername in the browser, and show your neighbor. That page renders on every device on Earth right now, and you wrote it in plain text.

Why preview before committing? Commits are safe (History keeps everything), but your profile is public the second you commit - the Preview tab lets you catch the broken image or fence typo while it's still private. Preview, then commit: make it a reflex.
Demo 3 of 3

The victory lap ★ 5 min · feel how cheap edits are

One more edit, right now: pencil, add a line at the bottom of your page - *built in learn-markdown-with-phoebe* or today's date - and commit with the message v1.1. Refresh your profile. Total time: under a minute. That's how cheap edits are now. Your page is never finished, only current.

Browse time: open the profiles of two classmates (swap usernames with your neighbors). See what they did differently - a badge you didn't think of, a better table, a funnier bio.

Leave verbal compliments - one thing you genuinely liked on each page, said out loud. You've all just shipped something public. That deserves noise.

After the session

This week and beyond ◐ ongoing

Check yourself

Three questions before you celebrate 🎯 ◐ 90 seconds

1 · Your repo is named exactly your username, it's public, and README.md sits in the root - but your profile shows nothing. Which requirement did you miss?

Four requirements, all required: exact name match, public, README.md in the root, and any content in it. No stars, no settings toggle - if three hold and nothing shows, the file is empty.

2 · You set the username/username repo to private "just while I polish it". What happens to your profile?

Public is requirement 2, and it's binary: private repo, blank profile - silently, with no notice shown. Polish in the Preview tab instead; it's private until you commit.

3 · You've pasted your page into the GitHub editor. Where do you verify the rendering - Mermaid, badges, all of it - BEFORE it goes public?

The Preview tab renders full GFM - Mermaid and badges included - while your changes are still private. Preview, fix, then commit: the pro loop.

Source material

Official sources covered

This session teaches the working content of GitHub's official docs on managing your profile README plus the tools-and-flavors half of Markdown Guide's getting started.

✓GitHub Docs: managing your profile READMEall 4 requirements, creation flow, hiding rules - Part 2 + Demos 1-2
✓GitHub web-editor basicspencil edit, Preview tab, commit with message - Part 1 + Demo 2
✓Markdown Guide: getting started (flavors + tools)CommonMark vs GFM reality, where markdown lives next - Part 3
◐GitHub Pages / Jekyll / MkDocsteaser only - full publishing-paths story in deep-dive DD2
◐git command linehonestly: not taught, by design - the web UI does everything this course needs
◐Mentions @user + issue refs #123noted in Part 3 self-study - collaboration territory, beyond the profile page

Session 4 cheat sheet · pin this

The 4 requirementsRepo name = username exactly · public · README.md in root · has any content. All four or nothing shows.
Create the repoNew repository → name = your username → Public → check "Add a README file" → Create.
The publish loopPencil ✏️ to edit → Preview tab to check → Commit with a short message. Live on refresh.
Flavors rule of thumbSession 1 basics work everywhere; GFM extras work on GitHub + most modern tools; check the app for the rest.
Where markdown livesGitHub, Notion, Obsidian, Slack, Reddit, wikis, docs tools, and every AI chat - one syntax, learned once.
Tweak-streak habitOne tiny commit a week for 30 days. Edits are cheap, History keeps everything, your page stays alive.