Skip to content

Latest commit

 

History

History
129 lines (82 loc) · 3.84 KB

README.md

File metadata and controls

129 lines (82 loc) · 3.84 KB
Raw

GistBrowser-Pharo

Interact with GitHub Gist on Pharo.

Browse, create, edit, and fork Gists via the Gist Browser, create Gists from Playgrounds, Gist Press support, and more.

Screenshot

Screenshot

TODO

  • Support the latest Pharo release.
  • Support Spec2.

Installation

  1. Setup a personal access token for Pharo at https://github.com/settings/tokens/new. Use this token for the Iceberg github.com plain text credentials password.

  2. In a Playground, Do it:

Metacello new
  repository: 'github://brackendev/GistBrowser-Pharo/src';
  baseline: 'GistBrowser';
  load.

Example Usage

Note: In Gist Browser, after entering text, it needs to be accepted with the "accept" keybind, usually Meta + s.

◼︎ Open Gist Browser from Tools

  • Interact with Gists using the Gist Browser accessible via the Tools menu.

◼︎ Open Gist Browser from a Playground

In a Playground, Do it:

"Open with the Iceberg plain text github.com username"
GistBrowser open.

...or Do it:

"Open with a custom GitHub username"
GistBrowser open: 'brackendev'.

◼︎ Create a Gist from a Playground

  • Similar to the Playground "Remote publish" (to share code via Shared Smalltalk Workspaces), create a Gist from a Playground via the GitHub button in the Playground toolbar.

    Screenshot

More Example Usage

◼︎ Create a Gist

Gist Browser:

  1. Click the Add a new gist [➕] button (left-side top toolbar).
  2. In the File content text area, add the content.
  3. In the Gist description text field, add the description.
  4. In the Content filename text field, add the filename.
  5. Enable or disable the Privacy checkbox.
  6. Click the Save button.

Playground:

  1. Click the GitHub icon (top-right).
  2. In the Gist description text field, add the description.
  3. Click the Save button.

◼︎ Delete a Gist

  1. Select the Gist (top-left column).
  2. Click the Delete Gist [❌] button (left-side top toolbar).

◼︎ Add a File to a Gist

  1. Select the Gist.
  2. Click the Add a new file [➕] button (right-side top toolbar).
  3. In the File content text area, add the content.
  4. In the Content filename text field, add the filename.
  5. Click the Save button.

◼︎ Edit a Gist File

  1. Select the Gist (top-left column)
  2. Select the file (top-right column).
  3. Edit the content (in the File content text area) and/or the filename (in the Content filename text field).
  4. Click the Save button.

◼︎ Delete a Gist File

  1. Select the Gist (top-left column)
  2. Select the file (top-right column).
  3. Click the Delete File [❌] button (right-side top toolbar).

Note

  • Due to limitations of the public Gist API, the UX is not as smooth as I prefer. Multiple API requests have to be made to get the entire content of a Gist. Even getting the starred status of a Gist requires a unique API request.

Acknowledgements

This project makes use of the following third-party libraries and utilities:

Author

Bracken Spencer

License

GistBrowser-Pharo is released under the MIT license. See the LICENSE file for more info.