File tree 3 files changed +72
-0
lines changed
3 files changed +72
-0
lines changed Original file line number Diff line number Diff line change
1
+ <p align =" center " >
2
+ <picture >
3
+ <source media="(prefers-color-scheme: dark)" srcset="media/logo-white.svg">
4
+ <img src="media/logo.svg" alt="tutorialkit-logo" width="440px" height="120px" />
5
+ </picture >
6
+ <br >
7
+ TutorialKit by <a href =" https://stackblitz.com " >StackBlitz</a > enables you to create interactive coding tutorials effortlessly, boosting the adoption of
8
+ your framework, UI library or design system.
9
+ </p >
10
+
11
+ <p align =" center " >
12
+ <a href =" https://tutorialkit.dev/ " ><strong >tutorialkit.dev</strong ></a >
13
+ <br >
14
+ </p >
15
+
16
+ <p align =" center " >
17
+ <a href =" https://tutorialkit.dev/guides/about/#getting-started " >Get Started</a >
18
+ ·
19
+ <a href =" https://demo.tutorialkit.dev/ " >Try Demo</a >
20
+ <br >
21
+ <br >
22
+ </p >
23
+
24
+ <hr >
25
+
26
+ ## Documentation
27
+
28
+ Read our documentation on [ tutorialkit.dev] ( https://tutorialkit.dev/guides/about )
29
+
30
+ ## Development Setup
31
+
32
+ ### Prerequisites
33
+
34
+ - Install [ Node.js] ( https://nodejs.org/en ) v18.18 or above.
35
+ - Install [ pnpm] ( https://pnpm.io/ ) .
36
+
37
+ ### Set up
38
+
39
+ Clone this repository and navigate into the cloned directory.
40
+
41
+ ```
42
+ git clone [email protected] :stackblitz/tutorialkit.git
43
+ cd tutorialkit
44
+ ```
45
+
46
+ TutorialKit uses [ pnpm workspaces] ( https://pnpm.io/workspaces ) . Just run the install command in the root of the project.
47
+
48
+ ```
49
+ pnpm install
50
+ ```
51
+
52
+ You can now start the development template of TutorialKit by running:
53
+
54
+ ```
55
+ pnpm template:dev
56
+ ```
57
+
58
+ ## Community
59
+
60
+ Come and say hi :wave : !
61
+
62
+ - [ X] ( https://x.com/stackblitz )
63
+ - [ Discord] ( https://discord.gg/stackblitz )
64
+ - [ GitHub] ( https://github.com/stackblitz )
You can’t perform that action at this time.
0 commit comments