Skip to content

Commit

Permalink
Add getting started page
Browse files Browse the repository at this point in the history
  • Loading branch information
bendera committed Oct 27, 2024
1 parent 983b89d commit 33e43df
Show file tree
Hide file tree
Showing 3 changed files with 38 additions and 9 deletions.
6 changes: 6 additions & 0 deletions docs/astro.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,12 @@ export default defineConfig({
"https://github.com/vscode-elements/elements-lite/tree/main/docs",
},
sidebar: [
{
label: "Guides",
items: [
{label: "Getting Started", slug: 'guides/getting-started'}
]
},
{
label: "Components",
items: [
Expand Down
27 changes: 27 additions & 0 deletions docs/src/content/docs/guides/getting-started.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
title: Getting Started
---

VSCode Elements Lite is a simpler, lightweight alternative to [VSCode Elements](https://vscode-elements.github.io). There’s no need to
deal with TypeScript or bundler configurations. In fact, you don’t even need to install a package if
you prefer not to—just copy the code snippet you need. While VSCode Elements Lite doesn’t cover
every case that VSCode Elements does, it’s sufficient for most purposes. You can also use it together with VSCode Elements components.

## Using the Configurator

The easiest way to get started is by using the configurator. Set the desired parameters, then copy the generated HTML snippet.
The related CSS is also provided on the configurator page—simply copy the code and add it to your project.

## Install as npm package

If you're using a bundler like Webpack or Vite, you can install VSCode Elements Lite as an npm package:

```bash
npm install @vscode-elements/elements-lite
```

Next, import the necessary styles:

```javascript
import "@vscode-elements/elements-lite/components/button/button.css";
```
14 changes: 5 additions & 9 deletions docs/src/content/docs/index.mdx
Original file line number Diff line number Diff line change
@@ -1,19 +1,15 @@
---
title: Welcome to Starlight
description: Get started building your docs site with Starlight.
title: VSCode Elements Lite
description: HTML + CSS snippets for developing screens in the VSCode Webview
template: splash
hero:
tagline: Congrats on setting up a new Starlight project!
tagline: HTML + CSS snippets for developing screens in the VSCode Webview
image:
file: ../../assets/logo.svg
actions:
- text: Example Guide
link: /guides/example/
- text: Getting Started
link: /elements-lite/guides/getting-started
icon: right-arrow
- text: Read the Starlight docs
link: https://starlight.astro.build
icon: external
variant: minimal
---

import { Card, CardGrid } from "@astrojs/starlight/components";
Expand Down

0 comments on commit 33e43df

Please sign in to comment.