@lupinum/ginko-content

@lupinum/ginko-content

Files as a content source for @lupinum/ginko. At build time it reads content/ and builds the same bundle the Ginko platform serves, so a site reads files and platform content the same way, with useGinko. Use it for content that developers maintain: docs, a blog, legal pages, a price list. It reads Markdown, YAML, JSON and CSV.

Use

npm install @lupinum/ginko @lupinum/ginko-content

@lupinum/ginko is a peer dependency. Images get WebP variants through sharp, an optional peer dependency: install it (npm install sharp, version 0.33 to 0.35) if your site has image files. ginko check runs without it.

Give a brick source: 'files' and one f.markdown field:

// ginko.config.ts
docs: collection({
  label: 'Docs',
  source: 'files',
  max: 500,
  order: 'manual',
  route: { en: '/docs/[slug]' },
  fields: { title: f.text('Title'), slug: f.slug('Address', { from: 'title' }), body: f.markdown('Text') },
}),

content/docs/1.getting-started.md      one entry; the number is the order
content/docs/1.getting-started.de.md   its translation

The Ginko Nuxt module finds this package by itself. It serves the Markdown of a page with the page, adds <GinkoMarkdown> and a search index. A file error fails the build and names the file.

Full guide: Content from files.

Stability

You install this package; you do not import it. The Ginko module and ginko check load it. Its exports are the contract between the Ginko packages and can change in any release.

License

MIT © Lupinum OG