Handle remote github repository

[BenjaminOddou]

Hello,

I set up a remote GitHub repository in my content.config.ts file. It's working fine for the Nuxt Content module, but Nuxt Studio can't find the path to the content.

The content of my content folder is under the root level of my remote repository.

remote-content-repo/
├── 1.docs/
├── 2.blog/
└── README.md

[larbish]

Can you share your content.config.ts file ? 🙏

[BenjaminOddou]

import type { z as zd } from 'zod'
import process from 'node:process'
import { defineCollection, defineContentConfig, z } from '@nuxt/content'

const iconLibraries = ['vscode-icons', 'simple-icons', 'lucide']

const AccessControlObject = z.object({
  users: z.array(z.string()).optional(),
  groups: z.array(z.string()).optional(),
})

export const AuthSchema = z.object({
  read: AccessControlObject.optional(),
  write: AccessControlObject.optional(),
}).optional()

export const DocsSchema = z.object({
  navigation: z.object({
    title: z.string().optional(),
    icon: z.string().editor({ input: 'icon', iconLibraries }).optional(),
  }).optional(),
  links: z.array(z.object({
    label: z.string(),
    icon: z.string().editor({ input: 'icon', iconLibraries }).optional(),
    to: z.string(),
    target: z.string().optional(),
  })).optional(),
  authors: z.array(z.string()).optional(),
  date: z.string().date().optional(),
  auth: AuthSchema,
})

export const BlogSchema = z.object({
  navigation: z.object({
    title: z.string().optional(),
    icon: z.string().editor({ input: 'icon', iconLibraries }).optional(),
  }).optional(),
  image: z.object({
    src: z.string().editor({ input: 'media' }),
    alt: z.string().optional(),
  }).optional(),
  authors: z.array(z.string()).optional(),
  date: z.string().date().optional(),
  badge: z.enum(['Tutoriel', 'Annonce', 'Article']).optional(),
  auth: AuthSchema,
})

export type Blog = zd.infer<typeof BlogSchema>
export type Docs = zd.infer<typeof DocsSchema>

export default defineContentConfig({
  collections: {
    docs: defineCollection({
      type: 'page',
      source: {
        repository: process.env.GITHUB_CONTENT_REPO,
        authToken: process.env.GITHUB_TOKEN,
        include: '1.docs/**',
      },
      schema: DocsSchema,
    }),
    blog: defineCollection({
      type: 'page',
      source: {
        repository: process.env.GITHUB_CONTENT_REPO,
        authToken: process.env.GITHUB_TOKEN,
        include: '2.blog/**',
      },
      schema: BlogSchema,
    }),
  },
})

[Matheun]

I got the same issue, however studio does correctly read the markdown files from my external selfhosted git repo. It does however not allow me to edit these files etc, since they are inside .data/content/[selfhosted-git]

[BenjaminOddou]

@Matheun what's your configuration (content.config.ts) and the structure of your remote content repo ?

[Matheun]

@Matheun what's your configuration (content.config.ts) and the structure of your remote content repo ?

I added the default content from the template to a fresh repo on a selfhosted gitlab, the content was placed inside a dir named docs, besides the docs dir, the only other file in the repo is a README.md

It did manage to fetch the files and install them in the .data/content/[selfhosted-git] folder, i did use a open PR of nuxt-content to get the git fetching to work properly

content.config.ts is as follows:

import { defineCollection, defineContentConfig, z } from "@nuxt/content";

const Avatar = z.object({
    src: z.string(),
    alt: z.string().optional(),
});

const Button = z.object({
    label: z.string(),
    icon: z.string().optional(),
    avatar: Avatar.optional(),
    leadingIcon: z.string().optional(),
    trailingIcon: z.string().optional(),
    to: z.string().optional(),
    target: z.enum(["_blank", "_self"]).optional(),
    color: z.enum(["primary", "neutral", "success", "warning", "error", "info"]).optional(),
    size: z.enum(["xs", "sm", "md", "lg", "xl"]).optional(),
    variant: z.enum(["solid", "outline", "subtle", "soft", "ghost", "link"]).optional(),
    id: z.string().optional(),
    class: z.string().optional(),
});

export default defineContentConfig({
    collections: {
        landing: defineCollection({
            type: "page",
            source: "index.md",
        }),
        docs: defineCollection({
            type: "page",
            source: {
                include: "**/*",
                exclude: [
                    "index.md",
                ],
            },
            schema: z.object({
                category: z.enum(["components", "composables", "utils", "types"]),
                navigation: z.object({
                    title: z.string().optional(),
                    icon: z.string().optional(),
                    ungrouped: z.boolean().optional(),
                }),
                standalone: z.boolean().optional(),
                links: z.array(Button),
                file: z.string().optional(),
            }),
        }),
        external: defineCollection({
            type: "page",
            source: {
                repository: {
                    url: "https://git.redacted.nl/redacted/redacted.git",
                    branch: "main",
                    auth: {
                        token: "redacted",
                        username: "redacted",
                    },
                },
                prefix: "external-content/",
                include: "docs/**",
            },
            schema: z.object({
                links: z.array(z.object({
                    label: z.string(),
                    icon: z.string(),
                    to: z.string(),
                    target: z.string().optional(),
                })).optional(),
            }),
        }),
    },
});