Skip to content

Commit 3db8a1e

Browse files
authored
Merge branch 'main' into joan/order-from-config
2 parents 7226e75 + 4c39cc6 commit 3db8a1e

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

58 files changed

+2797
-148
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,4 +20,5 @@ dist-ssr
2020
.pnpm-store
2121
/tutorialkit/template
2222
tsconfig.tsbuildinfo
23+
tsconfig.build.tsbuildinfo
2324
.tmp

.prettierignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,4 @@
11
pnpm-lock.yaml
2+
.astro
23
**/*.md
4+
**/*.mdx

docs/tutorialkit.dev/.gitignore

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# generated types
2+
.astro
3+
4+
# environment variables
5+
.env
6+
.env.production

docs/tutorialkit.dev/README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# [TutorialKit.dev](https://www.tutorialkit.dev)
2+
3+
## Local Development
4+
5+
### Prerequisites
6+
7+
- Install [Node.js](https://nodejs.org/en) v18.18 or above.
8+
- Install [pnpm](https://pnpm.io/).
9+
10+
### Set up
11+
12+
Clone this repository and navigate into the cloned directory.
13+
14+
```
15+
git clone [email protected]:stackblitz/tutorialkit.git
16+
cd tutorialkit
17+
```
18+
19+
TutorialKit uses [pnpm workspaces](https://pnpm.io/workspaces). Just run the install command in the root of the project.
20+
21+
```
22+
pnpm install
23+
```
24+
25+
You can now start the documentation website by running:
26+
27+
```
28+
pnpm run docs
29+
```

docs/tutorialkit.dev/astro.config.ts

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
import { defineConfig } from 'astro/config';
2+
import react from '@astrojs/react';
3+
import starlight from '@astrojs/starlight';
4+
import starlightLinksValidator from 'starlight-links-validator';
5+
6+
// https://astro.build/config
7+
export default defineConfig({
8+
site: 'https://tutorialkit.dev',
9+
integrations: [
10+
react(),
11+
starlight({
12+
title: 'Create interactive coding tutorials',
13+
components: {
14+
Head: './src/components/Layout/Head.astro',
15+
},
16+
customCss: ['./src/styles/custom.scss'],
17+
logo: {
18+
dark: './src/assets/brand/tutorialkit-logo-dark.svg',
19+
light: './src/assets/brand/tutorialkit-logo-light.svg',
20+
replacesTitle: true,
21+
},
22+
plugins: [starlightLinksValidator()],
23+
sidebar: [
24+
{
25+
label: 'Guides',
26+
items: [
27+
// Each item here is one entry in the navigation menu.
28+
{
29+
label: 'About',
30+
link: '/guides/about/',
31+
},
32+
{
33+
label: 'Installation',
34+
link: '/guides/installation/',
35+
},
36+
{
37+
label: 'Creating a Lesson',
38+
link: '/guides/creating-content/',
39+
},
40+
{
41+
label: 'Configuration',
42+
link: '/guides/configuration/',
43+
},
44+
{
45+
label: 'Deployment',
46+
link: '/guides/deployment/',
47+
},
48+
{
49+
label: 'User Interface Reference',
50+
link: '/guides/ui/',
51+
},
52+
],
53+
},
54+
],
55+
// social: {
56+
// github: 'https://github.com/withastro/starlight',
57+
// },
58+
tableOfContents: {
59+
maxHeadingLevel: 5,
60+
},
61+
}),
62+
],
63+
});

docs/tutorialkit.dev/package.json

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
{
2+
"name": "tutorialkit.dev",
3+
"type": "module",
4+
"version": "0.0.1",
5+
"private": true,
6+
"scripts": {
7+
"dev": "astro dev",
8+
"start": "astro dev",
9+
"build": "astro check && astro build",
10+
"preview": "astro preview",
11+
"astro": "astro"
12+
},
13+
"dependencies": {
14+
"@astrojs/check": "^0.7.0",
15+
"@astrojs/react": "^3.4.0",
16+
"@astrojs/starlight": "^0.23.2",
17+
"@types/react": "^18.3.3",
18+
"@types/react-dom": "^18.3.0",
19+
"astro": "^4.8.6",
20+
"classnames": "^2.5.1",
21+
"react": "^18.3.1",
22+
"react-dom": "^18.3.1",
23+
"sass": "^1.77.3",
24+
"sharp": "^0.32.5",
25+
"starlight-links-validator": "^0.9.0",
26+
"typescript": "^5.4.5"
27+
},
28+
"devDependencies": {
29+
"@types/gtag.js": "^0.0.20"
30+
}
31+
}
Lines changed: 4 additions & 0 deletions
Loading
Lines changed: 4 additions & 0 deletions
Loading
Lines changed: 4 additions & 0 deletions
Loading
96.2 KB
Binary file not shown.

0 commit comments

Comments
 (0)