Codetour

Code Tour 是一个 VS Code 扩展，支持创建交互式的、分步引导的代码库导览。它作为一种引导式代码文档工具，将描述性解释直接映射到编辑器中的特定文件行和目录，以辅助代码库入职和技术知识传递。

该系统通过使用基于正则表达式的锚定技术来保持步骤在不同源代码版本间的稳定性，并能够将导览导出为便携式文件，其中包含播放所需的代码上下文，无需原始本地仓库。它还支持通过基于 Git 的导览版本控制进行同步，并提供漂移检测功能，以识别代码更改何时破坏了现有的导览链接。

该项目涵盖了广泛的功能，包括导览录制和设计、带有侧边栏发现功能的播放引擎，以及嵌入 shell 命令和编辑器函数调用等交互元素的能力。导览使用 JSON 序列化存储，可以通过远程链接共享，或通过灵活的磁盘存储策略进行管理。

Features

Architectural Onboarding - Provides an interactive tool for architectural onboarding to help developers understand project structural organization and flow.
Code Walkthroughs - Provides an interactive system for mapping descriptions to specific file lines and directories within the editor.
Synchronized Code Annotations - Implements a format for embedding sequential explanations and markers directly into a codebase for synchronized playback.
Interactive Code Documentation - Integrates interactive tours and narrated code paths directly into the editor to replace static documentation.
Portable Tour Bundles - Packages tour steps with source code content to enable playback without the original local repository.
Technical Knowledge Transfer - Allows recording a sequence of code highlights and explanations to share implementation details with a team.
VS Code Extensions - Implemented as a VS Code extension to provide recording and playback of guided codebase walkthroughs.
Gutter Metadata Markers - Renders visual markers in the editor margin to link live code lines back to their corresponding tour steps.
Software Architecture Education - Facilitates software architecture education by leading users through sequenced series of files and directories.
Code-Stability Anchors - Matches code locations using regular expressions to maintain tour step stability across source versions.
Standalone Tour Exports - Saves tours as standalone files or gists containing all necessary code context for offline playback.
Tour Recording - Includes a feature to capture a sequence of file locations and descriptions to create interactive walkthroughs.
Code-to-Step Linkage - Links tour steps to line numbers and regex patterns to maintain stability during code changes.
User Onboarding Tours - Ships a playback engine that navigates users through a predefined series of files and code selections.
Deep-Link Tour Launchers - Enables opening specific tours and jumping to particular steps using custom URI handlers.
Remote Tour Publishing - Enables publishing tours to external locations via web links for remote launching.
Tour Serialization Formats - Stores tour steps and metadata in portable JSON files for version control and sharing.
Tour-Driven Command Triggers - Triggers editor functions or extension commands directly from tour step descriptions via custom URIs.
Contributor Navigation Guides - Offers portable and versioned tours to help external contributors navigate large repositories quickly.
Tour Anchor - Integrates with CI pipelines to identify when code changes have broken the links or context of existing tours.
Tour-Code Version Synchronization - Associates tours with specific branches, commits, or tags to synchronize walkthroughs with code versions.
Editor Gutter Components - Uses editor gutter components to display icons indicating lines that belong to a tour.
Programmatic Tour Controllers - Provides a programmatic interface for external tools to record, play, and export guided tours.
Context-Free Instructional Steps - Supports introductory or intermediate explanation steps that operate independently of any specific file.
Explorer-Based Step Focus - Focuses tour steps on specific folders in the file explorer to provide architectural context.
Interactive Tour Elements - Adds links, shell command triggers, and editor command execution to tour steps.
Tour Invocation URIs - Handles custom protocol links to launch specific walkthroughs and jump to precise steps.
Step-Based Navigation Managers - Provides a dedicated UI and shortcuts for coordinating progression through sequential walkthrough steps.
Tour Lifecycle Events - Exposes programmatic hooks for external extensions to trigger tour lifecycles and subscribe to playback events.
Curriculum Sequencing - Provides the ability to connect different tours to create a sequenced onboarding curriculum.

Star 历史

microsoftcodetour

Name: microsoft/codetour
Author: microsoft

View on GitHub

4,541 星标149 分支TypeScriptMIT5 次浏览aka.ms/codetour

Codetour

Features

Architectural Onboarding - Provides an interactive tool for architectural onboarding to help developers understand project structural organization and flow.
Code Walkthroughs - Provides an interactive system for mapping descriptions to specific file lines and directories within the editor.
Synchronized Code Annotations - Implements a format for embedding sequential explanations and markers directly into a codebase for synchronized playback.
Interactive Code Documentation - Integrates interactive tours and narrated code paths directly into the editor to replace static documentation.
Portable Tour Bundles - Packages tour steps with source code content to enable playback without the original local repository.
Technical Knowledge Transfer - Allows recording a sequence of code highlights and explanations to share implementation details with a team.
VS Code Extensions - Implemented as a VS Code extension to provide recording and playback of guided codebase walkthroughs.
Gutter Metadata Markers - Renders visual markers in the editor margin to link live code lines back to their corresponding tour steps.
Software Architecture Education - Facilitates software architecture education by leading users through sequenced series of files and directories.
Code-Stability Anchors - Matches code locations using regular expressions to maintain tour step stability across source versions.
Standalone Tour Exports - Saves tours as standalone files or gists containing all necessary code context for offline playback.
Tour Recording - Includes a feature to capture a sequence of file locations and descriptions to create interactive walkthroughs.
Code-to-Step Linkage - Links tour steps to line numbers and regex patterns to maintain stability during code changes.
User Onboarding Tours - Ships a playback engine that navigates users through a predefined series of files and code selections.
Deep-Link Tour Launchers - Enables opening specific tours and jumping to particular steps using custom URI handlers.
Remote Tour Publishing - Enables publishing tours to external locations via web links for remote launching.
Tour Serialization Formats - Stores tour steps and metadata in portable JSON files for version control and sharing.
Tour-Driven Command Triggers - Triggers editor functions or extension commands directly from tour step descriptions via custom URIs.
Contributor Navigation Guides - Offers portable and versioned tours to help external contributors navigate large repositories quickly.
Tour Anchor - Integrates with CI pipelines to identify when code changes have broken the links or context of existing tours.
Tour-Code Version Synchronization - Associates tours with specific branches, commits, or tags to synchronize walkthroughs with code versions.
Editor Gutter Components - Uses editor gutter components to display icons indicating lines that belong to a tour.
Programmatic Tour Controllers - Provides a programmatic interface for external tools to record, play, and export guided tours.
Context-Free Instructional Steps - Supports introductory or intermediate explanation steps that operate independently of any specific file.
Explorer-Based Step Focus - Focuses tour steps on specific folders in the file explorer to provide architectural context.
Interactive Tour Elements - Adds links, shell command triggers, and editor command execution to tour steps.
Tour Invocation URIs - Handles custom protocol links to launch specific walkthroughs and jump to precise steps.
Step-Based Navigation Managers - Provides a dedicated UI and shortcuts for coordinating progression through sequential walkthrough steps.
Tour Lifecycle Events - Exposes programmatic hooks for external extensions to trigger tour lifecycles and subscribe to playback events.
Curriculum Sequencing - Provides the ability to connect different tours to create a sequenced onboarding curriculum.

Codetour 的开源替代方案

相似的开源项目，按与 Codetour 的功能重合度排序。

sorich87/bootstrap-tour
sorich87/bootstrap-tour
4,411在 GitHub 上查看
bootstrap-tour is a product tour library designed to create guided walkthroughs for websites using the Bootstrap framework. It functions as an interactive UI tool that uses a sequence of popover hints to highlight specific page elements and lead users through a workflow. The system coordinates guided experiences across multiple pages by mapping tour steps to unique URLs. It maintains user progress through local storage persistence, ensuring tours resume at the correct step after a page refresh. The library includes programmatic controls to start, pause, resume, or skip steps, and supports au
CoffeeScript
在 GitHub 上查看4,411
jamiebuilds/spectacle-code-slide
jamiebuilds/spectacle-code-slide
4,137在 GitHub 上查看
This project is a React presentation component designed to create animated code sliders and step-by-step walkthroughs. It functions as a code presentation tool that allows users to highlight syntax and transition between different versions of a codebase during technical demonstrations. The tool enables the creation of animated code walkthroughs by rendering snapshots of code that transition through incremental changes. These sequences are navigated via keyboard inputs, allowing a presenter to advance through code steps to explain logic changes in a live demo. The system provides capabilities
JavaScript
在 GitHub 上查看4,137
ajaxorg/ace
ajaxorg/ace
27,133在 GitHub 上查看
Ace is a high-performance, browser-based code editor and JavaScript text editor component designed to be embedded into web applications. It functions as a feature-rich alternative to standard text areas, providing a syntax highlighting engine and support for multiple programming and markup languages. The editor is distinguished by its ability to handle large documents containing millions of lines while maintaining stable performance. It supports multi-cursor editing, allowing simultaneous modifications at multiple selection points across a document. The project covers a broad range of develo
JavaScript
在 GitHub 上查看27,133
codemirror/dev
codemirror/dev
7,820在 GitHub 上查看
CodeMirror is a browser-based code editor framework and modular extension system used to embed full-featured text editors into web pages. It functions as a syntax tree parsing engine and a language server protocol client, enabling structural language analysis and deep integration with external programming language services. The project is distinguished by its modular architecture, which uses a system of extensions and compartments for dynamic reconfiguration at runtime. It supports real-time collaborative editing and state synchronization through an operational transformation framework, allow
JavaScript
在 GitHub 上查看7,820

查看 Codetour 的所有 30 个替代方案

常见问题解答

microsoft/codetour 是做什么的？

microsoft/codetour 的主要功能有哪些？

microsoft/codetour 的主要功能包括：Architectural Onboarding, Code Walkthroughs, Synchronized Code Annotations, Interactive Code Documentation, Portable Tour Bundles, Technical Knowledge Transfer, VS Code Extensions, Gutter Metadata Markers。

microsoft/codetour 有哪些开源替代品？

microsoft/codetour 的开源替代品包括： jamiebuilds/spectacle-code-slide — This project is a React presentation component designed to create animated code sliders and step-by-step walkthroughs.… sorich87/bootstrap-tour — bootstrap-tour is a product tour library designed to create guided walkthroughs for websites using the Bootstrap… ajaxorg/ace — Ace is a high-performance, browser-based code editor and JavaScript text editor component designed to be embedded into… codemirror/dev — CodeMirror is a browser-based code editor framework and modular extension system used to embed full-featured text… amlcurran/showcaseview — ShowcaseView is an iOS UI overlay library and user onboarding framework. It provides a customizable feature highlight… code-hike/codehike — Codehike is a React-based documentation framework and interactive code walkthrough tool. It functions as a markdown…