Skip to content

Commit

Permalink
docs: write several documentations for airi
Browse files Browse the repository at this point in the history
Signed-off-by: Neko Ayaka <neko@ayaka.moe>
  • Loading branch information
nekomeowww committed Mar 5, 2025
1 parent 92fc93a commit b6a1fb7
Show file tree
Hide file tree
Showing 22 changed files with 770 additions and 15 deletions.
2 changes: 1 addition & 1 deletion apps/stage-web/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<link rel="icon" type="image/svg+xml" href="/favicon.svg" sizes="any" />
<link rel="shortcut icon" href="/favicon.ico" />
<link rel="apple-touch-icon" sizes="180x180" href="/apple-touch-icon.png" />
<meta name="apple-mobile-web-app-title" content="アイリ" />
<meta name="apple-mobile-web-app-title" content="Airi" />
<script>
;(function () {
const prefersDark = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches
Expand Down
6 changes: 0 additions & 6 deletions apps/stage-web/vite.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -112,12 +112,6 @@ export default defineConfig({
src: '/maskable_icon_x512.png',
type: 'image/png',
},
{
purpose: 'maskable',
sizes: '1024x1024',
src: '/maskable_icon.png',
type: 'image/png',
},
{
src: '/web-app-manifest-192x192.png',
sizes: '192x192',
Expand Down
20 changes: 17 additions & 3 deletions docs/astro.config.ts
Original file line number Diff line number Diff line change
@@ -1,12 +1,15 @@
import starlight from '@astrojs/starlight'
import { defineConfig } from 'astro/config'
import catppuccin from 'starlight-theme-catppuccin'

// https://astro.build/config
export default defineConfig({
integrations: [
starlight({
title: 'Project Airi',
logo: {
light: './src/assets/logo.svg',
dark: './src/assets/logo-dark.svg',
},
social: {
github: 'https://github.com/moeru-ai/airi',
},
Expand All @@ -15,9 +18,20 @@ export default defineConfig({
label: 'Guides',
autogenerate: { directory: 'guides' },
},
{
label: 'References',
autogenerate: { directory: 'references' },
},
],
head: [
{ tag: 'link', attrs: { rel: 'icon', type: 'image/svg+xml', href: '/favicon.svg', sizes: 'any' } },
{ tag: 'link', attrs: { rel: 'shortcut icon', href: '/favicon.ico' } },
{ tag: 'link', attrs: { rel: 'apple-touch-icon', sizes: '180x180', href: '/apple-touch-icon.png' } },
{ tag: 'meta', attrs: { name: 'apple-mobile-web-app-title', content: 'Airi' } },
{ tag: 'link', attrs: { ref: 'manifest', href: '/site.webmanifest' } },
],
plugins: [
catppuccin(),
customCss: [
'./src/styles/custom.css',
],
}),
],
Expand Down
13 changes: 13 additions & 0 deletions docs/netlify.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
[build]
base = "/"
command = "pnpm -F @proj-airi/docs... run build"
publish = "/docs/dist"

[build.environment]
NODE_VERSION = "23"

[[headers]]
for = "/site.webmanifest"

[headers.values]
Content-Type = "application/manifest+json"
Binary file added docs/public/favicon.ico
Binary file not shown.
62 changes: 61 additions & 1 deletion docs/public/favicon.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/public/maskable_icon_x192.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/public/maskable_icon_x512.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
39 changes: 39 additions & 0 deletions docs/public/site.webmanifest
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
{
"name": "Airi",
"short_name": "Airi",
"icons": [
{
"src": "/web-app-manifest-192x192.png",
"sizes": "192x192",
"type": "image/png",
"purpose": "maskable"
},
{
"src": "/web-app-manifest-512x512.png",
"sizes": "512x512",
"type": "image/png",
"purpose": "maskable"
},
{
"purpose": "maskable",
"sizes": "192x192",
"src": "/maskable_icon_x192.png",
"type": "image/png"
},
{
"purpose": "maskable",
"sizes": "512x512",
"src": "/maskable_icon_x512.png",
"type": "image/png"
},
{
"purpose": "maskable",
"sizes": "1024x1024",
"src": "/maskable_icon.png",
"type": "image/png"
}
],
"theme_color": "#ffc6cb",
"background_color": "#ffffff",
"display": "standalone"
}
Binary file added docs/public/web-app-manifest-192x192.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/public/web-app-manifest-512x512.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
42 changes: 42 additions & 0 deletions docs/src/assets/app-logo-dark.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
42 changes: 42 additions & 0 deletions docs/src/assets/app-logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
59 changes: 59 additions & 0 deletions docs/src/assets/logo-dark.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
61 changes: 61 additions & 0 deletions docs/src/assets/logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 3 additions & 1 deletion docs/src/content/docs/guides/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,6 @@ title: Getting Started
description: Get to know the UI of Project Airi
---

WIP.
For guides that help you understand how to contribute to this project, please refer to [Contributing](/references/contributing/guide/) page.

For references Contributing help you design and improve the UI of Project Airi, please refer to [Design Guidelines](/references/design-guidelines/) page.
7 changes: 4 additions & 3 deletions docs/src/content/docs/index.mdx
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
---
title: Welcome to Project Airi
description: LLM powered AI VTuber like Neuro-sama
title: Living cyber life like Neuro-sama
description: LLM powered AI VTuber, built by the community, open source
template: splash
hero:
tagline: A LLM powered AI VTuber like Neuro-sama, but Open Source
image:
file: ../../assets/houston.webp
dark: ../../assets/app-logo-dark.svg
light: ../../assets/app-logo.svg
actions:
- text: Try it!
link: https://airi.moeru.ai
Expand Down
Loading

0 comments on commit b6a1fb7

Please sign in to comment.