Skip to content
Closed
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
Binary file modified .github/assets/thumbnail.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 removed .github/screenshot.png
Binary file not shown.
26 changes: 21 additions & 5 deletions .gitignore
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
4 changes: 4 additions & 0 deletions .vscode/extensions.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"recommendations": ["astro-build.astro-vscode"],
"unwantedRecommendations": []
}
11 changes: 11 additions & 0 deletions .vscode/launch.json
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"
}
]
}
21 changes: 0 additions & 21 deletions LICENSE

This file was deleted.

15 changes: 1 addition & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@
🚀 Start UI <small>[web]</small> is an opinionated frontend starter repository created & maintained by the [BearStudio Team](https://www.bearstudio.fr/team) and other contributors.
It represents our team's up-to-date stack that we use when creating web apps for our clients.


# Contribution

## Getting Started
Expand Down Expand Up @@ -43,18 +42,6 @@ Here is a tutorial for make perfect screenshots for this documentation (with Goo

Some components have been developed and could be used in documentation pages.

### `ImageTabs`

A component to display images as content of Nextra Tabs component. It is used to display screenshots as desktop or mobile version.

### `Stack`

Flex container that allows to define direction and gap.

### `ResponsiveStack`

Horizontal Stack which will become vertical when the device width is lower than breakpoint prop (default is to 768px)

### `WorkInProgress`

Component based on Nextra Callout, to warn user that a page is not yet written.
Component based on Starlight Aside, to warn user that a page is not yet written.
37 changes: 37 additions & 0 deletions astro.config.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
// @ts-check
import { defineConfig } from "astro/config";
import starlight from "@astrojs/starlight";

import { sidebar } from "./src/config/sidebar";
import { socials } from "./src/content/links";
import { head } from "./src/config/head";

// https://astro.build/config
export default defineConfig({
integrations: [
starlight({
title: "Start UI Documentation",
logo: {
dark: "/public/logo-dark.svg",
light: "/public/logo-light.svg",
alt: "Start UI",
replacesTitle: true,
},
favicon: "/favicon.ico",

head,
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
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

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

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
editLink: {
baseUrl: "https://github.com/BearStudio/start-ui-web-docs/blob/main",
},
editLink: {
baseUrl: "https://github.com/BearStudio/start-ui-web-docs/edit/main",
},
🤖 Prompt for AI Agents
In astro.config.mjs around lines 26 to 28, the editLink.baseUrl currently points
to the repository viewer URL (/blob/main) which opens the file viewer instead of
the editor; change the baseUrl to use the editor path (/edit/main) so edit links
open GitHub's editor (e.g., replace "/blob/main" with "/edit/main") and keep the
same repo path and branch.


credits: true,
customCss: ["./src/styles/app.css"],
social: socials,
sidebar,
}),
],
});
74 changes: 0 additions & 74 deletions components/FileTree.tsx

This file was deleted.

55 changes: 0 additions & 55 deletions components/ImageTabs.tsx

This file was deleted.

27 changes: 0 additions & 27 deletions components/ResponsiveStack.tsx

This file was deleted.

17 changes: 0 additions & 17 deletions components/Stack.tsx

This file was deleted.

15 changes: 0 additions & 15 deletions components/WorkInProgress.tsx

This file was deleted.

5 changes: 0 additions & 5 deletions next-env.d.ts

This file was deleted.

8 changes: 0 additions & 8 deletions next-sitemap.config.js

This file was deleted.

7 changes: 0 additions & 7 deletions next.config.js

This file was deleted.

27 changes: 9 additions & 18 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand All @@ -18,19 +20,8 @@
},
"homepage": "https://docs.web.start-ui.com",
"dependencies": {
"@vercel/analytics": "1.1.1",
Copy link
Member

Choose a reason for hiding this comment

The 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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"@astrojs/starlight": "^0.36.0",
"astro": "^5.6.1",
"sharp": "^0.34.2"
"@astrojs/starlight": "0.36.0",
"astro": "5.6.1",
"sharp": "0.34.2"

}
}
Loading