fulldev-ui 0.5.0-beta.4 → 0.5.0-beta.5

package/src/content/pages/overview/content-collections.mdx

@@ -0,0 +1,139 @@
+---
+presets: [docs]
+title: Content Collections
+---
+
+import Link from 'fulldev-ui/components/Link.astro'
+
+# Content Collections
+
+We utilize <Link href="https://docs.astro.build/docs/guides/content-collections/">Astro's Content Layer</Link> to create entire websites using just content files and our components.
+
+## Starter Template
+
+This is the recommended way to get started with our content layer integration. We've created a <Link href="https://github.com/fulldotdev/starter/tree/main">starter template</Link> with examples of everything you need to get started.
+
+```bash
+pnpm create astro@latest -- --template fulldotdev/starter
+```
+
+## Manual Setup
+
+To get started with the manual setup, you need to install the <Link href="/overview/installation/">integration</Link> and add `injectRoutes: true` to your `astro.config.ts` file, see <Link href="#type-safe-frontmatter">frontmatter</Link> below for more information on how this generates a site using content files.
+
+```ts
+import { defineConfig } from 'astro/config'
+import fulldev from 'fulldev-ui/integration'
+
+// https://astro.build/config
+export default defineConfig({
+  integrations: [
+    fulldev({
+      // other options
+      injectRoutes: true,
+    }),
+  ],
+})
+```
+
+## Type-safe frontmatter
+
+Each file has a few frontmatter objects that are important to know about. Seo has priority over title and description, however title and description is used in multiple places like a card.
+
+```yml
+---
+preset: [docs] # Applies the configuration from src/content/presets/docs.yml
+component: DocsLayout
+
+seo:
+  title: Page Title
+  description: This is my page description
+  image: /image.jpg # Open Graph Image
+
+# Information on the page, this is used in places like card, sidebar, etc.
+title: Page Title
+description: This is my page description
+
+sections: # Here you generate the page by adding a component and passing props
+  - component: Hero
+    heading: Page Title
+    text: This is my page description
+    buttons:
+      - text: Button
+        color: brand
+        href: /
+      - text: Button
+        href: /
+---
+# This is the prose, you can use markdown here
+```
+
+For all objects avaliable in the Content Layer, see the <Link href="https://ui.full.dev/schemas/page/">schemas</Link>.
+
+### Presets
+
+Presets are configuration files that can be used to set the default values for a page. They are located in the **src/content/presets** directory and you can use them by adding the `preset` property to the frontmatter of a page or add a `basePreset` to the integration setup in the `astro.config.ts` file.
+
+```ts
+import { defineConfig } from 'astro/config'
+import fulldev from 'fulldev-ui/integration'
+
+// https://astro.build/config
+export default defineConfig({
+  integrations: [
+    fulldev({
+      // other options
+      basePreset: 'base', // Applies the configuration from src/content/presets/base.yml to every page
+    }),
+  ],
+})
+```
+
+## i18n
+
+Getting started with i18n is easy, you can easily add additional languages by creating a new folder named after a language code in the **content/pages** directory and adding your content files in the new language.
+
+These pages are just as static as the others however you can merge them with the default language by adding the `i18n` key to the frontmatter.
+
+By merging pages you only need to specify the content that is different for the new language. Things like images do not need to be repeated in these new files. See example:
+
+content/pages/index.md:
+
+```md
+---
+sections:
+  - component: Hero
+    image: /image.webp
+    heading: Page Title
+    text: This is my page description
+---
+```
+
+content/pages/nl/index.md:
+
+```md
+---
+i18n: index
+
+sections:
+  - component: Hero
+    heading: Page Title
+    text: This is my page description
+---
+```
+
+These return the same results
+
+### Example structure
+
+```bash
+.
+├── src/
+│   ├── content/
+│   │   ├── pages/
+│   │   │   ├── index.md
+│   │   │   ├── nl/
+│   │   │   │   └── index.md
+│   │   │   └── de/
+│   │   │   │   └── index.md
+```

package/src/content/pages/overview/installation.mdx

@@ -7,7 +7,21 @@ import Link from 'fulldev-ui/components/Link.astro'
 
 # Installation
 
-Install fulldev-ui with your favorite package manager and you are ready to go.
+You can add fulldev-ui to your project, or use the starter template.
+
+## Add to existing project
+
+### Automatic setup
+
+Use the astro add command to automatically install the dependencies and add the integration.
+
+```bash
+npx astro add fulldev-ui
+```
+
+## Manual installation
+
+Install fulldev-ui with your favorite package manager.
 
 ```bash
 pnpm i fulldev-ui
@@ -19,36 +33,21 @@ yarn add fulldev-ui
 npm i fulldev-ui
 ```
 
-## Integration
-
-To install the integration, import it in your `astro.config.ts` file.
-You can optionally add a custom css file and define custom colors and other theming options, see the <Link href="/overview/customization/">customization documentation</Link> for more information.
-
-To get started with the content layer, see the <Link href="/overview/content-layer/#manual-setup">content layer documentation</Link>.
+Then setup the integration in your `astro.config.ts` file.
 
 ```ts
 import { defineConfig } from 'astro/config'
 import fulldev from 'fulldev-ui/integration'
 
-// https://astro.build/config
 export default defineConfig({
-  integrations: [
-    fulldev({
-      css: '/src/css/custom.css',
-      colors: {
-        theme: 'dark',
-        dark: {
-          background: '#111110',
-          base: '#6F6D66',
-          brand: '#F50',
-        },
-        light: {
-          background: '#EEEEEC',
-          base: '#6F6D66',
-          brand: '#F50',
-        },
-      },
-    }),
-  ],
+  integrations: [fulldev()],
 })
 ```
+
+## Using the starter template
+
+The easiest way to get started is to use the [starter template](https://github.com/fulldotdev/starter).
+
+```bash
+pnpm create astro@latest -- --template fulldotdev/starter
+```

package/src/content/pages/overview/introduction.mdx

@@ -5,20 +5,26 @@ title: Introduction
 
 # Introduction
 
-Fulldev UI focuses on content websites rather than applications.
+**Fulldev UI** is a full-featured UI library and website theme built on the [Astro](https://astro.build/) framework. Whether starting a new project or enhancing an existing one, this guide will help you get set up. For installation details, see the [installation guide](/getting-started/installation).
 
-##### Build entire websites with just components
+## Why we built it
 
-Fulldev UI is unique in that it introduces larger components to build entire pages, and even websites. Like a Section component that just works.
+We built **Fulldev UI** after repeatedly encountering the same challenges in client projects, covering the core needs of content-focused websites. Initially created for [our own company](https://full.dev), we decided to open-source it for others to use.
 
-##### Integrates with any JS / CSS framework
+## Some features
 
-Want to use Tailwind, or something else? You can overwrite all styles. Need an interactive framework component? Styles can be applied with one simple class.
+- Vanilla HTML and CSS.
+- Seamless integration with TailwindCSS and UnoCSS.
+- Minimal JavaScript.
+- Supports Astro's [Content Collections](https://docs.astro.build/en/guides/content-collections/).
+- Customizable via CSS variables.
+- Reusable components for pages and sections.
+- Includes blocks like Hero, CTA, Features, etc.
+- Page-building tools.
+- And more...
 
-##### Automated colors, spacing and sizes
+## A word of caution
 
-Everything is carefully designed to be fully responsive. Component adapt to their environment, like a Heading being different in a Section than in a Card. You can also customize via simple props.
+**Fulldev UI** includes a wide range of features, some still experimental. While a narrower focus would improve stability, we built it for flexibility in our projects.
 
-##### Content layer
-
-Build entire websites using just content files like Markdown using our components, blocks and layouts.
+This isn't just a single-purpose library; it's a framework for building blog, marketing, and portfolio websites—similar to how [Starlight](https://starlight.astro.build/) serves documentation. As it evolves, its focus will sharpen. In the meantime, feel free to use it and share feedback on [Discord](https://discord.gg/fulldev)!

package/src/content/pages/overview/theming.mdx

@@ -0,0 +1,69 @@
+---
+presets: [docs]
+title: Theming
+---
+
+import Link from 'fulldev-ui/components/Link.astro'
+
+# Theming
+
+With the fulldev-ui integration you can easily set a theme and generate a palette based on <Link href="https://www.radix-ui.com/colors">Radix Colors.</Link>
+
+## Configuration
+
+### Generating a color palette
+
+- **css** is the path to your custom css file that applies to all pages on your site.
+- **colors** is an object that defines the colors for your site.
+  - **theme** is the default theme for your site.
+  - **dark** and **light** are objects that define the colors for the dark and light themes, these three properties are used to generate a color pallete using radix colors.
+
+```ts
+import { defineConfig } from 'astro/config'
+import fulldev from 'fulldev-ui/integration'
+
+// https://astro.build/config
+export default defineConfig({
+  integrations: [
+    fulldev({
+      css: '/src/css/custom.css',
+      colors: {
+        theme: 'dark',
+        dark: {
+          background: '#111110',
+          base: '#6F6D66',
+          brand: '#F50',
+        },
+        light: {
+          background: '#EEEEEC',
+          base: '#6F6D66',
+          brand: '#F50',
+        },
+      },
+    }),
+  ],
+})
+```
+
+### Generating favicons
+
+We've integrated <Link href="https://github.com/ACP-CODE/astro-favicons">astro-favicons</Link> into fulldev-ui to generate favicons from a svg file.
+
+```ts
+import { defineConfig } from 'astro/config'
+import fulldev from 'fulldev-ui/integration'
+
+// https://astro.build/config
+export default defineConfig({
+  integrations: [
+    fulldev({
+      favicon: 'src/images/favicon.svg', // can also be png, webp, jpg, etc.
+      // other options here
+    }),
+  ],
+})
+```
+
+## Overwriting styles
+
+Since Fulldev UI uses just regular CSS with low specificity, you can customize anything else using custom CSS.

package/src/content/pages/schemas/page.mdx

@@ -9,3 +9,9 @@ title: page
 Objects in the page schema are used to define the structure of a page. They are used to define the information, content and components that are used to render the page.
 
 import { Code } from 'astro:components'
+import { zodToTs, createTypeAlias, printNode } from 'zod-to-ts'
+import pageSchema from 'fulldev-ui/schemas/pageSchema'
+
+export const identifier = 'Page'
+export const node = zodToTs(pageSchema, identifier)
+export const typeAlias = createTypeAlias(node, identifier)

package/src/content/presets/base.yml

@@ -1,3 +1,5 @@
+theme: dark
+
 seo:
   image: /images/og-image.png
 
@@ -8,11 +10,9 @@ code:
       posthog.init('phc_mVacbe8Xydu0UZlh4bNw5EGisvzyRcpqXEEuEEp5lOY',{api_host:'https://eu.i.posthog.com', person_profiles: 'identified_only' // or 'always' to create profiles for anonymous users as well
         })
     </script>
-sidebar: true
-toc: false
-themeselect: true
-
-header:
+header: true
+navigation:
+  cart: Winkelwagen
   company: Fulldev UI
   buttons:
     - text: Docs
@@ -30,41 +30,55 @@ header:
       target: _blank
       icon: brand-discord
       variant: secondary
-# footer:
-#   logo: Fulldev UI
-#   text: The Astro UI library to build content sites. Make websites with prebuilt components, blocks and layouts.
-#   columns:
-#     - heading: Pages
-#       buttons:
-#         - text: Docs
-#           href: /overview/introduction
-#         - text: Components
-#           href: /typography/heading
-#         - blocks
-#         - showcase
-#   socials:
-#     - https://www.linkedin.com/in/silveltman/
-#     - https://x.com/silveltm
-#     - https://github.com/fulldotdev/ui
-#   channels:
-#     - heading: Phone
-#       text: 123-456-7890
-#       icon: phone
-#       href: tel:123-456-7890
-#     - heading: Email
-#       text: contact@example.com
-#       icon: mail
-#       href: mailto:contact@example.com
-#     - heading: Address
-#       text: 1234 Main St, Springfield, IL 62701
-#       icon: map-pin
-#   hours:
-#     heading: Openingstijden
-#     days:
-#       ma.: 09:00 - 17:00
-#       di.: 09:00 - 17:00
-#       wo.: 09:00 - 17:00
-#       do.: 09:00 - 17:00
-#       vr.: 09:00 - 17:00
-#       za.: 09:00 - 17:00
-#       zo.: 09:00 - 17:00
+  menu:
+    - heading: Get Started
+      buttons:
+        - overview/introduction
+        - overview/installation
+        - overview/theming
+        - overview/frameworks
+        - overview/components
+        - overview/content-collections
+    - heading: Typography
+      buttons:
+        - typography/heading
+        - typography/label
+        - typography/link
+        - typography/list
+        - typography/text
+    - heading: Base
+      buttons:
+        - base/badge
+        - base/button
+        - base/card
+        - base/checkbox
+        - base/icon
+        - base/input
+        - base/rating
+        - base/section
+        - base/select
+        - base/table
+        - base/textarea
+        - base/theme-select
+        - base/image
+    - heading: Blocks
+      buttons:
+        - blocks/banner
+        - blocks/colleagues
+        - blocks/contact
+        - blocks/content
+        - blocks/cta
+        - blocks/features
+        - blocks/hero
+        - blocks/intro
+        - blocks/posts
+        - blocks/reviews
+    - heading: Schemas
+      buttons:
+        - schemas/page
+        - schemas/preset
+    - heading: More
+      buttons:
+        - showcase
+        - text: Changelog
+          href: https://github.com/fulldotdev/ui/releases

package/src/content/presets/blocks.yml

@@ -1,4 +1 @@
 component: BlockLayout
-
-navigation:
-  toc: false

package/src/content/presets/docs.yml

@@ -1,65 +1,6 @@
 component: DocsLayout
+presets: [base]
 
 sidebar: true
 header: false
-banner: false
-toc: true
-
-navigation:
-  company: Fulldev UI
-  buttons:
-    - heading: Get Started
-      buttons:
-        - overview/introduction
-        - overview/installation
-        - overview/customization
-        - overview/frameworks
-        - overview/components
-        - overview/content-layer
-    - heading: Typography
-      buttons:
-        - typography/heading
-        - typography/label
-        - typography/link
-        - typography/list
-        - typography/text
-    - heading: Base
-      buttons:
-        - base/badge
-        - base/button
-        - base/card
-        - base/checkbox
-        - base/icon
-        - base/input
-        - base/rating
-        - base/section
-        - base/select
-        - base/table
-        - base/textarea
-        - base/theme-select
-        - base/image
-    - heading: Blocks
-      buttons:
-        - blocks/banner
-        - blocks/colleagues
-        - blocks/contact
-        - blocks/content
-        - blocks/cta
-        - blocks/features
-        - blocks/hero
-        - blocks/intro
-        - blocks/posts
-        - blocks/reviews
-    # - heading: Layouts
-    #   buttons:
-    #     - layouts/layout
-    #     - layouts/docslayout
-    - heading: Schemas
-      buttons:
-        - schemas/page
-        - schemas/preset
-    - heading: More
-      buttons:
-        - showcase
-        - text: Changelog
-          href: https://github.com/fulldotdev/ui/releases
+toc: 'On this page'

package/src/layouts/Layout.astro

@@ -57,22 +57,27 @@ const {
 <!doctype html>
 <html {...rest}>
   <Head {...Astro.props} />
-  <Element as="body">
+  <Element
+    as="body"
+    {theme}
+  >
     <slot name="banner">
       <Banner text={banner} />
     </slot>
     <slot name="header">
       <Header
-        open={header}
+        class:list={{
+          'for-sidebar': sidebar,
+        }}
+        if={navigation || header}
         {...navigation}
-        {themeselect}
         {...header}
       />
     </slot>
     <div class="core">
       <slot name="sidebar">
         <Sidebar
-          open={sidebar}
+          if={sidebar}
           {...navigation}
           {...sidebar}
         />
@@ -84,14 +89,10 @@ const {
         </slot>
       </main>
       <slot name="toc">
-        {
-          toc && (
-            <Toc
-              {render}
-              {...toc}
-            />
-          )
-        }
+        <Toc
+          heading={toc}
+          {render}
+        />
       </slot>
     </div>
     <slot name="footer">
@@ -114,12 +115,21 @@ const {
           --screen: 100vw;
           display: flex;
           flex-direction: column;
-
-          background-color: var(--base-2);
+          background-color: var(--base-background);
           width: 100%;
           min-height: 100vh;
           color: var(--base-11);
 
+          .for-sidebar {
+            @media (min-width: 1024px) {
+              display: none;
+
+              ~ * {
+                --header-height: 0px;
+              }
+            }
+          }
+
           .core {
             display: flex;
             position: relative;

package/src/layouts/PostLayout.astro

@@ -0,0 +1,24 @@
+---
+import type { ComponentProps } from 'astro/types'
+import Article from 'fulldev-ui/blocks/Article.astro'
+import Sections from 'fulldev-ui/components/sections.astro'
+import Layout from 'fulldev-ui/layouts/Layout.astro'
+import Excerpt from '../blocks/Excerpt.astro'
+
+type Props = ComponentProps<typeof Layout>
+
+const { sections, title, description, ...rest } = Astro.props
+---
+
+<Layout {...Astro.props}>
+  <Excerpt
+    heading={title}
+    align="start"
+    text={description}
+    style={{ '--screen': '768px' }}
+    {...rest}
+  />
+  <Article />
+  <Sections {sections} />
+  <slot />
+</Layout>

package/src/layouts/ProductLayout.astro

@@ -1,7 +1,7 @@
 ---
 import type { ComponentProps } from 'astro/types'
 import Article from 'fulldev-ui/blocks/Article.astro'
-import Product from 'fulldev-ui/blocks/Product.astro'
+import Section from 'fulldev-ui/components/Section.astro'
 import Sections from 'fulldev-ui/components/sections.astro'
 import Layout from 'fulldev-ui/layouts/Layout.astro'
 
@@ -11,7 +11,10 @@ const { render, sections, ...rest } = Astro.props
 ---
 
 <Layout {...Astro.props}>
-  <Product {...rest} />
+  <Section
+    component="Product"
+    {...rest as any}
+  />
   <Article />
   <Sections {sections} />
   <slot />

package/src/schemas/components/header.ts

@@ -2,12 +2,10 @@ import { z } from 'astro:content'
 import buttons from './buttons'
 import logo from './logo'
 
-export default z.boolean().or(
-  z
-    .object({
-      logo,
-      buttons,
-    })
-    .partial()
-    .passthrough()
-)
+export default z
+  .object({
+    logo,
+    buttons,
+  })
+  .partial()
+  .passthrough()

package/src/schemas/components/menu.ts

@@ -0,0 +1,13 @@
+import { z } from 'astro:content'
+import buttons from './buttons'
+import heading from './heading'
+
+export default z.array(
+  z
+    .object({
+      heading,
+      buttons,
+    })
+    .partial()
+    .passthrough()
+)