Getting Started with Yist

This guide will help you get up and running with Yist quickly and efficiently.

GitHub Authentication

Setting up GitHub Access

  1. Personal Access Token (PAT)

    • Generate a new PAT from GitHub Settings → Developer Settings → Personal Access Tokens
    • Select the following required scopes:
      • gist - Full control of gists
    • Copy your PAT and keep it secure
  2. First-time Login

    • Launch Yist
    • Open the Login window
    • Paste your Personal Access Token
    • Your Gists will begin syncing automatically

Interface Overview

The Yist interface consists of three main sections:

  1. Left Sidebar

    • Gists section (All, Forked, Starred)
    • On My Mac section (Local drafts)
    • Collections section (Custom organized groups)
  2. Middle Pane

    • List of Gists based on your current selection
  3. Right Pane (Detail View)

    • File editor
    • Tab-based interface for multiple files
    • Syntax highlighting support

First Steps

  1. Explore Your Gists

    • Browse through your existing Gists in the All section
    • View starred Gists from other users
    • Check out your forked Gists
  2. Create Your First Gist

    • Use ⌘+N or click the New button
    • Enter your code or text
    • Choose between public or secret Gist
    • Save to GitHub or keep as a local draft
  3. Organize Your Work

    • Create collections to group related Gists
    • Pin frequently used Gists for quick access
    • Use filters to find specific content

Basic Operations

Viewing and Editing

  • Select any Gist from the list to view it in the detail pane
  • Edit content directly in the detail view if you have permission:
    • Your own created Gists
    • Gists you've forked
    • (Note: Starred Gists from others are read-only)

Saving and Syncing

  • Changes are automatically saved locally
  • To sync with GitHub:
    • Click the button with airplane icon in the toolbar
    • Use the "Save to GitHub" menu option
    • Use the keyboard shortcut ⌘+S
  • Local changes are indicated in the "On My Mac" section until synced

Other Operations

  • Use the search bar to find specific content
  • Apply filters to narrow down your Gist list
  • Create collections to organize related Gists

Tips for Getting Started

  • Regularly sync your changes to GitHub
  • Use collections to organize related Gists
  • Pin frequently used Gists for quick access
  • Check the "On My Mac" section for any unsynced changes

results matching ""

    No results matching ""