Skip to content

Commit bcb21bd

Browse files
committed
feat(v3): Add missing about page and WIP banner
1 parent 1a03cb7 commit bcb21bd

File tree

6 files changed

+58
-25
lines changed

6 files changed

+58
-25
lines changed

astro.config.mjs

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@
22
import { defineConfig } from "astro/config";
33
import starlight from "@astrojs/starlight";
44

5-
import logoLight from "./public/logo-light.svg";
6-
import logoDark from "./public/logo-dark.svg";
75
import { sidebar } from "./src/config/sidebar";
86
import { socials } from "./src/content/links";
97
import { head } from "./src/config/head";
@@ -14,8 +12,8 @@ export default defineConfig({
1412
starlight({
1513
title: "Start UI Documentation",
1614
logo: {
17-
dark: logoDark,
18-
light: logoLight,
15+
dark: "/public/logo-dark.svg",
16+
light: "/public/logo-light.svg",
1917
alt: "Start UI",
2018
replacesTitle: true,
2119
},

src/components/overrides/SocialIcons.astro

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,15 @@ const socials = config.social || [];
99
{
1010
extraLinks.length > 0 && (
1111
<>
12-
{extraLinks.map(({ label, href }) => (
12+
{extraLinks.map(({ label, href, isExternal }) => (
1313
<a
1414
{href}
1515
target="_blank"
1616
rel="noopenner noreferrer"
17-
class="sl-flex external-link"
17+
class={`sl-flex link ${isExternal ? "external-link" : ""}`}
1818
>
1919
{label}
20-
<Icon name="external" />
20+
{isExternal && <Icon name="external" size="1em" class="sl-ml-1" />}
2121
</a>
2222
))}
2323
</>
@@ -27,7 +27,7 @@ const socials = config.social || [];
2727
socials.length > 0 && (
2828
<>
2929
{socials.map(({ label, href, icon }) => (
30-
<a {href} rel="me" class="sl-flex">
30+
<a {href} rel="me" class={"sl-flex"}>
3131
<span class="sr-only">{label}</span>
3232
<Icon name={icon} size="1.5em" />
3333
</a>
@@ -46,6 +46,10 @@ const socials = config.social || [];
4646
a:hover {
4747
opacity: 0.66;
4848
}
49+
50+
.link {
51+
underline: none;
52+
}
4953
.external-link {
5054
display: flex;
5155
align-items: center;

src/content/docs/about.mdx

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
title: About
3+
---
4+
5+
Start UI is a set of three projects that was initiated by the [BearStudio](https://bearstudio.fr) Team
6+
and in particular by [Ivan Dalmet](https://mobile.twitter.com/ivandalmet).
7+
The purpose of those projects is to make it easier and faster to reach the business features development time on a new project,
8+
that is to say, stop wasting time putting together the standard technologies and tooling, and having a starter for it.
9+
10+
Here are the three projects:
11+
- [[web]](https://github.com/bearstudio/start-ui-web), which is the web starter related to this documentation
12+
- [[native]](https://github.com/BearStudio/start-ui-native), which is a React Native starter that basically does the same
13+
as the web starter but for mobile applications made with React Native.
14+
- [[figma]](https://www.figma.com/community/file/1025698982013308087), which is a Figma template that contains the same components
15+
as the web starter, which will allow you to create mockups with the components you'll find in the web starter.

src/content/docs/index.mdx

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,16 @@
11
---
22
title: Introduction
33
description: Get started building your app with Start UI.
4+
banner:
5+
content: |
6+
<a
7+
href="https://github.com/bearstudio/start-ui-web-doc"
8+
target="_blank"
9+
rel="noreferrer"
10+
>
11+
🚀 Start UI [web]'s documentation is still in progress. Feel free to
12+
give feedback or contribute ↗
13+
</a>
414
---
515

616
🚀 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.

src/content/links.ts

Lines changed: 0 additions & 17 deletions
This file was deleted.

src/content/links.tsx

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
import { Icon } from "@astrojs/starlight/components";
2+
3+
export const socials = [
4+
{
5+
icon: "github",
6+
label: "GitHub",
7+
href: "https://github.com/BearStudio/start-ui-web-docs/",
8+
},
9+
{
10+
icon: "discord",
11+
label: "Discord",
12+
href: "https://go.bearstudio.fr/discord",
13+
},
14+
] as const;
15+
16+
export const extraLinks = [
17+
{
18+
label: "Contact",
19+
href: "https://twitter.com/startui_",
20+
isExternal: true,
21+
},
22+
{ label: "About", href: "about" },
23+
];

0 commit comments

Comments
 (0)