GitHub Wiki — Markdown Reference Guide - Yash-777/LearnJava GitHub Wiki

📘 GitHub Wiki — Markdown Reference Guide

A complete reference for GitHub-flavored Markdown: emojis, tables, alerts, collapsibles, code blocks, keyboard keys, and branch naming conventions. ---

🔣 Emojis & Icon Reference

Icon Meaning Icon Meaning
Correct / Yes Wrong / Problem
💡 Idea / Explanation 🔍 Search
📌 Pin / Important 🛑 Warning / Stop
⚠️ Caution 🔁 Repeat / Loop
🚨 Note / Alert 🚫 Not used / Blocked
Why? / Question Add / Extra
📚 Summary / Docs 🧠 Explanation
📊 Chart / Stats 📅 Date / Schedule
🧪 Sample / Test 🧮 Quick Comparison
📐 Estimated 🧰 Optional / Tools
🔑 Key / Auth 🔐 Secure endpoint
🔓 Public endpoint 📦 Package
⚙️ Settings 🛠️ Fix / Refactor
🐬 MySQL-only field 🧑‍💻 Developer / Code
📋 .java file 🧾 Full JavaDoc
🏷️ Branch naming 🪪 Jira Ticket Type

🏷️ Branch Naming Convention — Jira-Based

Maps Jira ticket types → Git branch prefixes. Format: prefix/JIRA-123-short-description

🪪 Jira Ticket Type 🔧 Git Branch Prefix 📋 Example Branch 📝 Notes
🐛 Bug fix/ fix/PROJ-101-login-error Fixing a reported defect
✨ Story / Feature feature/ feature/PROJ-202-user-dashboard New feature or user story
🚑 Hotfix hotfix/ hotfix/PROJ-303-prod-crash Urgent production fix
🔧 Task / Chore chore/ chore/PROJ-404-upgrade-deps Maintenance, dependency updates
♻️ Refactor refactor/ refactor/PROJ-505-service-layer Code restructuring, no behavior change
📖 Documentation docs/ docs/PROJ-606-api-readme Wiki, README, inline docs
🧪 Test test/ test/PROJ-707-payment-unit Adding or updating test coverage

➤ Special Characters & Arrows

Symbol Description
Bold right arrow — section pointer
Check mark — quick yes/done
Right arrow — flow / next step
Curved arrow — redirect / alias
① ② ③ Circled numbers — ordered visual steps
macOS Command / Option keys
Up arrow / Enter key

🧰 Optional Annotations Reference

These are shorthand markers used inline throughout documentation to signal meaning at a glance.

Marker Meaning
🔐 Author/Secure — authenticated endpoint
🔓 Publicly accessible endpoint
🐬 MySQL-only field
🛠 Refactored
🛠️ Fix applied
📋 .java Reference to a .java source file
🧾 Full JavaDoc available
⚙️ Configuration / settings

Images [💪 🧬 🔢 🔚 🧑‍💻 🚦 ➤ ✔ → ➩ ⌘ ⌥ ↑ ↵ ① ② ③ ]

  • ✅ Correct/Yes, 💡 Idea/Explanation, 🔍 search, 📌 Pin, , 🛑 Warning, ⚠️ warn, 🔁 , 🚨 Note, 🚫 Not used
  • ❓ Why, ✔, ❌ Wrong/Problem, ➕
  • 📚 Summary, 📘 , 🧠 Explanation, 📊 , 📅
  • 🧪 Sample
  • 🧮 Quick Comparison, 📐 Estimated, 🧰 Optional
  • 🔑 Key, 🔐 Author/Secure Authenticated endpoints, 🔓 Publicly accessible endpoints
  • 📦 📁 Package, 🧾🧾 Full JavaDoc, ⚙️ Setting / 📋 `.java file`, 🛠️ Fix, 🛠 Refactored
  • 🏷️ Branch Naming Convention Based on Jira Tickets :: 🪪 Jira Ticket Types → 🔧 Git Branch Prefix
  • 🐬 MySQL-only field, Spring frame work(bean container injection)

🗂️ Tables Use HTML <table> with <pre lang="java"> for side-by-side code comparisons.

Single line code

Code Information
String s = "Yash"; String literal
keyboard key block style <kbd>Ctrl</kbd> Press Ctrl + S to save

Tab Shift Alt

Space Delete

💡 A blank/empty line that contains only whitespace (such as tabs or spaces) inside a <pre> block can cause formatting or rendering issues, like:

  • Collapsed formatting
  • Misaligned indentation
  • Extra spacing or unexpected behavior in GitHub Wiki
<table>
  <tr>
    <th>Interface 1 <code>default print():void</code></th>
    <th>Interface 2 <code>default print():void</code></th>
  </tr>
<tr>
<td><pre lang="java">
interface I1 {
    static void i1() {
        System.out.println("I1 static function");
    }
    default void print() {
        System.out.println("I1 print");
    }
}
</pre></td>
<td><pre lang="java">
interface I2 {
    static void i2() {
        System.out.println("I2 static function");
    }
    default void print() {
        System.out.println("I2 print");
    }
}
</pre></td>
</tr>
<tr>
<td colspan="2"><pre lang="java">
public class MultipleInheritance implements I1, I2 {
    public static void main(String[] args) {
        System.out.println("Main Thread start...");
        (new MultipleInheritance()).print();
    }
    @Override
    public void print() {
        I1.super.print(); // Calling print of I1 interface
    }
}
</pre></td>
</tr>
</table>

📂 Collapsible Sections — <details> & <summary>

Use <details> and <summary> to hide/show content.

Important

Always leave an empty line after the closing </summary> tag, otherwise markdown/code blocks won't render correctly.

Code Sample Preview
Collapsed by default — click to expand ✅ Hidden until user clicks
<details>
  <summary>Show greet() method</summary>

<pre lang="java">
public String greet(String name) {
    return "Hello, " + name + "!";
}
</pre>

</details>
Show greet() method
public String greet(String name) {
    return "Hello, " + name + "!";
}
Open by default — click to collapse ✅ Visible until user closes
<details open>
  <summary>Hide greet() method</summary>

<pre lang="java">
public String greet(String name) {
    return "Hello, " + name + "!";
}
</pre>

</details>
Hide greet() method
public String greet(String name) {
    return "Hello, " + name + "!";
}
Preview snippet inside <summary> — full content revealed on expand ✅ Shows a hint, expands to full detail
<details>
  <summary>Show greet() method
&nbsp;<pre lang="java">
public String greet(String name) {
    return "Hello, " + name + "!";
}
</pre>
  </summary>

<pre lang="java">
// Full implementation with validation
public String greet(String name) {
    if (name == null || name.isEmpty()) {
        return "Hello, Stranger!";
    }
    return "Hello, " + name + "!";
}
</pre>

</details>
Show greet() method  
public String greet(String name) {
    return "Hello, " + name + "!";
}
// Full implementation with validation
public String greet(String name) {
    if (name == null || name.isEmpty()) {
        return "Hello, Stranger!";
    }
    return "Hello, " + name + "!";
}

Header 1 Header 2
Stream Stream in Detail oracle article
List transactionsIds = 
    transactions.stream()
                .filter(t -> t.getType() == Transaction.GROCERY)
                .sorted(comparing(Transaction::getValue).reversed())
                .map(Transaction::getId)
                .collect(toList());
image

Task lists

- [x] #739
- [ ] Add delight to the experience when all tasks are complete 🎉
  • #739
  • Add delight to the experience when all tasks are complete 🎉

Using emojis

@octocat :+1: This PR looks great - it's ready to merge! :shipit:

@octocat 👍 This PR looks great - it's ready to merge! :shipit:


Use > [!TYPE] syntax to render colored alert callouts. Only supported in GitHub-flavored Markdown.

Header 1 Header 2
> [!NOTE]
> Useful information that users should know, even when skimming content.

Note

Useful information that users should know, even when skimming content.

> [!TIP]
> Helpful advice for doing things better or more easily.

Tip

Helpful advice for doing things better or more easily.

> [!IMPORTANT]
> Key information users need to know to achieve their goal.

Important

Key information users need to know to achieve their goal.

> [!WARNING]
> Urgent info that needs immediate user attention to avoid problems.

Warning

Urgent info that needs immediate user attention to avoid problems.

> [!CAUTION]
> Advises about risks or negative outcomes of certain actions.

Caution

Advises about risks or negative outcomes of certain actions.


⚠️ **GitHub.com Fallback** ⚠️