Giter Club home page Giter Club logo

minimal's Introduction

Minimal

Summary

  • Minimal is a Chromium extension that helps minimize browser tabs by saving them as Github issues.
  • A tab can be saved as a new issue or appended to an existing issue as a comment.
  • Minimal also allows saving multiple tabs at once, useful when doing research on a particular topic.
  • Incorporate a Kanban workflow using Github Projects to work through saved tabs.

Introduction

Minimal is a solution to the tab hoarding problem many of us face when surfing the web. Although we do rely on search engines to retrieve content we've seen in the past, more often than not we leave tabs open as personal reminders to attend to an article, paper or a podcast.

Minimal lets you save tabs as Github issues or comments so you can work through them structurally. Using Github to manage tabs has a number of benefits over traditional bookmarks:

  • Github labels let you categorize content based on topic.
  • Save additional information alongside the title and url.
  • Richer search capabilities for looking up saved content.
  • Apply a Kanban workflow to support your research work.

Installation

Installing a browser extension is a relatively straight forward exercise and can be done either manually or via the Web Store.

Chrome Web Store

Minimal is not available on the Chrome Web Store and might be added in due course.

Manual

To install Minimal manually download the latest release package or create your own build from source. Follow these steps to install the extension:

  1. Open the Extensions panel in your browser
  2. Turn on Developer mode
  3. Click on Load unpacked and browse to the build folder
  4. Select the build folder to install
  5. Optionally pin the new extension so that it is visible at all times

Authentication and Security Considerations

When the extension is activated for the first time you will be prompted for a Personal Access Token (PAT). Minimal uses a PAT to authenticate with Github's APIs. To create a PAT follow these instructions.

The limitation in using PATs is that they have broad access. Github doesn't allow scoping PATs to an individual repository although this might be addressed in future (see #184 on Github's roadmap).

NOTE: Never trust code even if its source is open unless you personally inspect the code, or a snapshot of the code has been audited and signed-off by a trusted entity. Although this code uses a PAT for the sole purpose of creating issues and querying meta data from the specified repository, the author holds no responsibilities for any breaches that might occur as a result of using this extension.

Extension Permissions

The extension relies on the following permissions:

  • Tabs: Access to browser tab instances and their underlying webpage.
  • Scripting: Code to fetch the head element from a webpage's DOM in order to extract metadata.
  • Storage: Persist PAT, repository url and other metadata such as labels and assignees.
  • History: Date and time a webpage was loaded to compute the duration a tab was opened.

Using Minimal

Minimal can be activated by:

  • Clicking on the extension's icon on the top right corner of the browser.
  • Using a keyboard shortcut: Ctrl+Shift+S on Linux and Windows, and Command+Shift+S on MacOS.

When the extension is activated for the first time, you will be promoted to enter a valid PAT and repository URL.

Saving a tab as a new issue

To save a tab as a new Github issue, activate the extension. The title and comment fields are filled automatically using meta data from web page. You may edit these fields and set one or more labels and assignees. Click Save to create a new issue.

The comment field is automatically filled with preview information, which helps with searching and reviewing issues. The following is result of saving the tab shown above.

Saving a tab as a comment to an existing issue

Use the Comment option to save a tab as a comment to an existing issue. The following is an example of saving a tab showing a related project repository which Cathie Yun, the presenter above, helped co-author.

Saving multiple tabs at once

Sometimes it is helpful to save multiple tabs at once rather than having to save each tab individually. This is often the case when you find relevant content pertaining to a certain topic of interest.

When saving multiple tabs at once, you either have the option of creating a single issue with multiple comments or a series of individual issues.

Contributing (reporting bugs, feature requests, pull requests, etc)

See CONTRIBUTING for guidelines on how to help improve Minimal.

minimal's People

Contributors

dileban avatar dependabot[bot] avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.