Releases: stackblitz/tutorialkit
1.3.1
What's Changed
- fix(astro): allow URLs in
meta.image
by @AriPerkkio in #422 - fix: warn when using
.svg
inmeta.image
by @eric-burel in #377 - fix: switch default
meta.image
to.png
by @AriPerkkio in #427
Full Changelog: 1.3.0...1.3.1
1.3.0
This version of TutorialKit introduces 2 new exciting features. 🥳
Lessons without parts or chapters
Tutorials that don't need 3 levels of nesting can now omit part and/or chapter levels. See https://tutorialkit.dev/guides/creating-content/ for updated instructions about content creation.
tk-filetree-flat.webm
Download lesson as .zip
file
Lessons of a tutorial can now be downloaded as .zip
file with a single click.
To enable this feature, define new option in your frontmatter:
type: tutorial # Or part, chapter, lesson - works on all levels
downloadAsZip: true
# Or to use specific filename when downloaded:
downloadAsZip:
filename: vite-yaml-plugin-summary.zip
If you are using overriden TopBar
, see new slot names at https://tutorialkit.dev/guides/overriding-components/#top-bar.
What's Changed
- feat(astro): support lessons without parts or chapters by @AriPerkkio in #374
- feat(astro): add "Download lesson as zip" button by @AriPerkkio in #415
- fix: remove
downloadAsZip
from template for now by @AriPerkkio in #416
Full Changelog: 1.2.2...1.3.0
1.2.2
What's Changed
- fix: hide preview container when
previews: false
by @AriPerkkio in #412 - docs: add filenames to
Marking text
examples by @noam-honig in #409
Full Changelog: 1.2.1...1.2.2
1.2.1
What's Changed
- fix(astro): optimize CJS dependency
picomatch
by @AriPerkkio in #406
Full Changelog: 1.2.0...1.2.1
1.2.0
What's Changed
- feat: sync new files from WebContainer to editor by @isaacplmann in #394
- fix(react): add vertical scroll bar to editor file tree by @isaacplmann in #399
- docs: enhance documentation with detailed Expressive Code attributes and examples by @noam-honig in #391
- docs: add
previews: false
example by @noam-honig in #397
New Contributors
- @isaacplmann made their first contribution in #399
Full Changelog: 1.1.1...1.2.0
1.1.1
What's Changed
- fix(theme): apply
fast-glob
Windows work-around for all\@
matches by @AriPerkkio in #383
Full Changelog: 1.1.0...1.1.1
1.1.0
What's Changed
- feat: add file extension based icons by @Charan167 in #369
- feat(astro): override components to support
HeadTags
by @eric-burel in #375 - feat(astro): add
custom
configuration option for passing custom fields by @eric-burel in #378 - fix(astro): types of override components to optional by @AriPerkkio in #376
- fix(astro): correct error message when chapter not found by @AriPerkkio in #361
- fix(cli): list eject command in help output by @d3lm in #373
- docs: add docs for file imports by @kevinzunigacuellar in #368
- docs: add docs for
defaultRoutes
by @kevinzunigacuellar in #365 - docs: typo in demo by @turtledev1 in #362
- docs: typo in demo by @Zih0 in #371
New Contributors
- @turtledev1 made their first contribution in #362
- @kevinzunigacuellar made their first contribution in #365
- @Zih0 made their first contribution in #371
Full Changelog: 1.0.0...1.1.0
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