Framework and tools for providing interactive tutorials with active links that call VS Code commands
The Didact framework is designed to instruct users in a useful way regarding how to complete tasks through a combination of text (Markdown- or AsciiDoc-formatted), images, and active links that show VS Code functionality in action. Those links are paired with VS Code’s simple command framework to interact with the IDE directly -- and that provides one-click access to nearly all the functionality VS Code and its extensions have to offer.
Didact Tutorials
view in the Explorer activity sidebar.HelloWorld with JavaScript in Three Steps
.Start Didact tutorial
from the right-click menu..didact.md
or .didact.adoc
.[Open a new terminal]()
, put the cursor between the parentheses ()
and press Ctrl+Space
.link:[Open a new terminal]
, put the cursor after link:
, and press Ctrl+Space
.Start new Didact command link
.workbench.action.terminal.new
) and press Enter
.Ctrl/Cmd+Alt+D
to view your new Didact tutorial and click the link you created! Done!Our documentation started in these wiki pages but are now located in GitHub pages here. Included are details about all of Didact's capabilities and many examples to get you started.
Note: The wiki pages are deprecated and will be removed in a future release. Please use the GitHub pages from release 0.4.0 forward.
For a list of available commands, check out the Command Reference.
If you run into issues migrating from an earlier version of Didact (0.3.x or earlier) to 0.4.x, you may need to refresh the tutorial registry. See Troubleshooting in the docs for details.
Check out the project on Github!
The readme has a ton of information about some of the specifics for link formatting, project json format, etc.
And feel free to add issues, submit feature requests, log bugs, etc!
The Didact extension for Visual Studio Code collects anonymous usage data and sends it to Red Hat servers to help improve our products and services. Read our privacy statement to learn more. This extension respects the redhat.telemetry.enabled
setting which you can learn more about at https://github.com/redhat-developer/vscode-redhat-telemetry#how-to-disable-telemetry-reporting