1.0.0

TutorialKit v1 is out now 🎉

This release introduces many features, such as Adding files via FileTree and Synchronizing file system changes to Editor, and marks the API of TutorialKit as stable!

If you are upgrading from versions below 0.2.0, see Migration from 0.1.6 to 0.2.0. Otherwise the breaking changes consider mostly experimental APIs listed below.

Experimental APIs

TutorialKit v1 marks some low level APIs as experimental. This means that these APIs can receive breaking changes in minor and patch release - though we still try to avoid these as best as we can.

tutorialkit:store & tutorialkit:core

Low level APIs tutorialkit:store and tutorialkit:core can be used to create highly custom experiences in tutorials. In v1 we've added documentation for these and marked the first draft of this API as an experimental feature. You can help us stabilize the API by providing feedback at Stabilizing tutorialkit:store API.

See TutorialKit API and How to use TutorialKit API for examples.

@tutorialkit/react

Using @tutorialkit/react without TutorialKit itself is now an experimental feature. We are planning to stabilize the components' APIs in future.

See https://tutorialkit.dev/reference/react-components/ for more info

What's Changed

• feat!: mark @tutorialkit/react component API as experimental feature by @AriPerkkio in #346
• feat(astro): override components to support Dialog by @AriPerkkio in #345
• feat(runtime): add terminal.input for writing to stdin by @AriPerkkio in #350
• feat: add files via file tree by @AriPerkkio in #314
• feat: support glob patterns in editor.fileTree.allowEdits by @AriPerkkio in #332
• feat: sync files from WebContainer to editor by @Nemikolh in #334
• fix(astro): published package missing @tutorialkit/astro/types by @AriPerkkio in #347
• fix(astro): better default meta tags by @eric-burel in #342
• fix: prevent overwriting template files via <FileTree> by @AriPerkkio in #336
• docs: add editPageLink in demo by @Charan167 in #343
• docs: add github icon on top of demo.tutorialkit.dev TopBar by @Charan167 in #338

New Contributors

• @Charan167 made their first contribution in #338
• @eric-burel made their first contribution in #342

Full Changelog: 0.2.3...1.0.0

0.2.3

What's Changed

• fix(react): stale lesson data after navigation by @AriPerkkio in #318

Full Changelog: 0.2.2...0.2.3

0.2.2

What's Changed

• feat(react): add button to reload a preview by @Nemikolh in #305
• fix: align Powered by WebContainers to the bottom by @AriPerkkio in #301
• fix(react): refresh preview when autoReload: true by @AriPerkkio in #303
• refactor: split <WorkspacePanel> into 3 internal components by @AriPerkkio in #253
• docs: change the clone url by @noam-honig in #307
• chore: add info on Enterprise Server by @HeyGarrison in #299

New Contributors

• @HeyGarrison made their first contribution in #299
• @noam-honig made their first contribution in #307

Full Changelog: 0.2.1...0.2.2

0.2.1

What's Changed

• fix(astro): work-around for dev-mode's ReferenceError: __WC_CONFIG__ is not defined errors by @AriPerkkio in #293
• chore: use swapFunctions from astro:transitions/client by @martrapp in #291
  • This PR was accidentally marked as chore. It fixes #235.
  • Note that this fix requires projects to update their astro to version ^4.15.0.

New Contributors

• @martrapp made their first contribution in #291

Full Changelog: 0.2.0...0.2.1

0.2.0

This release of TutorialKit introduces two breaking changes. For detailed migration guide see Migration from 0.1.6 to 0.2.0 #286.

What's Changed

• docs: tutorialkit.dev link in readme by @o-az in #277
• ❗ feat!: simplify UnoCSS integration by @AriPerkkio in #270
• ❗ feat!: rename @tutorialkit/components-react to @tutorialkit/react by @AriPerkkio in #155

New Contributors

• @o-az made their first contribution in #277

Full Changelog: 0.1.6...0.2.0

0.1.6

What's Changed

• fix(cli): create-tutorial not depending on @tutorialkit/cli package by @ycs77 in #254
• feat: add Vue language to CodeMirror by @ycs77 in #256
• fix(astro/types): webcontainer should be a Promise<WebContainer> by @Nemikolh in #259
• feat(runtime): option for setting terminal open by default by @AriPerkkio in #246
• fix: missing preview i18n by @ycs77 in #255
• fix(react): solve-button not working before lesson loads by @AriPerkkio in #266
• fix(react): editor and preview missing accessible names by @AriPerkkio in #267
• fix(react): file tree's files to indicate selected state by @AriPerkkio in #268
• chore: remove spec files from runtime package by @PhearZero in #236

New Contributors

• @ycs77 made their first contribution in #254
• @PhearZero made their first contribution in #236

Full Changelog: 0.1.5...0.1.6

0.1.5

What's Changed

• docs: add info on how to create callouts by @henrikvilhelmberglund in #224
• feat(runtime): add preview.pathname by @AriPerkkio in #233
• fix(astro): don't modify state during re-renders of <WorkspacePanelWrapper /> by @AriPerkkio in #240
• fix(extension): only match tutorialkit content and meta files by @Nemikolh in #242

New Contributors

• @henrikvilhelmberglund made their first contribution in #224

Full Changelog: 0.1.4...0.1.5

0.1.4

What's Changed

• fix(astro): sub folders not working on Windows by @AriPerkkio in #225
• fix(astro): webcontainers link to be in plural by @AriPerkkio in #227
• feat(extension): support config-based ordering by @Nemikolh in #223

Full Changelog: 0.1.3...0.1.4

0.1.3

What's Changed

• feat: add Svelte language to CodeMirror by @adrianmroz in #212
• feat: add link to webcontainers.io by @AriPerkkio in #202
• feat: rename tutorialkit to @tutorialkit/cli by @AriPerkkio in #153
• feat: add 'Open in StackBlitz'-button by @AriPerkkio in #219

New Contributors

• @adrianmroz made their first contribution in #212

Full Changelog: 0.1.2...0.1.3

0.1.2

What's Changed

• fix: ignore templates node_modules by @AriPerkkio in #198
  • Fixes cases where having node_modules present on template directories caused jsh: permission denied errors.

Full Changelog: 0.1.1...0.1.2