@matthiesenxyz/astro-gists

Astro-Gists

This is an Astro integration that allows the user to import GitHub Gists by ID through an Astro Component and Octokit

Example

Usage

Prerequisites

The Only Requirement to install this package is a Github account with a Verified Email to be able to create a Personal Access Token.

This Integration uses Octokit by GitHub to Generate custom gists using ExpressiveCode within your Astro project!

Installation

Install the integration automatically using the Astro CLI:

pnpm astro add @matthiesenxyz/astro-gists

npx astro add @matthiesenxyz/astro-gists

yarn astro add @matthiesenxyz/astro-gists

Or install it manually:

1. Install the required dependencies

pnpm add @matthiesenxyz/astro-gists

npm install @matthiesenxyz/astro-gists

yarn add @matthiesenxyz/astro-gists

2. Add the integration to your astro config

import { defineConfig } from "astro/config";
+import astroGist from "@matthiesenxyz/astro-gists";

// https://astro.build/config
export default defineConfig({
+  integrations: [astroGist({
	// Allows you to set the default theme
	theme: ['catppuccin-macchiato'],
	// Allows you to enable verbose logging
	verbose: false,
+  })]
});

Configuration

Setup your .env file with the following secret from github:

Github Personal Access Token (Classic)

• No Special Permissions required
• Octokit recommends creating an empty token for this!

GITHUB_PERSONAL_TOKEN=ghp_YOURPERSONALTOKENHERE

Note: Without this token, you will be HEAVILY limited by quantity of requests made with Octokit. (Unauthorized Octokit Instances are limited to 60 requests per hour)

Note: It is recommended to use this Integration in SSG(Static Site) mode only(or enable prerendering for pages with Gists), as in SSR(Server Rendered) mode that could overload your Octokit request limit quite fast. Keep in mind for each Gist/Gists request made that counts twords your global limit.(60 requests per hour for unauthorized Octokit, 5,000 requests per hour for personal access tokens, and if using a GitHub App by Under GitHub Enterprise Cloud is 15,000+) see GitHub Docs

Usage

<GetGist> Shows a SINGLE gist from a GistCollection

This Utility is meant to display a single Gist as Codeblocks using ExpressiveCode for Astro instead of Scripted Elements using the default Gist method by calling the ID and Filename

---
import { GetGist } from "astro-gists:components"
---
<GetGist 
	gistId="your-gist-id-here"
	filename="name-of-desired-file-to-be-displayed.md" 
/>

<GetGistGroup> Shows all of the Gists from a GistCollection

This Utility is meant to display an entire collection of Gists by ID

---
import { GetGistGroup } from "astro-gists:components"
---
<GetGistGroup 
	gistId="your-gist-id-here"
/>

Contributing

This package is structured as a monorepo:

• playground contains code for testing the package
• package contains the actual package

Install dependencies using pnpm:

pnpm i --frozen-lockfile

Start the playground:

pnpm playground:dev

You can now edit files in package. Please note that making changes to those files may require restarting the playground dev server.

Licensing

MIT Licensed. Made with ❤️ by AdamMatthiesen Under MatthiesenXYZ.

Acknowledgements

• Octokit by GitHub
• Expressive-Code By Hippotasic
• @astrojs/mdx by withAstro
• astro-integration-kit by Florian