MyCodeTour: Interactive Code Walkthroughs for IntelliJ

🚀 The Smart Code Navigation Plugin for IntelliJ Platform
A fork of CodeTour supercharged with intuitive workflows. Transform codebases into explorable knowledge maps – accelerate onboarding and streamline knowledge sharing.

---

🌟 Core Features

One-Click Tour Creation

▸ Gutter Markers: Right-click editor gutter > Add Tour Step (as simple as setting breakpoints)
▸ Rich Content Support: Markdown/HTML formatting with embedded diagrams and code snippets
▸ Customizable Popups: Adjustable note windows (position/size/fonts) for optimal readability ▸ Wiki-Style Step Linking: Copy step references from context menu for easy cross-referencing

Visual Navigation System

▸ Tour Dashboard: Access via View > Tool Windows > Tours Navigation
▸ Precision Jump: Auto-navigate to code lines with single click on tour steps

▸ Smart Search:

• Full-text search across all tour steps
• Filter by file, tag, or content type
• Fuzzy matching for quick navigation

▸ Rich Diagram Support:

• Mermaid: Create flowcharts, sequence diagrams, and more
• PlantUML: Design UML diagrams and system architecture
• Excalidraw: Draw hand-drawn style diagrams and sketches (with intuitive relative path resolution)

Team Knowledge Hub

▸ Version-Control Ready: Store tours alongside code for collaborative maintenance

Interactive Code Walkthroughs for IntelliJ

Create guided code tours directly in your IDE. Anchor step-by-step explanations to specific code lines with Markdown/HTML annotations.

Key Features:

• Add steps via editor gutter (right-click > Add Tour Step)
• Version-controlled .tour files for team collaboration
• Jump between steps via the Tours Navigation tool window

Use Cases:

• Onboarding guides
• Code reviews
• Bug documentation
• Architecture walkthroughs

Transform code into a narrated journey, keeping knowledge anchored to the codebase.

---

🛠️ Use Cases

👨💻 Enhanced Code Reviews

Annotate PR changes with contextual explanations
Example: Add step-by-step rationale for complex refactors

📚 Living Documentation

Anchor system diagrams and API docs directly to code
Example: Embed flowchart in core algorithm module

🐞 Visual Bug Tracking

Create reproducible bug investigation paths
Example: Document race condition reproduction steps

🎯 Accelerated Onboarding

Build self-guided learning paths for new hires
Example: Tour covering setup, architecture, and key workflows

---

🛠️ Installation

Marketplace Install (Recommended)

File > Settings > Plugins > Marketplace
Search "MyCodeTour" > Click Install

Manual Install

1. Download latest release
2. File > Settings > Plugins > ⚙️ > Install Plugin from Disk...

UI

Main UI

Editor

---

📌 Best Practices

Tour Structure Example

# Order Module Walkthrough
## Core Flow
1. Order Entry → [[OrderController.create()]]
2. Pricing Strategy → [[PriceCalculator.applyDiscounts()]]
3. Payment State Machine → [[PaymentStateMachine.handle()]]


## Resources
- [Architecture Decision Record]()
- [Domain Model Diagram]()

Annotated Code Example

**Payment Callback Handling**  
```mermaid
graph TD
A[Gateway Notification] --> B{Signature Valid?}
B -->|Yes| C[Update Order Status]
B -->|No| D[Log Security Alert]
```
> 🔐 Transaction boundary management in [[PaymentService#processCallback]]

Architecture Overview

```mermaid
graph TD;
    A-->B;
    A-->C;
    B-->D;
    C-->D;
```

System Components

@startuml
package "Order Domain" {
    [Order] as o
    [Payment] as p
    [Inventory] as i
}
o --> p
o --> i
@enduml

Record WhiteBoard

![[whiteboard.excalidraw]]

---

📘 Full Documentation | 🐞 Report Issues
Make code explanations timeless – build a living knowledge base that evolves with your project!