GitCodeTree/README.md at ffaf1ff2ed86b5242823111c9c92b576c70990bb

6.6 KiB

Raw Blame History

Octotree

Browser extensions (Chrome, Firefox, Opera and Safari) to display GitHub and GitLab code in tree format. Useful for developers who frequently read source and do not want to download or checkout too many repositories. Features:

Easy-to-navigate code tree like IDEs
Fast browsing with pjax (currently, only GitHub)
Customizable hotkey
Support private repositories (see instructions)
Support GitHub and GitLab Enterprise (Chrome and Opera only, see instructions)

Install on Chrome, Firefox and Opera

Install Octotree from Chrome Web Store, Mozilla Add-ons Store or Opera Add-ons Store
Navigate to any GitHub repository (or just refresh this page as an example)
The code tree should show on the left-hand side of the screen

Install on Safari

The prebuilt packages for all extensions are located in the dist folder. For security reason, only download Octotree from this location.

Safari: drag safari.safariextz to the browser and follow on-screen the instructions

Note: the Safari build is out of date with the main line because Apple wants to be the only company who forces open-source developers to pay for the privilege of creating extensions for their little-used browser.

Octotree Settings

Access Token

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:

You access a private repository
You exceed the rate limit of unauthenticated requests

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).

GitLab

Octotree uses GitLab API to retrieve repository metadata. By default, Octotree attempts to retrieve the access token embedded in the GitLab DOM and use the token to authenticate against the GitLab API. If Octotree cannot retrieve the token, it will prompt you to create one.

Enterprise URLs

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

Navigate to any GitHub or GitLab repository
Open Octotree's settings panel
Fill in the Enterprise URLs textbox, one URL per line
Click Save and accept any permission prompt
Navigate to your GitHub or GitLab Enterprise site
You might be asked to create an access token

Settings

Hotkeys: Octotree uses keymaster to register hotkeys. Checkout the supported keys.
Remember sidebar visibility: if checked, show Octotree based on its previous visibility.
Show in non-code pages: if checked, allow Octotree to show in non-code pages such as Issues, Pull Requests and Wiki etc.
Load entire tree at once: if checked, issue a single API request to load the entire code tree. Could be slow in very large repos, in which case this option should be unchecked.

Changelog

v2.0.0

Support GitLab
Add ability to lazy-load individual folders
Simplify Octotree options
Support selecting different options for each host

v1.7.2

Fix bug long branches are not loaded correctly due to GitHub DOM change

v1.7.1

Fix space between tree and GitHub contents due to GitHub DOM change

v1.7.0

Support direct downloading when hovering a file

v1.6.4

Fix bug detecting branch/tag due to GitHub DOM change

v1.6.3

Fix bug when switching to branches with slashes in their names

v1.6.2

Fix branch selection no longer works due to GitHub change

v1.6.1

Update buttons' style to match GitHub new button style

v1.5

Option to show in non-code pages
Option to load tree only when sidebar is visible
Option to configure tab size
Bug fixes

v1.4.1

New header to match new GitHub design
Bug fixes

v1.4

Support GitHub enterprise
Change default hotkey (cmd+b for Safari and cmd+shift+s for all other browsers)
Some other minor changes

v1.3

Setting panel allowing:
Changing access token
Changing hotkeys
Changing sidebar default visibility
Changing folder collapsing option
Sidebar appears better in large monitors
More responsive in big repositories
And bug fixes

v1.2

Hide sidebar by default (upon many user requests)
Hotkey (cmd+b, ctrl+b) to toggle sidebar
Sidebar is now resizable
Support rendering submodules
Reflect GitHub selection to Octotree
New sidebar header and progress indicator
And bug fixes

v1.1

New UI that blends better with GitHub!
Hide Octotree on non-code pages
When asking for token, show more detailed message and not fly out automatically
Extend pjax timeout to work better with big files
Sanitize file and folder names before displaying
Fix error when a branch name contains slashes
Gulp script to build for Chrome, Firefox and Safari
And some other minor changes

Credits

@crashbell for the work on GitLab
@Ephemera for many bug fixes
@athaeryn and @letunglam for the UI design
@pstadler for the extension icon
And many other people who submit bug fixes and reports

6.6 KiB Raw Blame History