Skip to content

Commit 1ddae17

Browse files
DaveKeehlDaveKeehl
authored
Merge pull request #219 from DaveKeehl/documentation/211-publish-new-docs-website
Publish new docs website
2 parents f9d1e42 + e1a368f commit 1ddae17

24 files changed

+10406
-2724
lines changed

‎README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Svelte Reveal is a library created with the purpose of helping [Svelte](https://
1717

1818
## Documentation
1919

20-
The documentation is available [here](./packages/svelte-reveal/README.md).
20+
You can find full documentation on [svelte-reveal.dev](https://svelte-reveal.dev).
2121

2222
## Monorepo
2323

‎docs/.gitignore

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# build output
2+
dist/
3+
# generated types
4+
.astro/
5+
6+
# dependencies
7+
node_modules/
8+
9+
# logs
10+
npm-debug.log*
11+
yarn-debug.log*
12+
yarn-error.log*
13+
pnpm-debug.log*
14+
15+
16+
# environment variables
17+
.env
18+
.env.production
19+
20+
# macOS-specific files
21+
.DS_Store

‎docs/README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Svelte Reveal - Docs
2+
3+
[![Built with Starlight](https://astro.badg.es/v2/built-with-starlight/tiny.svg)](https://starlight.astro.build)
4+
5+
This Astro project is the documentation for Svelte Reveal.
6+
7+
## Local development
8+
9+
In order to locally develop this project you need to:
10+
11+
1. Run `npm install` to install the dependencies
12+
2. Run `npm run dev` to start the local dev server at `localhost:4321`

‎docs/astro.config.mjs

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
import { defineConfig } from 'astro/config';
2+
import starlight from '@astrojs/starlight';
3+
4+
// https://astro.build/config
5+
export default defineConfig({
6+
integrations: [
7+
starlight({
8+
title: 'Svelte Reveal',
9+
social: {
10+
github: 'https://github.com/davekeehl/svelte-reveal'
11+
},
12+
editLink: {
13+
baseUrl: 'https://github.com/davekeehl/svelte-reveal/edit/main/docs/'
14+
},
15+
sidebar: [
16+
{
17+
label: 'Start Here',
18+
autogenerate: { directory: 'start-here' }
19+
},
20+
{
21+
label: 'Reference',
22+
autogenerate: { directory: 'reference' }
23+
}
24+
],
25+
customCss: [
26+
// Relative path to your custom CSS file
27+
'./src/styles/custom.css'
28+
]
29+
})
30+
]
31+
});

‎docs/package.json

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
{
2+
"name": "docs",
3+
"type": "module",
4+
"version": "1.0.0",
5+
"scripts": {
6+
"dev": "astro dev",
7+
"start": "astro dev",
8+
"build": "astro check && astro build",
9+
"preview": "astro preview",
10+
"astro": "astro",
11+
"clean": "rimraf .astro .turbo node_modules package-lock.json dist"
12+
},
13+
"dependencies": {
14+
"@astrojs/check": "^0.5.10",
15+
"@astrojs/starlight": "^0.21.4",
16+
"astro": "^4.3.5",
17+
"rimraf": "^5.0.5",
18+
"sharp": "^0.32.5",
19+
"typescript": "^5.4.4"
20+
}
21+
}

‎docs/public/favicon.svg

Lines changed: 1 addition & 0 deletions
Loading

‎docs/src/assets/hero_img_dark.svg

Lines changed: 77 additions & 0 deletions
Loading

‎docs/src/assets/hero_img_light.svg

Lines changed: 77 additions & 0 deletions
Loading

‎docs/src/assets/ogImage.svg

Lines changed: 90 additions & 0 deletions
Loading

‎docs/src/content/config.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
import { defineCollection } from 'astro:content';
2+
import { docsSchema } from '@astrojs/starlight/schema';
3+
4+
export const collections = {
5+
docs: defineCollection({ schema: docsSchema() })
6+
};

‎docs/src/content/docs/index.mdx

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
title: Simple scroll based animations for Svelte
3+
description: Svelte Reveal is your go-to library for adding simple scroll based animations to your Svelte apps.
4+
template: splash
5+
hero:
6+
tagline: Svelte Reveal is your go-to library for adding simple scroll based animations to your Svelte apps.
7+
image:
8+
dark: ../../assets/hero_img_dark.svg
9+
light: ../../assets/hero_img_light.svg
10+
actions:
11+
- text: Get started
12+
link: /start-here/getting-started/
13+
icon: right-arrow
14+
variant: primary
15+
- text: View on GitHub
16+
link: https://github.com/davekeehl/svelte-reveal
17+
icon: external
18+
---
19+
20+
import { Card, CardGrid } from '@astrojs/starlight/components';
21+
22+
<CardGrid>
23+
<Card title="Near zero config" icon="rocket">
24+
Get started really fast with just a few lines of code.
25+
</Card>
26+
<Card title="Highly customizable" icon="puzzle">
27+
Creating custom transitions with Svelte Reveal is a <em>breeze</em>.
28+
</Card>
29+
<Card title="100% TypeScript" icon="seti:typescript">
30+
Built from the ground up for maximum type safety.
31+
</Card>
32+
<Card title="Exhaustive documentation" icon="open-book">
33+
We spent a lot of time documenting every bit possible.
34+
</Card>
35+
<Card title="Intersection Observer" icon="seti:svg">
36+
Built-in support for the Intersection Observer API.
37+
</Card>
38+
<Card title="Extensive API" icon="seti:json">
39+
Need full control? We got you covered.
40+
</Card>
41+
</CardGrid>

0 commit comments

Comments
 (0)