No Description

frech c1de6b0f78 Merge pull request !1 from frech/fix_firefox 5 months ago
.github 71a24c9717 Add screenshot instruction 2 years ago
dist e81e8ec648 fix: firefox被下架(jquery以及jquery-ui不能修改) 5 months ago
docs 683c3d9305 合并 octotree/master 最新代码,更新至 2.4.6 版本 9 months ago
icons ac08a62cfe 更新插件信息 8 months ago
libs e81e8ec648 fix: firefox被下架(jquery以及jquery-ui不能修改) 5 months ago
src e81e8ec648 fix: firefox被下架(jquery以及jquery-ui不能修改) 5 months ago
test 49e992b4d9 Fix failed tests 2 years ago
.babelrc a01c98f06a Refactor gulp script & Chrome background 3 years ago
.editorconfig 3d9123a259 Add editorconfig 4 years ago
.gitignore 49e992b4d9 Fix failed tests 2 years ago
.jshintrc 15911b5177 Initial test suite 4 years ago
HISTORY.md f4cfa6d6b7 Bump release 9 months ago
LICENSE 83e3578a9a Change license to AGPL 2 years ago
README.md c602be4c6b 更新 README.md 8 months ago
README.zh-cn.md f671d6d3bb 更新 README.zh-cn.md 8 months ago
chrome_test_key.pem 56e7a2e8a7 !1 合并 octotree/master 最新代码,解决冲突 9 months ago
gulpfile.babel.js 683c3d9305 合并 octotree/master 最新代码,更新至 2.4.6 版本 9 months ago
package.json e81e8ec648 fix: firefox被下架(jquery以及jquery-ui不能修改) 5 months ago

README.md

OpenCollective OpenCollective

Octotree

Browser extension (Chrome, Firefox, Opera and Safari) to show a code tree on GitHub. Awesome for exploring project source without having to pull every single repository to your machine. Features:

  • Easy-to-navigate code tree, just like in IDEs
  • Fast browsing with pjax
  • Support private repositories (see instructions)
  • Support GitHub Enterprise (Chrome and Opera only, see instructions)

Octotree on GitHub

Install on Chrome, Firefox and Opera

Note: to configure Octotree for GitHub Enteprise, see instructions

Install on Safari

Octotree is not available on the Safari gallery. You have to build from source. Download this repo and run the following command:

gulp safari

Find the extension folder in tmp/safari. Follow Apple instructions to install the extension to your browser.

Install from prebuilt packages (all browsers)

Prebuilt packages are available in the dist folder. For security reason, only download Octotree from this location.

Note: Firefox 43+ requires add-ons to be signed. Therefore, you should install Octotree from the Mozilla store. For some reason if you want to install the prebuilt package instead, you have to disable sign-check.

Settings

Access Token

Note for the paranoids (like me!): Octotree stores access tokens in your browser local storage and never transmits it anywhere.

GitHub

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 ask for your GitHub personal access token. If you don't already have one, create one, then copy and paste it into the textbox. Note that the minimal scopes that should be granted are public_repo and repo (if you need access to private repositories).

Bitbucket (experimental)

Octotree uses Bitbucket API to retrieve repository metadata. By default, Octotree asks for your Bitbucket App password. If you don't already have one, create one (the minimal requirement is Repositories's Read permission), then copy and paste it into the textbox.

Note that Octotree extracts your username from the current page to invoke the Bitbucket API. If fail to do so, Octotree will ask you for a token update, you just need to prepend your username to the token, separated by a colon, i.e. USERNAME:TOKEN.

Enterprise URLs

By default, Octotree only works on github.com. To support enterprise version (Chrome and Opera only), you must grant Octotree sufficient permissions. Follow these steps to do so:

  • Go to any GitHub repo
  • Open the Octotree settings panel

Settings

  • Fill in the GitHub Enterprise URLs textbox, one URL per line
  • Click Save and accept the permission prompt
  • Navigate to your GitHub Enterprise site
  • You might be asked to create an access token

Others

  • Hotkeys: Octotree uses keymaster to register hotkeys. Check out the supported keys.
  • Remember sidebar visibility: if checked, show or hide Octotree based on its last visibility.
  • Show in non-code pages: if checked, allow Octotree to show in non-code pages such as Issues and Pull Requests.
  • Load entire tree at once: if checked, load and render the entire code tree at once. To avoid long loading, this should be unchecked if you frequently work with very large repos.
  • Show only pull request changes (new!): if checked and in "Pull requests" page, only show the change set of the pull request.

Credits

Backers

Loving Octotree? Donating to help us continue working on it.

[Become a backer]

Sponsors

Become a sponsor and get your logo on our README on Github with a link to your site. [Become a sponsor]