npm - create-ardo - Versions diffs - 1.2.2 → 2.0.0 - Mend

create-ardo 1.2.2 → 2.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (19) hide show

package/package.json +1 -1
package/templates/minimal/.github/workflows/deploy.yml +1 -1
package/templates/minimal/_gitignore +3 -5
package/templates/minimal/app/entry.client.tsx +12 -0
package/templates/minimal/app/entry.server.tsx +34 -0
package/templates/minimal/app/root.tsx +59 -0
package/templates/minimal/{content/guide/getting-started.md → app/routes/guide/getting-started.mdx} +1 -1
package/templates/minimal/app/routes/home.tsx +36 -0
package/templates/minimal/app/routes.ts +6 -0
package/templates/minimal/app/vite-env.d.ts +13 -0
package/templates/minimal/package.json +7 -6
package/templates/minimal/react-router.config.ts +6 -0
package/templates/minimal/tsconfig.json +2 -2
package/templates/minimal/content/index.md +0 -18
package/templates/minimal/src/router.tsx +0 -18
package/templates/minimal/src/routes/__root.tsx +0 -34
package/templates/minimal/src/routes/guide/_layout.tsx +0 -19
package/templates/minimal/src/routes/index.tsx +0 -40
package/templates/minimal/src/vite-env.d.ts +0 -23

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "create-ardo",
-  "version": "1.2.2",
+  "version": "2.0.0",
   "description": "Scaffolding tool for Ardo documentation projects",
   "type": "module",
   "bin": {

package/templates/minimal/.github/workflows/deploy.yml CHANGED Viewed

@@ -42,7 +42,7 @@ jobs:
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v4
         with:
-          path: dist/client
+          path: build/client
   deploy:
     environment:

package/templates/minimal/_gitignore CHANGED Viewed

@@ -1,9 +1,7 @@
 node_modules
-dist
+build
 .DS_Store
 *.local
-# Auto-generated by ardo (content routes derived from markdown)
-src/routes/guide/*.tsx
-!src/routes/guide/_layout.tsx
-src/routeTree.gen.ts
+# React Router generated files
+.react-router

package/templates/minimal/app/entry.client.tsx ADDED Viewed

@@ -0,0 +1,12 @@
+import { startTransition, StrictMode } from "react"
+import { hydrateRoot } from "react-dom/client"
+import { HydratedRouter } from "react-router/dom"
+startTransition(() => {
+  hydrateRoot(
+    document,
+    <StrictMode>
+      <HydratedRouter />
+    </StrictMode>
+  )
+})

package/templates/minimal/app/entry.server.tsx ADDED Viewed

@@ -0,0 +1,34 @@
+import type { EntryContext } from "react-router"
+import { ServerRouter } from "react-router"
+import { renderToReadableStream } from "react-dom/server"
+import { isbot } from "isbot"
+export default async function handleRequest(
+  request: Request,
+  responseStatusCode: number,
+  responseHeaders: Headers,
+  routerContext: EntryContext
+) {
+  const userAgent = request.headers.get("user-agent")
+  const stream = await renderToReadableStream(
+    <ServerRouter context={routerContext} url={request.url} />,
+    {
+      onError(error: unknown) {
+        console.error(error)
+        responseStatusCode = 500
+      },
+    }
+  )
+  if (userAgent && isbot(userAgent)) {
+    await stream.allReady
+  }
+  responseHeaders.set("Content-Type", "text/html")
+  return new Response(stream, {
+    status: responseStatusCode,
+    headers: responseHeaders,
+  })
+}

package/templates/minimal/app/root.tsx ADDED Viewed

@@ -0,0 +1,59 @@
+import { Links, Meta, Outlet, Scripts, ScrollRestoration, useLocation } from "react-router"
+import { Layout, Header, Nav, NavLink, Sidebar, SidebarGroup, SidebarLink, Footer } from "ardo/ui"
+import { PressProvider } from "ardo/runtime"
+import config from "virtual:ardo/config"
+import sidebar from "virtual:ardo/sidebar"
+import "ardo/ui/styles.css"
+export function Layout({ children }: { children: React.ReactNode }) {
+  return (
+    <html lang="en" suppressHydrationWarning>
+      <head>
+        <meta charSet="utf-8" />
+        <meta name="viewport" content="width=device-width, initial-scale=1" />
+        <Meta />
+        <Links />
+      </head>
+      <body suppressHydrationWarning>
+        {children}
+        <ScrollRestoration />
+        <Scripts />
+      </body>
+    </html>
+  )
+}
+export default function Root() {
+  const location = useLocation()
+  const isHomePage = location.pathname === "/"
+  return (
+    <PressProvider config={config} sidebar={sidebar}>
+      <Layout
+        className={isHomePage ? "ardo-layout ardo-home" : "ardo-layout"}
+        header={
+          <Header
+            title="{{SITE_TITLE}}"
+            nav={
+              <Nav>
+                <NavLink to="/guide/getting-started">Guide</NavLink>
+              </Nav>
+            }
+          />
+        }
+        sidebar={
+          isHomePage ? undefined : (
+            <Sidebar>
+              <SidebarGroup title="Guide">
+                <SidebarLink to="/guide/getting-started">Getting Started</SidebarLink>
+              </SidebarGroup>
+            </Sidebar>
+          )
+        }
+        footer={<Footer message="Built with Ardo" />}
+      >
+        <Outlet />
+      </Layout>
+    </PressProvider>
+  )
+}

package/templates/minimal/{content/guide/getting-started.md → app/routes/guide/getting-started.mdx} RENAMED Viewed

@@ -21,7 +21,7 @@ pnpm preview
 ## Adding Content
-Create `.md` or `.mdx` files in the `content/` directory. They will automatically become pages.
+Create `.md` or `.mdx` files in the `app/routes/` directory. They will automatically become pages.
 ## Configuration

package/templates/minimal/app/routes/home.tsx ADDED Viewed

@@ -0,0 +1,36 @@
+import { Hero, Features } from "ardo/ui"
+export default function HomePage() {
+  return (
+    <>
+      <Hero
+        name="{{SITE_TITLE}}"
+        text="Documentation Made Simple"
+        tagline="Focus on your content, not configuration"
+        actions={[
+          { text: "Get Started", link: "/guide/getting-started", theme: "brand" },
+          { text: "GitHub", link: "https://github.com", theme: "alt" },
+        ]}
+      />
+      <Features
+        items={[
+          {
+            title: "Fast",
+            icon: "⚡",
+            details: "Lightning fast builds with Vite",
+          },
+          {
+            title: "Simple",
+            icon: "✨",
+            details: "Easy to set up and use",
+          },
+          {
+            title: "Flexible",
+            icon: "🎨",
+            details: "Fully customizable theme",
+          },
+        ]}
+      />
+    </>
+  )
+}

package/templates/minimal/app/routes.ts ADDED Viewed

@@ -0,0 +1,6 @@
+import { type RouteConfig, index, route } from "@react-router/dev/routes"
+export default [
+  index("routes/home.tsx"),
+  route("guide/getting-started", "routes/guide/getting-started.mdx"),
+] satisfies RouteConfig

package/templates/minimal/app/vite-env.d.ts ADDED Viewed

@@ -0,0 +1,13 @@
+/// <reference types="vite/client" />
+declare module "virtual:ardo/config" {
+  import type { PressConfig } from "ardo"
+  const config: PressConfig
+  export default config
+}
+declare module "virtual:ardo/sidebar" {
+  import type { SidebarItem } from "ardo"
+  const sidebar: SidebarItem[]
+  export default sidebar
+}

package/templates/minimal/package.json CHANGED Viewed

@@ -4,18 +4,19 @@
   "private": true,
   "type": "module",
   "scripts": {
-    "dev": "vite",
-    "build": "vite build",
+    "dev": "react-router dev",
+    "build": "react-router build",
     "preview": "vite preview"
   },
   "dependencies": {
-    "@tanstack/react-router": "*",
-    "@tanstack/react-start": "*",
-    "ardo": "^1.1.1",
+    "ardo": "^1.2.0",
+    "isbot": "*",
     "react": "*",
-    "react-dom": "*"
+    "react-dom": "*",
+    "react-router": "*"
   },
   "devDependencies": {
+    "@react-router/dev": "*",
     "@types/react": "^19.2.10",
     "@types/react-dom": "^19.2.3",
     "typescript": "^5.9.3",

package/templates/minimal/react-router.config.ts ADDED Viewed

@@ -0,0 +1,6 @@
+import type { Config } from "@react-router/dev/config"
+export default {
+  ssr: false,
+  prerender: true,
+} satisfies Config

package/templates/minimal/tsconfig.json CHANGED Viewed

@@ -13,6 +13,6 @@
     "forceConsistentCasingInFileNames": true,
     "jsx": "react-jsx"
   },
-  "include": ["src/**/*", "*.ts", "*.config.ts"],
-  "exclude": ["node_modules", "dist"]
+  "include": ["app/**/*", "*.ts", "*.config.ts"],
+  "exclude": ["node_modules", "build"]
 }

package/templates/minimal/content/index.md DELETED Viewed

@@ -1,18 +0,0 @@
----
-title: Welcome
-hero:
-  name: '{{SITE_TITLE}}'
-  text: Documentation Made Simple
-  tagline: Focus on your content, not configuration
-  actions:
-    - text: Get Started
-      link: /guide/getting-started
-      theme: brand
-features:
-  - title: Zero Config
-    details: Just write markdown. No framework knowledge required.
-  - title: Fast
-    details: Powered by Vite and React 19.
-  - title: Beautiful
-    details: Clean design out of the box.
----

package/templates/minimal/src/router.tsx DELETED Viewed

@@ -1,18 +0,0 @@
-import { createRouter } from '@tanstack/react-router'
-import { routeTree } from './routeTree.gen'
-export function getRouter() {
-  return createRouter({
-    routeTree,
-    scrollRestoration: true,
-    defaultPreloadStaleTime: 0,
-  })
-}
-export type AppRouter = ReturnType<typeof getRouter>
-declare module '@tanstack/react-router' {
-  interface Register {
-    router: AppRouter
-  }
-}

package/templates/minimal/src/routes/__root.tsx DELETED Viewed

@@ -1,34 +0,0 @@
-import { createRootRoute, HeadContent, Outlet, Scripts } from '@tanstack/react-router'
-import config from 'virtual:ardo/config'
-import 'ardo/theme/styles.css'
-export const Route = createRootRoute({
-  head: () => ({
-    meta: [
-      { charSet: 'utf-8' },
-      { name: 'viewport', content: 'width=device-width, initial-scale=1' },
-      { title: config.title },
-      { name: 'description', content: config.description },
-    ],
-  }),
-  component: RootComponent,
-  shellComponent: RootDocument,
-})
-function RootComponent() {
-  return <Outlet />
-}
-function RootDocument({ children }: { children: React.ReactNode }) {
-  return (
-    <html lang="en" suppressHydrationWarning>
-      <head>
-        <HeadContent />
-      </head>
-      <body suppressHydrationWarning>
-        {children}
-        <Scripts />
-      </body>
-    </html>
-  )
-}

package/templates/minimal/src/routes/guide/_layout.tsx DELETED Viewed

@@ -1,19 +0,0 @@
-import { createFileRoute, Outlet } from '@tanstack/react-router'
-import { Layout } from 'ardo/theme'
-import { PressProvider } from 'ardo/runtime'
-import config from 'virtual:ardo/config'
-import sidebar from 'virtual:ardo/sidebar'
-export const Route = createFileRoute('/guide/_layout')({
-  component: GuideLayoutComponent,
-})
-function GuideLayoutComponent() {
-  return (
-    <PressProvider config={config} sidebar={sidebar}>
-      <Layout>
-        <Outlet />
-      </Layout>
-    </PressProvider>
-  )
-}

package/templates/minimal/src/routes/index.tsx DELETED Viewed

@@ -1,40 +0,0 @@
-import { createFileRoute } from '@tanstack/react-router'
-import { HomePage } from 'ardo/theme'
-import { PressProvider } from 'ardo/runtime'
-import config from 'virtual:ardo/config'
-import sidebar from 'virtual:ardo/sidebar'
-import { frontmatter, toc } from '../../content/index.md'
-export const Route = createFileRoute('/')({
-  head: () => ({
-    meta: [
-      {
-        title: (frontmatter.title as string)
-          ? `${frontmatter.title} | ${config.title}`
-          : config.title,
-      },
-      ...(frontmatter.description
-        ? [{ name: 'description', content: frontmatter.description as string }]
-        : []),
-    ],
-  }),
-  component: HomeComponent,
-})
-function HomeComponent() {
-  const pageData = {
-    title: (frontmatter.title as string) || 'Home',
-    description: frontmatter.description as string | undefined,
-    frontmatter,
-    content: '',
-    toc,
-    filePath: 'index.md',
-    relativePath: 'index.md',
-  }
-  return (
-    <PressProvider config={config} sidebar={sidebar} currentPage={pageData}>
-      <HomePage />
-    </PressProvider>
-  )
-}

package/templates/minimal/src/vite-env.d.ts DELETED Viewed

@@ -1,23 +0,0 @@
-/// <reference types="vite/client" />
-declare module 'virtual:ardo/config' {
-  import type { PressConfig } from 'ardo'
-  const config: PressConfig
-  export default config
-}
-declare module 'virtual:ardo/sidebar' {
-  import type { SidebarItem } from 'ardo'
-  const sidebar: SidebarItem[]
-  export default sidebar
-}
-declare module '*.md' {
-  import type { ComponentType } from 'react'
-  import type { PageFrontmatter, TOCItem } from 'ardo'
-  export const frontmatter: PageFrontmatter
-  export const toc: TOCItem[]
-  const component: ComponentType
-  export default component
-}