Github Module

GitHub integration for Nuxt & Content

Setup

Install @docus/github in your project:

# Using Yarn
yarn add --dev @docus/github
# Using NPM
npm install --save-dev @docus/github

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

import { defineNuxtConfig } from 'nuxt'

export default defineNuxtConfig({
  modules: [
    '@nuxt/content', // Required
    '@docus/github'
  ],
  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 } = await useAsyncData('releases', () => githubReleases())
</script>

<template>
  <div>
    <div v-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. Run npm run dev:prepare to generate type stubs.
2. Create a personal access token on GitHub and add it into playground/.env

GITHUB_TOKEN='<your-personal-token>'

3. Use npm run dev to start playground in development mode.