How to Add Notes

This site renders Markdown files served from this repository. The only two files you ever need to touch are notes.json and a new .md file.

Workflow

1. Create a Markdown file anywhere in the repo — e.g. notes/telecom/5g-overview.md
2. Add one entry to notes.json:

{
  "title": "5G Overview",
  "file": "notes/telecom/5g-overview.md",
  "category": "Telecom"
}

1. Commit and push. GitHub Pages serves the update in ~1 minute.

That’s it — notes_reader.html never needs to change.

notes.json structure

[
  { "title": "Note Title",  "file": "notes/path/to/file.md", "category": "Category" },
  { "title": "HTML Page",   "file": "some-page.html",        "category": "Category", "type": "page" }
]

Notes with the same category are grouped together in the sidebar. Order within the file controls sidebar order.

Adding "type": "page" makes the entry open as a link in a new tab instead of rendering as markdown — useful for standalone HTML pages.

Supported Markdown

Standard GFM (GitHub Flavored Markdown) is fully supported.

Code blocks with syntax highlighting

def greet(name: str) -> str:
    return f"Hello, {name}!"

git add notes/my-new-note.md notes.json
git commit -m "add note: my topic"
git push

Tables

Task lists

• Set up the notes site
• Write first real note
• Organize by category

Blockquotes

Key insight or quote goes here.