Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,6 @@
"typescript.tsc.autoDetect": "off",
"editor.formatOnSave": true,
"editor.codeActionsOnSave": {
"source.organizeImports": true
"source.organizeImports": "explicit"
}
}
14 changes: 10 additions & 4 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,14 @@
## Upcoming
## v0.0.61 (08/06/25)

- Automatically updating a tour file as the associated code changes
- Automatically set the "pattern" record mode when you create a new tour, and select `None` for the git ref
- Added support for opening a `*.tour` file in the VS Code notebook editor (Insiders only)
- Introduced a codelens that allows starting a tour from an associated line of code
- Fixed the display name that's used when dragging the `CodeTour` view into another panel

## v0.0.60 (08/06/25)

- Step descriptions can now include basic HTML (e.g. `<strong>`, `<details>`)
- Step descriptions can now reference environment variables via the `{{var}}` syntax
- The comment threads no longer display the `Start discussion` message at the top
- Fixed a bug where the toast notification wasn't properly showing for new workspaces that include tours

## v0.0.59 (03/24/2023)

Expand Down
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ For example, if you want to define a tour that is only displayed for Linux users

### CodeTour-Flavored Markdown

When you describe a step, you're able to use the full-breadth of markdown capabilities in order to write rich/compelling content (e.g. images, links, headings, code fences). However, CodeTour also provides some additional syntactic features that allow you to include additional interactivity to your tours:
When you describe a step, you're able to use the full-breadth of markdown capabilities and basic HTML (e.g. `<details>`) in order to write rich/compelling content (e.g. images, links, headings, code fences). However, CodeTour also provides some additional syntactic features that allow you to include additional interactivity to your tours:

#### File References

Expand Down Expand Up @@ -171,6 +171,10 @@ In order to make it simpler to call common commands, CodeTour will prompt you wi

- `Start tour...` - Allows you to specify the title or another tour in the workspace, that when clicked, will automatically start that tour.

#### Environment Variables

You can reference environment variables in your step descriptions using the `{{VARIABLE_NAME}}` syntax. When the tour is played, these placeholders will be replaced with the actual environment variable values from the user's system. For example, `{{HOME}}` will be replaced with the user's home directory path. This is useful for creating tours that adapt to different environments.

### Versioning Tours

When you record a tour, you'll be asked which git "ref" to associate it with. This allows you to define how resilient you want the tour to be, as changes are made to the respective codebase.
Expand All @@ -184,7 +188,7 @@ You can choose to associate with the tour with the following ref types:
- `Current Commit` - The tour is restricted to the current commit, and therefore, will never get out of sync. If the end-user's `HEAD` points at the specified commit, then the tour will enable them to make edits to files as its taken. Otherwise, the tour will replay with read-only files.
- Tags - The tour is restricted to the selected tag, and therefore, will never get out of sync. The repo's entire list of tags will be displayed, which allows you to easily select one.

At any time, you can edit the tour's ref by right-clicking it in the `CodeTour` tree and selecting `Change Git Ref`. This let's you "rebase" a tour to a tag/commit as you change/update your code and/or codebase.
At any time, you can edit the tour's ref by right-clicking it in the `CodeTour` tree and selecting `Change Git Ref`. This let's you re-target a tour to a tag/commit as you change/update your code and/or codebase.

### Content Steps

Expand Down
Loading