Skip to content

Add docs site with starlight ion theme #46

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,5 @@ pubspec_overrides.yaml
melos_arcade.iml
.DS_Store
packages/*/pubspec.lock
.asdf
.tool-versions
2 changes: 2 additions & 0 deletions docs/.gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Auto detect text files and perform LF normalization
* text=auto
23 changes: 23 additions & 0 deletions docs/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# 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

# macOS-specific files
.DS_Store

# VS Code
.vscode
21 changes: 21 additions & 0 deletions docs/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2024 Louis Escher

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
10 changes: 10 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Arcade Documentation

This directory contains the documentation site built with [Astro](https://astro.build/) using the [Starlight Ion theme](https://louisescher.github.io/starlight-ion-theme/).

Run the following commands to develop the site locally:

```bash
npm install
npm run dev
```
48 changes: 48 additions & 0 deletions docs/astro.config.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
import { defineConfig } from 'astro/config';
import starlight from '@astrojs/starlight';
import { ion, resolve } from 'starlight-ion-theme';

// https://astro.build/config
export default defineConfig({
site: 'https://arcade.ex3.dev',
base: '/',
integrations: [starlight({
title: 'Arcade',
logo: {
dark: './src/assets/ion-logo.svg',
light: './src/assets/ion-logo-light.svg',
},
social: {
github: 'https://github.com/dartarcade/arcade'
},
sidebar: [
{ label: '[home] Home', link: '/' },
{ label: '[list] Getting Started', link: '/getting-started/' },
{ label: '[box] Packages', autogenerate: { directory: 'packages' } },
{ label: '[rocket] Todo API Sample', link: '/samples/todo-api/' }
],
customCss: [
'@fontsource-variable/space-grotesk/index.css',
'@fontsource/space-mono/400.css',
'@fontsource/space-mono/700.css',
'./src/styles/global.css'
],
lastUpdated: true,
pagination: false,
plugins: [
ion({
icons: {
iconDir: './src/icons',
},
footer: {
text: '©️ Arcade contributors',
links: [{
text: 'GitHub',
href: 'https://github.com/dartarcade/arcade'
}]
}
})
]
})],
output: "static"
});
24 changes: 24 additions & 0 deletions docs/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
{
"name": "docs",
"type": "module",
"version": "0.0.1",
"scripts": {
"dev": "astro dev",
"start": "node ./dist/server/entry.mjs",
"build": "astro build",
"preview": "astro preview",
"astro": "astro"
},
"dependencies": {
"@astrojs/starlight": "^0.32.1",
"@fontsource-variable/space-grotesk": "^5.1.1",
"@fontsource/space-mono": "^5.1.2",
"@iconify-json/lucide": "^1.2.22",
"astro": "^5.3.0",
"sharp": "^0.33.5",
"starlight-ion-theme": "workspace:",
"starlight-package-managers": "^0.9.0",
"typescript": "catalog:"
},
"packageManager": "[email protected]+sha256.022309bb31359142b65bfa889e0406d2eebd5acfffca47e6944acf29d9d6a66b"
}
Loading
Loading