Skip to content

Commit

Permalink
add basics docs using starlight taking most things from README
Browse files Browse the repository at this point in the history
  • Loading branch information
jwetzell committed May 25, 2024
1 parent 439e2bf commit 04fdcbe
Show file tree
Hide file tree
Showing 22 changed files with 8,931 additions and 0 deletions.
18 changes: 18 additions & 0 deletions docs/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# build output
dist/
# generated types
.astro/

# dependencies
node_modules/

# logs
npm-debug.log*
yarn-debug.log*
yarn-error.log*
pnpm-debug.log*


# environment variables
.env
.env.production
41 changes: 41 additions & 0 deletions docs/astro.config.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
import starlight from '@astrojs/starlight';
import { defineConfig } from 'astro/config';

// https://astro.build/config
export default defineConfig({
integrations: [
starlight({
title: 'showbridge',
favicon: '/favicon.ico',
social: {
github: 'https://github.com/jwetzell/showbridge',
},
sidebar: [
{
label: 'showbridge',
autogenerate: { directory: '/showbridge' },
},
{
label: 'Guides',
autogenerate: { directory: 'guides' },
},
{
label: 'Reference',
autogenerate: { directory: 'reference' },
},
{ label: 'Demo', link: 'https://demo.showbridge.io/', attrs: { target: '_blank' } },
{
label: 'More Docs',
items: [
{ label: 'Lib JSDocs', link: 'https://docs.showbridge.io/lib/', attrs: { target: '_blank' } },
{
label: 'Config JSON Schema',
link: 'https://docs.showbridge.io/schema/config',
attrs: { target: '_blank' },
},
],
},
],
}),
],
});
Loading

0 comments on commit 04fdcbe

Please sign in to comment.