{"id":32123687,"url":"https://github.com/redhat-developer/vscode-didact","last_synced_at":"2025-10-20T21:03:13.642Z","repository":{"id":40419537,"uuid":"216113692","full_name":"redhat-developer/vscode-didact","owner":"redhat-developer","description":"Framework and tools for providing interactive tutorials with active links that call VS Code commands","archived":true,"fork":false,"pushed_at":"2022-05-09T21:03:09.000Z","size":21207,"stargazers_count":79,"open_issues_count":38,"forks_count":24,"subscribers_count":15,"default_branch":"main","last_synced_at":"2025-09-18T13:10:46.671Z","etag":null,"topics":["interactive-tutorials","vscode-didact"],"latest_commit_sha":null,"homepage":"https://marketplace.visualstudio.com/items?itemName=redhat.vscode-didact","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/redhat-developer.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"Contributing.md","funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-10-18T22:07:56.000Z","updated_at":"2025-03-21T21:13:46.000Z","dependencies_parsed_at":"2022-08-09T19:51:06.711Z","dependency_job_id":null,"html_url":"https://github.com/redhat-developer/vscode-didact","commit_stats":null,"previous_names":[],"tags_count":25,"template":false,"template_full_name":null,"purl":"pkg:github/redhat-developer/vscode-didact","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/redhat-developer%2Fvscode-didact","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/redhat-developer%2Fvscode-didact/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/redhat-developer%2Fvscode-didact/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/redhat-developer%2Fvscode-didact/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/redhat-developer","download_url":"https://codeload.github.com/redhat-developer/vscode-didact/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/redhat-developer%2Fvscode-didact/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":280159255,"owners_count":26282555,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-20T02:00:06.978Z","response_time":62,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["interactive-tutorials","vscode-didact"],"created_at":"2025-10-20T21:02:09.259Z","updated_at":"2025-10-20T21:03:13.633Z","avatar_url":"https://github.com/redhat-developer.png","language":"TypeScript","readme":"\u003cp align=\"center\"\u003e\n  \u003cimg width=\"100\" height=\"100\" src=\"https://raw.githubusercontent.com/redhat-developer/vscode-didact/main/icon/logo.png\"\u003e\n\u003c/p\u003e\u003cbr/\u003e\n\n\u003ch1 align=\"center\"\u003eDidact\u003c/h1\u003e\u003cbr/\u003e\n\u003ch2 align=\"center\"\u003eEasy interactive tutorials for VS Code.\u003c/h2\u003e\u003cbr/\u003e\n\u003cp align=\"justify\"\u003eThe \u003cb\u003eDidact\u003c/b\u003e 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.\u003c/p\u003e\u003cbr/\u003e\n\n\u003cp align=\"center\"\u003e\n\u003ca href=\"https://github.com/redhat-developer/vscode-didact/tree/main\"\u003e\u003cimg src=\"https://img.shields.io/github/tag/redhat-developer/vscode-didact.svg?style=plastic\" alt=\"GitHub tag\"/\u003e\u003c/a\u003e\n\u003ca href=\"https://circleci.com/gh/redhat-developer/vscode-didact\"\u003e\u003cimg src=\"https://circleci.com/gh/redhat-developer/vscode-didact.svg?style=shield\"\u003e\u003c/a\u003e\n\u003cimg src=\"https://img.shields.io/badge/license-Apache%202-blue.svg\" alt=\"License\"/\u003e\n\u003ca href=\"https://gitter.im/redhat-developer/vscode-didact\"\u003e\u003cimg src=\"https://img.shields.io/gitter/room/redhat-developer/home.js.sv\" alt=\"Gitter\"/\u003e\u003c/a\u003e\n\u003ca href=\"https://workspaces.openshift.com/f?url=https://github.com/redhat-developer/vscode-didact\"\u003e\u003cimg src=\"https://raw.githubusercontent.com/redhat-developer/vscode-didact/main/icon/che-contribute.png\" alt=\"Contribute\"/\u003e\u003c/a\u003e\n\n\u003c/p\u003e\u003cbr/\u003e\n\n\u003cp align=\"center\"\u003e\u003cimg src=\"./images/didact-sample-tutorial-30-APR-2021.gif\" alt=\"CLI Tutorial Example\" width=\"100%\"/\u003e\u003c/p\u003e\u003cbr/\u003e\n\n# Didact offers two avenues to success\n\n1. Published tutorials that walk users through easy-to-follow tutorials to accomplish their goals in an interactive manner.\n2. Developer tools to make writing and publishing such tutorials an easy process.\n\n## Starting the JavaScript Didact Tutorial\n\n1. Open the `Didact Tutorials` view in the Explorer activity sidebar.\n2. Expand the tree and find `HelloWorld with JavaScript in Three Steps`.\n3. Click the triangle at the end of the line or select `Start Didact tutorial` from the right-click menu.\n4. When the tutorial opens, work through the various steps.\n\n![Run the HelloWorld Example](./images/run-js-example.gif)\n\n## Writing your first Didact tutorial\n\n1. Create a new Markdown or AsciiDoc file with the extension `.didact.md` or `.didact.adoc`.\n2. Write some text about the action your user will accomplish. \n3. Start a new Didact link:\n* In Markdown, type `[Open a new terminal]()`, put the cursor between the parentheses `()` and press `Ctrl+Space`. \n* In AsciiDoc, type `link:[Open a new terminal]`, put the cursor after `link:`, and press `Ctrl+Space`.\n4. Select `Start new Didact command link`.\n5. Choose a command from the hundreds VS Code has available (like `workbench.action.terminal.new`) and press `Enter`.\n6. Press `Ctrl/Cmd+Alt+D` to view your new Didact tutorial and click the link you created! Done!\n\n![Open New Terminal Example](./images/open-new-terminal-example.gif)\n\n## Available Documentation (Updated!)\n\nOur documentation started in these [wiki pages](https://github.com/redhat-developer/vscode-didact/wiki/Welcome-to-Didact!) but are now located in GitHub pages [here](https://redhat-developer.github.io/vscode-didact/). Included are details about all of Didact's capabilities and many examples to get you started.\n\n\u003eNote: The [wiki pages](https://github.com/redhat-developer/vscode-didact/wiki/Welcome-to-Didact!) are deprecated and will be removed in a future release. Please use the [GitHub pages](https://redhat-developer.github.io/vscode-didact/) from release 0.4.0 forward.\n\nFor a list of available commands, check out the [Command Reference](examples/commands.reference.adoc).\n\n## Current Issues\n\nIf 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](https://redhat-developer.github.io/vscode-didact/troubleshooting) in the docs for details. \n\n## Ideas or want to contribute?\n\nCheck out [the project on Github](https://github.com/redhat-developer/vscode-didact)! \n\n[The readme](https://github.com/redhat-developer/vscode-didact/blob/main/README.md) has a ton of information about some of the specifics for link formatting, project json format, etc. \n\nAnd feel free to [add issues, submit feature requests, log bugs, etc](https://github.com/redhat-developer/vscode-didact/issues)!\n\n## A big thank you to these folks for following our progress!\n\n[![Stargazers repo roster for @redhat-developer/vscode-didact](https://reporoster.com/stars/redhat-developer/vscode-didact)](https://github.com/redhat-developer/vscode-didact/stargazers)\n\n[![Forkers repo roster for @redhat-developer/vscode-didact](https://reporoster.com/forks/redhat-developer/vscode-didact)](https://github.com/redhat-developer/vscode-didact/network/members)\n\n## Data and telemetry\n\nThe Didact extension for Visual Studio Code collects anonymous [usage data](USAGE_DATA.md) and sends it to Red Hat servers to help improve our products and services. Read our [privacy statement](https://developers.redhat.com/article/tool-data-collection) 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\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fredhat-developer%2Fvscode-didact","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fredhat-developer%2Fvscode-didact","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fredhat-developer%2Fvscode-didact/lists"}