Features

Gitorial Features

Discover the powerful features that make Gitorial the ultimate interactive learning platform for developers.

Interactive Learning

Navigate through tutorials like a Git history, with each step representing a meaningful code change. Move forward and backward through tutorial steps with ease, understanding exactly what changed at each stage.

Guided Code Modification

Follow along with tutorial steps by making the suggested code changes. Each step shows you exactly what needs to be modified to progress through the tutorial.

Progress Persistence

Never lose your place in a tutorial. Gitorial automatically saves your progress across VS Code sessions, so you can continue learning whenever you’re ready.

Rich Content Experience

Markdown Rendering

Each tutorial step includes rich Markdown content with:

Formatted Text: Clear explanations and instructions
Code Blocks: Syntax-highlighted code examples
Images: Visual aids and diagrams
Links: References to additional resources

Embedded Media

Tutorials can include images, videos, and interactive elements directly within the step content, creating engaging learning experiences.

Git Integration

Commit-Based Steps

Each tutorial step is a Git commit, providing:

Atomic Changes: Each step represents one logical code change
Git History: Full Git integration with branching and merging
Version Control: Track changes and experiment safely

Branch Management

Work with tutorial branches just like any Git repository:

Create feature branches for experimentation
Merge changes back to the main tutorial flow
Reset to any previous state

VS Code Integration

Editor Management

Gitorial seamlessly integrates with VS Code:

Automatic File Opening: Relevant files open automatically for each step
Tab Tracking: Maintains context of open files per step
Editor State: Preserves cursor position and view state

Diff Views

Compare your work with tutorial solutions:

Side-by-Side Diffs: See exactly what changed
Inline Comparisons: Quick visual feedback
Solution Viewing: Reference implementations when stuck

Panel Integration

The Gitorial panel provides:

Non-Intrusive UI: Doesn’t interfere with your coding workflow
Contextual Information: Step-specific guidance and tips
Quick Actions: Fast navigation and control

Advanced Features

Pattern Detection

Gitorial automatically detects common learning patterns:

TODO Comments: Highlights areas needing implementation
Unimplemented Code: Identifies placeholder code
Educational Markers: Recognizes tutorial-specific patterns

Solution Comparison

Get detailed feedback on your progress:

Automated Diffing: Compare your code with step solutions
Progress Indicators: Visual feedback on completion status
Hint System: Contextual guidance when needed

Extensible Architecture

Built for the future with:

Plugin System: Support for custom tutorial types
Extension API: Integration with other VS Code extensions
Custom Renderers: Support for different content types

Performance & Reliability

Optimized Performance

Lazy Loading: Content loads only when needed
Memory Management: Efficient resource usage
Background Processing: Non-blocking operations

Robust Error Handling

Graceful Failures: Continues working even with errors
State Recovery: Recovers from interrupted sessions
Conflict Resolution: Handles Git conflicts intelligently

Accessibility

Inclusive Design

Keyboard Navigation: Full keyboard accessibility
Screen Reader Support: Works with assistive technologies
High Contrast: Visible in different lighting conditions

Multi-Language Support

Internationalization: Support for multiple languages
RTL Support: Right-to-left language compatibility
Cultural Adaptation: Content that works globally

Ready to start building? Check out the Development section to learn how to contribute to the Gitorial ecosystem.