Github Module

GitHub integration for Nuxt & Content

Setup

Install @nuxtlabs/github-module in your project:

# Using Yarn
yarn add --dev @nuxtlabs/github-module
# Using NPM
npm install --save-dev @nuxtlabs/github-module
# Using PNPM
pnpm add --save-dev @nuxtlabs/github-module

Then, add @nuxtlabs/github-module to the modules section of your nuxt.config.ts:

import{defineNuxtConfig}from'nuxt'exportdefaultdefineNuxtConfig({modules: ['@nuxt/content',// Required'@nuxtlabs/github-module'],github: {repo: 'nuxt/framework'// Or use GITHUB_REPO in .env}})

Lastly, create a personal access token on GitHub and add it into your .env:

GITHUB_TOKEN='<your-personal-token>'

Usage

<script setup lang="ts">const { data: releases } =awaituseAsyncData('releases', () =>githubReleases())</script>
<template>
<div>
<divv-for="release in releases":key="release.name">
<ProseH2 :id="release.name">{{ release.name }}</ProseH2>
<Content :document="release" />
</div>
</div>
</template>

Options

github: {repo: string,releases: false|{api: string
repo: string
token: string
/** * Parse release notes markdown and return AST tree * * Note: This option is only available when you have `@nuxt/content` installed in your project. * * @default true */parse: boolean}}

Development

1. Clone this repository
2. Install dependencies using yarn install or npm install
3. Generate type stubs using yarn prepare or npm run prepare
4. In playground/.env, add your personal access token

GITHUB_TOKEN='<your-personal-token>'

5. Launch playground using yarn dev or npm run dev