Skip to content

Instantly share code, notes, and snippets.

View TouristShaun's full-sized avatar

SJ TouristShaun

17 followers · 78 following
View GitHub Profile
@TouristShaun
TouristShaun / HowPluginsCreateGists.md
Last active July 28, 2023 14:03
How Plugins Create Gists

How a Plugins Create GitHub Gists

Creating a GitHub Gist involves the following steps:

  1. Prepare the Content: The first step is to prepare the content that you want to include in the Gist. In this case, the content was the whitepaper on "Training Language Models to Perform Specialized Tasks: A Case Study with LlamaIndex and Ray". The content was prepared in Markdown format, which is a lightweight markup language with plain-text-formatting syntax.

  2. Call the GitHub API: Once the content is ready, the next step is to call the GitHub API to create the Gist. This is done using the gists.create method provided by the Octokit library, which is a client library for the GitHub API. The method is called with the following arguments:

    • files: This is an object where each key is a filename and the value is an object with properties for the file content. In this case, there was one file named "Whitepaper.md" and the content was the text of the whitepaper.
  • description: This is a short descri