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.
- Published tutorials that walk users through easy-to-follow tutorials to accomplish their goals in an interactive manner.
- Developer tools to make writing and publishing such tutorials an easy process.
- Open the
Didact Tutorialsview in the Explorer activity sidebar. - Expand the tree and find
HelloWorld with JavaScript in Three Steps. - Click the triangle at the end of the line or select
Start Didact tutorialfrom the right-click menu. - When the tutorial opens, work through the various steps.
- Create a new Markdown or AsciiDoc file with the extension
.didact.mdor.didact.adoc. - Write some text about the action your user will accomplish.
- Start a new Didact link:
- In Markdown, type
[Open a new terminal](), put the cursor between the parentheses()and pressCtrl+Space. - In AsciiDoc, type
link:[Open a new terminal], put the cursor afterlink:, and pressCtrl+Space.
- Select
Start new Didact command link. - Choose a command from the hundreds VS Code has available (like
workbench.action.terminal.new) and pressEnter. - Press
Ctrl+Alt+Vto view your new Didact tutorial and click the link you created! Done!
Check out the Wiki pages here for details about how to use Didact, write your first tutorial, format links, and much more.
For a list of available commands, check out the Command Reference.
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!