-
Notifications
You must be signed in to change notification settings - Fork 3
feat(v3): Starlight #65
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
Changes from 3 commits
150a6c0
9e8796e
cfb19e9
3a31f36
b1c153c
1a03cb7
1a330a1
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,21 @@ | ||
| .next | ||
| node_modules | ||
| .idea | ||
| public/robots.txt | ||
| public/sitemap* | ||
| # 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 |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| { | ||
| "recommendations": ["astro-build.astro-vscode"], | ||
| "unwantedRecommendations": [] | ||
| } |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| { | ||
| "version": "0.2.0", | ||
| "configurations": [ | ||
| { | ||
| "command": "./node_modules/.bin/astro dev", | ||
| "name": "Development server", | ||
| "request": "launch", | ||
| "type": "node-terminal" | ||
| } | ||
| ] | ||
| } |
This file was deleted.
| Original file line number | Diff line number | Diff line change | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,36 @@ | ||||||||||||||
| // @ts-check | ||||||||||||||
| import { defineConfig } from "astro/config"; | ||||||||||||||
| import starlight from "@astrojs/starlight"; | ||||||||||||||
|
|
||||||||||||||
| import logoLight from "./public/logo-light.svg"; | ||||||||||||||
| import logoDark from "./public/logo-dark.svg"; | ||||||||||||||
| import { sidebar } from "./src/sidebar"; | ||||||||||||||
| import { socials } from "./src/content/links"; | ||||||||||||||
|
|
||||||||||||||
| // https://astro.build/config | ||||||||||||||
| export default defineConfig({ | ||||||||||||||
| integrations: [ | ||||||||||||||
| starlight({ | ||||||||||||||
| title: "Start UI Documentation", | ||||||||||||||
| logo: { | ||||||||||||||
| dark: logoDark, | ||||||||||||||
| light: logoLight, | ||||||||||||||
| alt: "Start UI", | ||||||||||||||
| replacesTitle: true, | ||||||||||||||
| }, | ||||||||||||||
|
|
||||||||||||||
| components: { | ||||||||||||||
| SocialIcons: "./src/components/overrides/SocialIcons.astro", | ||||||||||||||
| Footer: "./src/components/overrides/Footer.astro", | ||||||||||||||
| }, | ||||||||||||||
| editLink: { | ||||||||||||||
| baseUrl: "https://github.com/BearStudio/start-ui-web-docs/blob/main", | ||||||||||||||
| }, | ||||||||||||||
|
Comment on lines
+27
to
+29
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Edit link should use /edit/main, not /blob/main. Current link opens the viewer, not the editor. - editLink: {
- baseUrl: "https://github.com/BearStudio/start-ui-web-docs/blob/main",
- },
+ editLink: {
+ baseUrl: "https://github.com/BearStudio/start-ui-web-docs/edit/main",
+ },Based on learnings 📝 Committable suggestion
Suggested change
🤖 Prompt for AI Agents |
||||||||||||||
|
|
||||||||||||||
| credits: true, | ||||||||||||||
| customCss: ["./src/styles/app.css"], | ||||||||||||||
| social: socials, | ||||||||||||||
| sidebar: sidebar, | ||||||||||||||
| }), | ||||||||||||||
|
Comment on lines
32
to
35
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🧩 Analysis chainVerify socials target repo URL.
Based on learnings 🏁 Script executed: #!/bin/bash
# Inspect socials
rg -nC2 'export const socials' --type=ts
rg -n 'https://github.com/withastro/starlight' --type=tsLength of output: 192 🏁 Script executed: #!/bin/bash
# Extract repository/homepage fields from package.json
rg -n '"repository"' -n '"homepage"' -g 'package.json'
# Find any GitHub URLs in README.md
rg -n 'github\.com' -g 'README.md'Length of output: 50 🏁 Script executed: #!/bin/bash
# Locate package.json and extract repository field
pkg=$(find . -maxdepth 2 -type f -name 'package.json' | head -n1)
if [ -n "$pkg" ]; then
echo "Found package.json at $pkg"
grep -E '"repository"' -C1 "$pkg"
else
echo "package.json not found"
fiLength of output: 78 🏁 Script executed: #!/bin/bash
# Show repository.url in package.json
grep -R '"url"' -n package.jsonLength of output: 136 Use correct GitHub URL for Start UI in socials In src/content/links.ts, replace 🤖 Prompt for AI Agents |
||||||||||||||
| ], | ||||||||||||||
| }); | ||||||||||||||
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
| Original file line number | Diff line number | Diff line change | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -2,11 +2,13 @@ | |||||||||||||
| "name": "start-ui-doc", | ||||||||||||||
| "version": "0.0.1", | ||||||||||||||
| "description": "Start-UI documentation", | ||||||||||||||
| "type": "module", | ||||||||||||||
| "scripts": { | ||||||||||||||
| "dev": "next dev", | ||||||||||||||
| "build": "next build", | ||||||||||||||
| "postbuild": "next-sitemap", | ||||||||||||||
| "start": "next start" | ||||||||||||||
| "dev": "astro dev", | ||||||||||||||
| "start": "astro dev", | ||||||||||||||
| "build": "astro build", | ||||||||||||||
| "preview": "astro preview", | ||||||||||||||
| "astro": "astro" | ||||||||||||||
| }, | ||||||||||||||
| "repository": { | ||||||||||||||
| "type": "git", | ||||||||||||||
|
|
@@ -18,19 +20,8 @@ | |||||||||||||
| }, | ||||||||||||||
| "homepage": "https://docs.web.start-ui.com", | ||||||||||||||
| "dependencies": { | ||||||||||||||
| "@vercel/analytics": "1.1.1", | ||||||||||||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We need to check to setup analytics back (we should have some example with Fork It! Community website or else it's in Astro docs) |
||||||||||||||
| "next": "13.5.6", | ||||||||||||||
| "next-sitemap": "4.2.3", | ||||||||||||||
| "nextra": "2.13.2", | ||||||||||||||
| "nextra-theme-docs": "2.13.2", | ||||||||||||||
| "react": "18.2.0", | ||||||||||||||
| "react-dom": "18.2.0", | ||||||||||||||
| "react-icons": "4.12.0" | ||||||||||||||
| }, | ||||||||||||||
| "devDependencies": { | ||||||||||||||
| "@types/node": "20.8.7", | ||||||||||||||
| "@types/react": "18.2.45", | ||||||||||||||
| "@types/react-dom": "18.2.18", | ||||||||||||||
| "typescript": "5.2.2" | ||||||||||||||
| "@astrojs/starlight": "^0.36.0", | ||||||||||||||
| "astro": "^5.6.1", | ||||||||||||||
| "sharp": "^0.34.2" | ||||||||||||||
|
Comment on lines
+23
to
+25
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||
| } | ||||||||||||||
| } | ||||||||||||||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do not import SVGs in astro.config; pass public paths instead.
astro.config runs in Node, not Vite; importing
.svgwill fail. Reference public URLs.Apply:
Based on learnings
Also applies to: 15-20
🤖 Prompt for AI Agents