placeholder docs and home

This commit is contained in:
Loren Norman 2025-06-19 13:15:45 -04:00
parent 2a697d2308
commit 66c214e398
6 changed files with 30 additions and 144 deletions

View file

@ -1,49 +0,0 @@
---
outline: deep
---
# Runtime API Examples
This page demonstrates usage of some of the runtime APIs provided by VitePress.
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:
```md
<script setup>
import { useData } from 'vitepress'
const { theme, page, frontmatter } = useData()
</script>
## Results
### Theme Data
<pre>{{ theme }}</pre>
### Page Data
<pre>{{ page }}</pre>
### Page Frontmatter
<pre>{{ frontmatter }}</pre>
```
<script setup>
import { useData } from 'vitepress'
const { site, theme, page, frontmatter } = useData()
</script>
## Results
### Theme Data
<pre>{{ theme }}</pre>
### Page Data
<pre>{{ page }}</pre>
### Page Frontmatter
<pre>{{ frontmatter }}</pre>
## More
Check out the documentation for the [full list of runtime APIs](https://vitepress.dev/reference/runtime-api#usedata).

View file

@ -0,0 +1,7 @@
---
title: Automation Examples
---
# Automation Examples
Coming soon...

7
docs/block-index.md Normal file
View file

@ -0,0 +1,7 @@
---
title: The Blocks
---
# The Blocks
Coming soon...

7
docs/getting-started.md Normal file
View file

@ -0,0 +1,7 @@
---
title: Getting Started
---
# Getting Started
Coming soon...

View file

@ -3,26 +3,25 @@
layout: home
hero:
name: "IO Actions: Block Reference"
text: "Documentation for Adafruit IO's block-based Actions"
tagline: Automation that just clicks!
name: "IO Actions:"
text: "Block Reference"
tagline: Automation that clicks!
actions:
- theme: brand
text: Getting Started
link: /markdown-examples
link: /getting-started.md
- theme: alt
text: The Blocks
link: /markdown-examples
link: /block-index.md
- theme: alt
text: Automation Examples
link: /api-examples
link: /automation-examples.md
features:
- title: Learn
- title: 📚 Learn
details: ...about the whole system and each individual block
- title: Experiment
- title: 🧪 Experiment
details: ...using the embedded sandbox environments
- title: Automate
- title: ⚙️ Automate
details: ...with Adafruit IO's flexible, block-based Actions
---

View file

@ -1,85 +0,0 @@
# Markdown Extension Examples
This page demonstrates some of the built-in markdown extensions provided by VitePress.
## Syntax Highlighting
VitePress provides Syntax Highlighting powered by [Shiki](https://github.com/shikijs/shiki), with additional features like line-highlighting:
**Input**
````md
```js{4}
export default {
data () {
return {
msg: 'Highlighted!'
}
}
}
```
````
**Output**
```js{4}
export default {
data () {
return {
msg: 'Highlighted!'
}
}
}
```
## Custom Containers
**Input**
```md
::: info
This is an info box.
:::
::: tip
This is a tip.
:::
::: warning
This is a warning.
:::
::: danger
This is a dangerous warning.
:::
::: details
This is a details block.
:::
```
**Output**
::: info
This is an info box.
:::
::: tip
This is a tip.
:::
::: warning
This is a warning.
:::
::: danger
This is a dangerous warning.
:::
::: details
This is a details block.
:::
## More
Check out the documentation for the [full list of markdown extensions](https://vitepress.dev/guide/markdown).