Skip to content

Commit b4ead82

Browse files
Split into a multi page site using Vitepress
Fixes #2, and is a continuation of pull request #3. Vitepress has now been set up, but only a couple major sections have been split so far. Much more is to come.
1 parent fc77688 commit b4ead82

File tree

9 files changed

+1024
-698
lines changed

9 files changed

+1024
-698
lines changed

.gitignore

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,3 @@
1-
.DS_Store
1+
.DS_Store
2+
.vitepress/dist
3+
.vitepress/cache

.vitepress/api-examples.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
---
2+
outline: deep
3+
---
4+
5+
# Runtime API Examples
6+
7+
This page demonstrates usage of some of the runtime APIs provided by VitePress.
8+
9+
The main `useData()` API can be used to access site, theme, and page data for the current page. It works in both `.md` and `.vue` files:
10+
11+
```md
12+
<script setup>
13+
import { useData } from 'vitepress'
14+
15+
const { theme, page, frontmatter } = useData()
16+
</script>
17+
18+
## Results
19+
20+
### Theme Data
21+
<pre>{{ theme }}</pre>
22+
23+
### Page Data
24+
<pre>{{ page }}</pre>
25+
26+
### Page Frontmatter
27+
<pre>{{ frontmatter }}</pre>
28+
```
29+
30+
<script setup>
31+
import { useData } from 'vitepress'
32+
33+
const { site, theme, page, frontmatter } = useData()
34+
</script>
35+
36+
## Results
37+
38+
### Theme Data
39+
<pre>{{ theme }}</pre>
40+
41+
### Page Data
42+
<pre>{{ page }}</pre>
43+
44+
### Page Frontmatter
45+
<pre>{{ frontmatter }}</pre>
46+
47+
## More
48+
49+
Check out the documentation for the [full list of runtime APIs](https://vitepress.dev/reference/runtime-api#usedata).

.vitepress/config.mts

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
import { defineConfig } from 'vitepress'
2+
3+
// https://vitepress.dev/reference/site-config
4+
export default defineConfig({
5+
title: "Scratch Specification",
6+
7+
themeConfig: {
8+
// https://vitepress.dev/reference/default-theme-config
9+
nav: [
10+
{ text: 'Home', link: '/' },
11+
{ text: 'Intro', link: '/intro/' },
12+
{ text: 'Concepts', link: '/concepts/' },
13+
{ text: 'Runtime', link: '/runtime/' },
14+
{ text: 'Blocks', link: '/palette/' },
15+
{ text: 'Files', link: '/files/' },
16+
{ text: 'I/O', link: '/io/' },
17+
{ text: 'Network', link: '/network/' },
18+
{ text: 'Devices', link: '/devices/' }
19+
],
20+
21+
sidebar: [
22+
{
23+
text: 'Introduction',
24+
link: '/intro/',
25+
items: [
26+
{ text: 'Frequently Asked Questions', link: '/intro/#faq' },
27+
{ text: 'Contributing Guidelines', link: '/intro/#contributing' }
28+
]
29+
},
30+
{
31+
text: 'Concepts',
32+
link: '/concepts/',
33+
items: [
34+
{ text: 'Capabilities', link: '/concepts/#capabilities' },
35+
{ text: 'Constants', link: '/concepts/#constants' },
36+
{ text: 'Ideas', link: '/concepts/#ideas' },
37+
{ text: 'Values', link: '/concepts/#values' },
38+
{ text: 'Procedures', link: '/concepts/#procedures' }
39+
]
40+
},
41+
],
42+
43+
socialLinks: [
44+
{ icon: 'github', link: 'https://github.com/OceanIsEndless/scratch-spec' }
45+
],
46+
47+
search: {
48+
provider: 'local'
49+
}
50+
}
51+
})

.vitepress/markdown-examples.md

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
# Markdown Extension Examples
2+
3+
This page demonstrates some of the built-in markdown extensions provided by VitePress.
4+
5+
## Syntax Highlighting
6+
7+
VitePress provides Syntax Highlighting powered by [Shiki](https://github.com/shikijs/shiki), with additional features like line-highlighting:
8+
9+
**Input**
10+
11+
````md
12+
```js{4}
13+
export default {
14+
data () {
15+
return {
16+
msg: 'Highlighted!'
17+
}
18+
}
19+
}
20+
```
21+
````
22+
23+
**Output**
24+
25+
```js{4}
26+
export default {
27+
data () {
28+
return {
29+
msg: 'Highlighted!'
30+
}
31+
}
32+
}
33+
```
34+
35+
## Custom Containers
36+
37+
**Input**
38+
39+
```md
40+
::: info
41+
This is an info box.
42+
:::
43+
44+
::: tip
45+
This is a tip.
46+
:::
47+
48+
::: warning
49+
This is a warning.
50+
:::
51+
52+
::: danger
53+
This is a dangerous warning.
54+
:::
55+
56+
::: details
57+
This is a details block.
58+
:::
59+
```
60+
61+
**Output**
62+
63+
::: info
64+
This is an info box.
65+
:::
66+
67+
::: tip
68+
This is a tip.
69+
:::
70+
71+
::: warning
72+
This is a warning.
73+
:::
74+
75+
::: danger
76+
This is a dangerous warning.
77+
:::
78+
79+
::: details
80+
This is a details block.
81+
:::
82+
83+
## More
84+
85+
Check out the documentation for the [full list of markdown extensions](https://vitepress.dev/guide/markdown).

0 commit comments

Comments
 (0)