Go to file
Buu Nguyen ff53e8636f Update URLs 2014-05-09 17:08:16 -07:00
icons Initial commit 2014-05-09 17:06:38 -07:00
lib Initial commit 2014-05-09 17:06:38 -07:00
.gitignore Initial commit 2014-05-09 17:06:38 -07:00
LICENSE Initial commit 2014-05-09 11:15:20 -07:00
README.md Update URLs 2014-05-09 17:08:16 -07:00
inject.css Initial commit 2014-05-09 17:06:38 -07:00
inject.js Update URLs 2014-05-09 17:08:16 -07:00
manifest.json Initial commit 2014-05-09 17:06:38 -07:00
screen_ext.png Initial commit 2014-05-09 17:06:38 -07:00
screen_store.png Initial commit 2014-05-09 17:06:38 -07:00
screen_token.png Initial commit 2014-05-09 17:06:38 -07:00

README.md

Octotree

Chrome extension to display GitHub code in tree format. Useful for code junkies like me who frequently read source in GitHub and do not want download or checkout every single repository.

Install

  • Download and install Octotree from the Chrome store
  • Navigate to any GitHub project (or just refresh this page as an example)
  • The code tree should show as follows:

When extension is active

GitHub API Rate Limit

Octotree uses GitHub API to retrieve repository metadata. By default, it makes unauthenticated requests to the GitHub API. However, there are two situations when requests must be authenticated:

When that happens, Octotree will show use the following screen to ask for your GitHub personal access token.

Enter personal access token

If you don't already have one, create one at this page. Then enter the generated token into the textbox and save.

Alternatively, you can always manually enter or update the token by following these steps:

  • Navigate to any GitHub page
  • Open the Chrome developer console
  • Execute the following line:
localStorage.setItem('octotree.github_access_token', 'REPLACE WITH TOKEN')

Contribution

There are several improvements that can be made to Octotree. Contribution is very welcome.

  • Make the width of the tree panel resizable
  • Allow users to enter access token any time (i.e. a new button?)
  • Synchronize selection if users click on GitHub links directly (instead of via Octotree)
  • Show progress indicator while a repository is being loaded

Credit

Icon by pstadler