https://github.com/stackblitz/tutorialkit-extension
TutorialKit support in VS Code
https://github.com/stackblitz/tutorialkit-extension
Last synced: 11 months ago
JSON representation
TutorialKit support in VS Code
- Host: GitHub
- URL: https://github.com/stackblitz/tutorialkit-extension
- Owner: stackblitz
- License: mit
- Created: 2024-06-19T14:43:26.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-07-01T12:36:46.000Z (over 1 year ago)
- Last Synced: 2025-02-25T11:07:42.094Z (11 months ago)
- Language: TypeScript
- Size: 329 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# The source this project is now moved to [the main tutorialkit repository](https://github.com/stackblitz/tutorialkit). This repo is archived.
# TutorialKit Code Extension
**Status**: Preview
## Features
- Viewing lessons, chapters and parts in the side panel
- Creating new lessons and chapters
## Installation
1. Open VS Code
2. Select _Extensions_ in the left vertical toolbar
3. Search for `tutorialkit`
4. Click on _Install_
## Description
When designing the content architecture across folders and files, we aimed to make it as plain and clear as possible. However, even the best-thought-out file system organization doesn’t translate perfectly to the more abstract structure of lessons and chapters in a tutorial.
We wanted to make navigating between the different parts of your courseware or creating new lessons even easier than traversing a file system.
For that reason, we’ve decided to build a companion Visual Studio Code extension for tutorial authors. The extension provides a visual representation of your tutorial structure and allows you to create new chapters and lessons. When you navigate through the displayed structure, the extension automatically focuses on the corresponding folders and files in your file explorer, giving you a quick way to jump to the content you want to edit.