https://github.com/theotterlord/astro-csv

CSVs for Astro data collections
https://github.com/theotterlord/astro-csv

astro withastro

Last synced: 3 months ago
JSON representation

CSVs for Astro data collections

• Host: GitHub
• URL: https://github.com/theotterlord/astro-csv
• Owner: TheOtterlord
• Created: 2023-05-18T22:20:01.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-10-08T15:52:40.000Z (over 1 year ago)
• Last Synced: 2024-11-02T09:42:30.987Z (3 months ago)
• Topics: astro, withastro
• Language: TypeScript
• Homepage:
• Size: 111 MB
• Stars: 10
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Astro CSV Integration

Use CSV files as data sources in Astro.

## Install

```sh

npx astro add astro-csv

```

### Manual install

```sh

npm i astro-csv

```

```ts

// astro.config.mjs

import { defineConfig } from 'astro/config'

import astroCSV from 'astro-csv'

export default defineConfig({

  integrations: [

    astroCSV()

  ]

})

```

## Usage

### Accept any data

```ts

import { defineCollection, z } from 'astro:content';

const sheets = defineCollection({

  type: 'data',

  schema: z.object({

    rows: z.array(z.array(z.string().or(z.number().or(z.boolean()).nullish()))),

  })

});

export const collections = { sheets };

```

### Accept typed data

```ts

import { defineCollection, z } from 'astro:content';

const sheets = defineCollection({

  type: 'data',

  schema: z.object({

    rows: z.array(z.tuple([

      z.string(), // name

      z.string(), // email

      z.number(), // age

    ]))

  })

});

export const collections = { sheets };

```