Skip to content
Merged
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
4 changes: 4 additions & 0 deletions .changeset/docs-markdown-and-name.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
---

Serve the documentation website's pages as Markdown, name the site Sitex throughout, let browsers keep its build files, and move the component documentation to Fulldev UI's React components.
34 changes: 3 additions & 31 deletions apps/docs/src/globals/index.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Sitex Docs
name: Sitex
logo:
label: Sitex
href: /
Expand All @@ -22,33 +22,5 @@ sidebar:
label: Pages
- href: /docs/layouts
label: Layouts
- href: /docs/components
label: Components
- label: Components
links:
- href: /docs/components/banner
label: Banner
- href: /docs/components/code
label: Code
- href: /docs/components/gradient
label: Gradient
- href: /docs/components/header
label: Header
- href: /docs/components/layout
label: Layout
- href: /docs/components/marquee
label: Marquee
- href: /docs/components/price
label: Price
- href: /docs/components/rating
label: Rating
- href: /docs/components/section
label: Section
- href: /docs/components/theme-toggle
label: Theme Toggle
- href: /docs/components/tile
label: Tile
- href: /docs/components/toc
label: Toc
- href: /docs/components/typography
label: Typography
- href: /docs/rendering
label: Rendering
4 changes: 3 additions & 1 deletion apps/docs/src/layouts/base.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ import { Posthog } from "@/components/posthog"
import { Sidebar1 } from "@/components/blocks/sidebar-1"
import { ThemeScript } from "@/components/ui/theme-toggle"
import { globals } from "@/lib/globals"
import { markdownPath } from "@/lib/markdown"
import { theme } from "@/lib/theme"

export type BaseLayoutProps = LayoutHeadProps & {
Expand All @@ -41,14 +42,15 @@ export default function BaseLayout({
image={
head.image || {
src: "https://sitex.full.dev/social.png",
alt: "SiteX",
alt: globals.name,
width: 1200,
height: 630,
type: "image/png",
}
}
>
<ThemeScript {...theme} />
<link rel="alternate" type="text/markdown" href={markdownPath(path)} />
</LayoutHead>
<LayoutBody>
<Sidebar1
Expand Down
7 changes: 5 additions & 2 deletions apps/docs/src/layouts/home.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import type { WebSite, WithContext } from "schema-dts"
import { Features1 } from "@/components/blocks/features-1"
import { Hero1 } from "@/components/blocks/hero-1"
import BaseLayout from "@/layouts/base"
import { globals } from "@/lib/globals"

type HomeData = {
hero: {
Expand All @@ -30,13 +31,15 @@ export default function HomeLayout({
type,
updatedAt,
}: LayoutProps<HomeData>) {
// Fulldev made Sitex; as creator rather than publisher it does not read
// as a second name for the site itself.
const website: WithContext<WebSite> = {
"@context": "https://schema.org",
"@type": "WebSite",
name: title,
name: globals.name,
description,
url,
publisher: {
creator: {
"@type": "Organization",
name: "Fulldev",
url: "https://full.dev",
Expand Down
3 changes: 3 additions & 0 deletions apps/docs/src/lib/markdown.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
/** A page's Markdown version: /docs/pages at /docs/pages.md, the homepage at /index.md. */
export const markdownPath = (path: string) =>
`${path.replace(/\/$/, "") || "/index"}.md`
58 changes: 0 additions & 58 deletions apps/docs/src/pages/docs/components.mdx

This file was deleted.

38 changes: 0 additions & 38 deletions apps/docs/src/pages/docs/components/banner.mdx

This file was deleted.

48 changes: 0 additions & 48 deletions apps/docs/src/pages/docs/components/code.mdx

This file was deleted.

40 changes: 0 additions & 40 deletions apps/docs/src/pages/docs/components/gradient.mdx

This file was deleted.

44 changes: 0 additions & 44 deletions apps/docs/src/pages/docs/components/header.mdx

This file was deleted.

58 changes: 0 additions & 58 deletions apps/docs/src/pages/docs/components/layout.mdx

This file was deleted.

Loading
Loading