A super-simple, step-by-step website that teaches a total newcomer how to use Postman — with a left sidebar table of contents, Prev/Next buttons, Mermaid diagrams, and a hover-to-define Jargon Decoder.
No build step. No frameworks. Just static files — perfect for GitHub Pages.
- Working shell: sidebar navigation, Prev/Next, search, dark/light mode, glossary.
- Full content: Part 0 (APIs & HTTP), Part 1 (Setup), Part 2 (Your First Request).
- Stubs for Parts 3–10 + Appendix so you can see the full shape (marked "soon").
index.html # the page shell
assets/styles.css # all styling (light + dark)
assets/content.js # every lesson page + the sidebar order ← edit content here
assets/glossary.js # the jargon definitions ← edit terms here
assets/app.js # navigation, diagrams, tooltips, search
.nojekyll # tells GitHub Pages to serve files as-is
Just open index.html in a browser — everything works from the file system
(no server needed).
- Create a repo and push these files (keep
index.htmlat the repo root). - On GitHub: Settings → Pages.
- Under Build and deployment → Source, pick Deploy from a branch.
- Choose branch main and folder /(root), then Save.
- Wait ~1 minute — your site is live at
https://<your-username>.github.io/<repo-name>/.
Open assets/content.js. Each page is an object:
{ id: "my-page", num: "3.2", title: "My topic", html: `...` }- Add it to the right part's
pagesarray — the sidebar and Prev/Next update automatically. - Wrap a jargon word:
<span class="jargon" data-term="api">API</span>(thedata-termmust match a key inglossary.js). - Add a diagram:
<div class="mermaid">flowchart LR; A --> B</div>
The asset links in index.html end with ?v=6 (e.g. content.js?v=6). This
forces browsers to fetch your new files instead of an old cached copy. Each time
you change a file in assets/, increase that number (?v=6 → ?v=7) on all four
links so returning visitors always get the latest version.