增加cookie支持，中文readme.md
This commit is contained in:
inu1255
parent
a4e11762d4
commit
2fb89daeeb
|
|
@ -0,0 +1,149 @@
|
|||
[](#backers)
|
||||
[](#sponsors)
|
||||
|
||||
## 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 and Turbolinks
|
||||
* Support private repositories (see [instructions](#access-token))
|
||||
* Support GitHub Enterprise (Chrome and Opera only, see [instructions](#enterprise-urls))
|
||||
|
||||
__GitLab is no longer supported__:
|
||||
As of version 2.1.0, Octotree no longer supports GitLab. There are 2 reasons for this. First, GitLab has changed so much recently that it would take a lot of effort to keep Octotree up to date. Second, the GitLab team has [told me](https://github.com/buunguyen/octotree/issues/265) they would build a tree feature in GitLab itself. I can't afford working on something knowing my effort will be irrelevant any time soon. That being said, if anyone wants to work on supporting the new GitLab, I'll gladly accept contributions to add back GitLab support.
|
||||
|
||||
|
||||
|
||||
|
||||
### Install on Chrome, Firefox and Opera
|
||||
* Install Octotree from [Chrome Web Store](https://chrome.google.com/webstore/detail/octotree/bkhaagjahfmjljalopjnoealnfndnagc), [Mozilla Add-ons Store](https://addons.mozilla.org/en-US/firefox/addon/octotree/) or [Opera Add-ons Store](https://addons.opera.com/en/extensions/details/octotree/)
|
||||
* 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
|
||||
|
||||
__Note__: to configure Octotree for GitHub Enteprise, see [instructions](#enterprise-urls)
|
||||
|
||||
### Install on Safari
|
||||
|
||||
Octotree is not available on the Safari gallery. Instead, you must use the prebuilt package or build one from source.
|
||||
|
||||
* Download the [Safari prebuilt package](https://github.com/buunguyen/octotree/blob/master/dist/safari.safariextz?raw=true)
|
||||
* Double-click or drag it to Safari
|
||||
|
||||
### Install from prebuilt packages (all browsers)
|
||||
|
||||
Prebuilt packages are available in the [dist](https://github.com/buunguyen/octotree/tree/master/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](https://github.com/buunguyen/octotree/issues/220#issuecomment-166012724).
|
||||
|
||||
## Settings
|
||||
### Access Token
|
||||
|
||||
__Note for the paranoids (like me!)__: Octotree stores access tokens in your browser local storage and never transmits it anywhere. If you want to verify, check out the source, starting with [this line](https://github.com/buunguyen/octotree/blob/master/src/view.options.js#L77).
|
||||
|
||||
#### GitHub
|
||||
Octotree uses [GitHub API](https://developer.github.com/v3/) 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](https://developer.github.com/v3/#rate-limiting)
|
||||
|
||||
When that happens, Octotree will ask for your [GitHub personal access token](https://help.github.com/articles/creating-an-access-token-for-command-line-use). If you don't already have one, [create one](https://github.com/settings/tokens/new), 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
|
||||
Octotree uses [Bitbucket API](https://confluence.atlassian.com/bitbucket/repositories-endpoint-1-0-296092719.html) to retrieve repository metadata. By defualt, Octotree will ask for your [Bitbucket App password](https://confluence.atlassian.com/bitbucket/app-passwords-828781300.html). If you don't already have one, [create one](https://bitbucket.org/account/admin/app-passwords) (the minimal requirement is `Repositories`'s `Read` permission), then copy and paste it into the textbox.
|
||||
|
||||
Note that Octotree extract your username from your current page by default for calling Bitbucket API. If fail to extract, Octotree will ask you for a token update, then 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
|
||||
|
||||
|
||||
|
||||
* 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](#access-token)
|
||||
|
||||
### Others
|
||||
* __Hotkeys__: Octotree uses [keymaster](https://github.com/madrobby/keymaster) to register hotkeys. Checkout the [supported keys](https://github.com/madrobby/keymaster#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.
|
||||
|
||||
## Credits
|
||||
* [@crashbell](https://github.com/crashbell) for helping with GitLab and others
|
||||
* [@Ephemera](https://github.com/Ephemera) for fixing many bugs
|
||||
* [@athaeryn](https://github.com/athaeryn) and [@letunglam](https://github.com/letunglam) for helping with UI design
|
||||
* And many other people who submit bug fixes and reports
|
||||
|
||||
## Backers
|
||||
|
||||
Support us with a monthly donation and help us continue our activities. [[Become a backer](https://opencollective.com/octotree#backer)]
|
||||
|
||||
<a href="https://opencollective.com/octotree/backer/0/website" target="_blank"><img src="https://opencollective.com/octotree/backer/0/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/octotree/backer/1/website" target="_blank"><img src="https://opencollective.com/octotree/backer/1/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/octotree/backer/2/website" target="_blank"><img src="https://opencollective.com/octotree/backer/2/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/octotree/backer/3/website" target="_blank"><img src="https://opencollective.com/octotree/backer/3/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/octotree/backer/4/website" target="_blank"><img src="https://opencollective.com/octotree/backer/4/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/octotree/backer/5/website" target="_blank"><img src="https://opencollective.com/octotree/backer/5/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/octotree/backer/6/website" target="_blank"><img src="https://opencollective.com/octotree/backer/6/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/octotree/backer/7/website" target="_blank"><img src="https://opencollective.com/octotree/backer/7/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/octotree/backer/8/website" target="_blank"><img src="https://opencollective.com/octotree/backer/8/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/octotree/backer/9/website" target="_blank"><img src="https://opencollective.com/octotree/backer/9/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/octotree/backer/10/website" target="_blank"><img src="https://opencollective.com/octotree/backer/10/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/octotree/backer/11/website" target="_blank"><img src="https://opencollective.com/octotree/backer/11/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/octotree/backer/12/website" target="_blank"><img src="https://opencollective.com/octotree/backer/12/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/octotree/backer/13/website" target="_blank"><img src="https://opencollective.com/octotree/backer/13/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/octotree/backer/14/website" target="_blank"><img src="https://opencollective.com/octotree/backer/14/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/octotree/backer/15/website" target="_blank"><img src="https://opencollective.com/octotree/backer/15/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/octotree/backer/16/website" target="_blank"><img src="https://opencollective.com/octotree/backer/16/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/octotree/backer/17/website" target="_blank"><img src="https://opencollective.com/octotree/backer/17/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/octotree/backer/18/website" target="_blank"><img src="https://opencollective.com/octotree/backer/18/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/octotree/backer/19/website" target="_blank"><img src="https://opencollective.com/octotree/backer/19/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/octotree/backer/20/website" target="_blank"><img src="https://opencollective.com/octotree/backer/20/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/octotree/backer/21/website" target="_blank"><img src="https://opencollective.com/octotree/backer/21/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/octotree/backer/22/website" target="_blank"><img src="https://opencollective.com/octotree/backer/22/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/octotree/backer/23/website" target="_blank"><img src="https://opencollective.com/octotree/backer/23/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/octotree/backer/24/website" target="_blank"><img src="https://opencollective.com/octotree/backer/24/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/octotree/backer/25/website" target="_blank"><img src="https://opencollective.com/octotree/backer/25/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/octotree/backer/26/website" target="_blank"><img src="https://opencollective.com/octotree/backer/26/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/octotree/backer/27/website" target="_blank"><img src="https://opencollective.com/octotree/backer/27/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/octotree/backer/28/website" target="_blank"><img src="https://opencollective.com/octotree/backer/28/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/octotree/backer/29/website" target="_blank"><img src="https://opencollective.com/octotree/backer/29/avatar.svg"></a>
|
||||
|
||||
## Sponsors
|
||||
|
||||
Become a sponsor and get your logo on our README on Github with a link to your site. [[Become a sponsor](https://opencollective.com/octotree#sponsor)]
|
||||
|
||||
<a href="https://opencollective.com/octotree/sponsor/0/website" target="_blank"><img src="https://opencollective.com/octotree/sponsor/0/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/octotree/sponsor/1/website" target="_blank"><img src="https://opencollective.com/octotree/sponsor/1/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/octotree/sponsor/2/website" target="_blank"><img src="https://opencollective.com/octotree/sponsor/2/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/octotree/sponsor/3/website" target="_blank"><img src="https://opencollective.com/octotree/sponsor/3/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/octotree/sponsor/4/website" target="_blank"><img src="https://opencollective.com/octotree/sponsor/4/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/octotree/sponsor/5/website" target="_blank"><img src="https://opencollective.com/octotree/sponsor/5/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/octotree/sponsor/6/website" target="_blank"><img src="https://opencollective.com/octotree/sponsor/6/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/octotree/sponsor/7/website" target="_blank"><img src="https://opencollective.com/octotree/sponsor/7/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/octotree/sponsor/8/website" target="_blank"><img src="https://opencollective.com/octotree/sponsor/8/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/octotree/sponsor/9/website" target="_blank"><img src="https://opencollective.com/octotree/sponsor/9/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/octotree/sponsor/10/website" target="_blank"><img src="https://opencollective.com/octotree/sponsor/10/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/octotree/sponsor/11/website" target="_blank"><img src="https://opencollective.com/octotree/sponsor/11/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/octotree/sponsor/12/website" target="_blank"><img src="https://opencollective.com/octotree/sponsor/12/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/octotree/sponsor/13/website" target="_blank"><img src="https://opencollective.com/octotree/sponsor/13/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/octotree/sponsor/14/website" target="_blank"><img src="https://opencollective.com/octotree/sponsor/14/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/octotree/sponsor/15/website" target="_blank"><img src="https://opencollective.com/octotree/sponsor/15/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/octotree/sponsor/16/website" target="_blank"><img src="https://opencollective.com/octotree/sponsor/16/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/octotree/sponsor/17/website" target="_blank"><img src="https://opencollective.com/octotree/sponsor/17/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/octotree/sponsor/18/website" target="_blank"><img src="https://opencollective.com/octotree/sponsor/18/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/octotree/sponsor/19/website" target="_blank"><img src="https://opencollective.com/octotree/sponsor/19/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/octotree/sponsor/20/website" target="_blank"><img src="https://opencollective.com/octotree/sponsor/20/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/octotree/sponsor/21/website" target="_blank"><img src="https://opencollective.com/octotree/sponsor/21/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/octotree/sponsor/22/website" target="_blank"><img src="https://opencollective.com/octotree/sponsor/22/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/octotree/sponsor/23/website" target="_blank"><img src="https://opencollective.com/octotree/sponsor/23/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/octotree/sponsor/24/website" target="_blank"><img src="https://opencollective.com/octotree/sponsor/24/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/octotree/sponsor/25/website" target="_blank"><img src="https://opencollective.com/octotree/sponsor/25/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/octotree/sponsor/26/website" target="_blank"><img src="https://opencollective.com/octotree/sponsor/26/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/octotree/sponsor/27/website" target="_blank"><img src="https://opencollective.com/octotree/sponsor/27/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/octotree/sponsor/28/website" target="_blank"><img src="https://opencollective.com/octotree/sponsor/28/avatar.svg"></a>
|
||||
<a href="https://opencollective.com/octotree/sponsor/29/website" target="_blank"><img src="https://opencollective.com/octotree/sponsor/29/avatar.svg"></a>
|
||||
75
README.md
75
README.md
|
|
@ -2,75 +2,56 @@
|
|||
[](#sponsors)
|
||||
|
||||
## 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:
|
||||
fork from [https://github.com/buunguyen/octotree](https://github.com/buunguyen/octotree)
|
||||
|
||||
* Easy-to-navigate code tree, just like in IDEs
|
||||
* Fast browsing with pjax and Turbolinks
|
||||
* Support private repositories (see [instructions](#access-token))
|
||||
* Support GitHub Enterprise (Chrome and Opera only, see [instructions](#enterprise-urls))
|
||||
浏览器插件 (Chrome, Firefox, Opera and Safari) 在Gitee、GitHub上显示代码树。不用clone到本地就能查看项目结构. 特性:
|
||||
|
||||
__GitLab is no longer supported__:
|
||||
As of version 2.1.0, Octotree no longer supports GitLab. There are 2 reasons for this. First, GitLab has changed so much recently that it would take a lot of effort to keep Octotree up to date. Second, the GitLab team has [told me](https://github.com/buunguyen/octotree/issues/265) they would build a tree feature in GitLab itself. I can't afford working on something knowing my effort will be irrelevant any time soon. That being said, if anyone wants to work on supporting the new GitLab, I'll gladly accept contributions to add back GitLab support.
|
||||
* 就像在IDE一样简单易用的代码树
|
||||
* 快速浏览文件，不刷新页面
|
||||
* 支持私人存储库 (Gitee登录后就可查看， Github 需要填写[access_token](#access-token))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Install on Chrome, Firefox and Opera
|
||||
* Install Octotree from [Chrome Web Store](https://chrome.google.com/webstore/detail/octotree/bkhaagjahfmjljalopjnoealnfndnagc), [Mozilla Add-ons Store](https://addons.mozilla.org/en-US/firefox/addon/octotree/) or [Opera Add-ons Store](https://addons.opera.com/en/extensions/details/octotree/)
|
||||
* 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
|
||||
### 在 Chrome, Firefox 和 Opera 上安装
|
||||
* 从 [Chrome Web Store](https://chrome.google.com/webstore/detail/octotree/bkhaagjahfmjljalopjnoealnfndnagc), [Mozilla Add-ons Store](https://addons.mozilla.org/en-US/firefox/addon/octotree/) or [Opera Add-ons Store](https://addons.opera.com/en/extensions/details/octotree/) 安装GitCodeTree
|
||||
* 导航到任何Gitee、GitHub库(或者只是刷新这个页面作为一个例子)
|
||||
* 代码树应该显示在屏幕的左边
|
||||
|
||||
__Note__: to configure Octotree for GitHub Enteprise, see [instructions](#enterprise-urls)
|
||||
### 在 Safari 上安装
|
||||
|
||||
### Install on Safari
|
||||
GitCodeTree在Safari gallery中不可用。相反,您必须使用预先构建的包或从源代码构建一个。
|
||||
|
||||
Octotree is not available on the Safari gallery. Instead, you must use the prebuilt package or build one from source.
|
||||
* 下载 [Safari 预先构建的包](http://git.oschina.net/inu1255/GitCodeTree/blob/master/dist/safari.safariextz?raw=true)
|
||||
* 双击并拖拽到Safari窗口
|
||||
|
||||
* Download the [Safari prebuilt package](https://github.com/buunguyen/octotree/blob/master/dist/safari.safariextz?raw=true)
|
||||
* Double-click or drag it to Safari
|
||||
### 从预先构建的软件包安装(所有浏览器)
|
||||
|
||||
### Install from prebuilt packages (all browsers)
|
||||
预先构建的包可以从 [这里](https://github.com/buunguyen/octotree/tree/master/dist) 下载. 出于安全原因,请不要从其它地方下载.
|
||||
|
||||
Prebuilt packages are available in the [dist](https://github.com/buunguyen/octotree/tree/master/dist) folder. For security reason, only download Octotree from this location.
|
||||
__注意__: Firefox 43 + 需要签名。因此您需要从Mozilla商店安装GitCodeTree。出于某种原因,如果你想安装预先构建的包, 请参考 [disable sign-check](https://github.com/buunguyen/octotree/issues/220#issuecomment-166012724).
|
||||
|
||||
__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](https://github.com/buunguyen/octotree/issues/220#issuecomment-166012724).
|
||||
|
||||
## Settings
|
||||
## 设置
|
||||
### Access Token
|
||||
|
||||
__Note for the paranoids (like me!)__: Octotree stores access tokens in your browser local storage and never transmits it anywhere. If you want to verify, check out the source, starting with [this line](https://github.com/buunguyen/octotree/blob/master/src/view.options.js#L77).
|
||||
__注意__: GitCodeTree 访问令牌在浏览器本地存储并不会上传到任何地方。如果你想验证,查看源代码,开始 [请参考这里](http://git.oschina.net/inu1255/GitCodeTree/blob/master/src/view.options.js#L77).
|
||||
|
||||
#### GitHub
|
||||
Octotree uses [GitHub API](https://developer.github.com/v3/) to retrieve repository metadata. By default, it makes unauthenticated requests to the GitHub API. However, there are two situations when requests must be authenticated:
|
||||
GitCodeTree 使用 [GitHub API](https://developer.github.com/v3/) 检索代码树。默认情况下,它使未经身份验证的请求到GitHub API。然而,有两种情况时必须经过身份验证的请求:
|
||||
|
||||
* You access a private repository
|
||||
* You exceed the [rate limit of unauthenticated requests](https://developer.github.com/v3/#rate-limiting)
|
||||
* 你访问一个私人存储库
|
||||
* 你超过 [请求频率限制限制](https://developer.github.com/v3/#rate-limiting)
|
||||
|
||||
When that happens, Octotree will ask for your [GitHub personal access token](https://help.github.com/articles/creating-an-access-token-for-command-line-use). If you don't already have one, [create one](https://github.com/settings/tokens/new), 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
|
||||
Octotree uses [Bitbucket API](https://confluence.atlassian.com/bitbucket/repositories-endpoint-1-0-296092719.html) to retrieve repository metadata. By defualt, Octotree will ask for your [Bitbucket App password](https://confluence.atlassian.com/bitbucket/app-passwords-828781300.html). If you don't already have one, [create one](https://bitbucket.org/account/admin/app-passwords) (the minimal requirement is `Repositories`'s `Read` permission), then copy and paste it into the textbox.
|
||||
|
||||
Note that Octotree extract your username from your current page by default for calling Bitbucket API. If fail to extract, Octotree will ask you for a token update, then 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
|
||||
当这种情况发生时,GitCodeTree会询问你 [GitHub 私人 access token](https://help.github.com/articles/creating-an-access-token-for-command-line-use). 如果你没有, [点此创建](https://github.com/settings/tokens/new), 然后复制粘贴到文本框中。注意,至少要允许"public_repo","repo" (如果你需要访问私人仓库).
|
||||
|
||||
|
||||
|
||||
* 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](#access-token)
|
||||
|
||||
### Others
|
||||
* __Hotkeys__: Octotree uses [keymaster](https://github.com/madrobby/keymaster) to register hotkeys. Checkout the [supported keys](https://github.com/madrobby/keymaster#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.
|
||||
### 其它
|
||||
* __热键__: GitCodeTree 使用 [keymaster](https://github.com/madrobby/keymaster) 注册热键。查看 [支持的按键](https://github.com/madrobby/keymaster#supported-keys).
|
||||
* __记得栏可见性__: 如果勾选此项,基于其可见性显示或隐藏GitCodeTree.
|
||||
* __在非代码页__: 如果勾选此项,让GitCodeTree等非代码页的问题和请求.
|
||||
* __一次加载整个树__: 如果勾选此项,负载和渲染整个代码树。为了避免长时间加载,这应该是不如果你经常使用非常大的回购.
|
||||
|
||||
## Credits
|
||||
* [@crashbell](https://github.com/crashbell) for helping with GitLab and others
|
||||
|
|
|
|||
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
|
After Width: | Height: | Size: 444 KiB |
|
|
@ -109,33 +109,30 @@ class Adapter {
|
|||
|
||||
switch (jqXHR.status) {
|
||||
case 0:
|
||||
error = 'Connection error'
|
||||
error = '连接错误'
|
||||
message =
|
||||
`Cannot connect to website.
|
||||
If your network connection to this website is fine, maybe there is an outage of the API.
|
||||
Please try again later.`
|
||||
`无法连接到网站. 如果你的网络连接这个网站很好,也许有一个中断的API. 请稍后再试.`
|
||||
needAuth = false
|
||||
break
|
||||
case 206:
|
||||
error = 'Repo too large'
|
||||
error = '仓库太大'
|
||||
message =
|
||||
`This repository is too large to be retrieved at once.
|
||||
If you frequently work with this repository, go to Settings and uncheck the "Load entire tree at once" option.`
|
||||
`这个仓库检索太大. 如果你经常使用这个库,去设置和取消“立即加载整个仓库”的选项.`
|
||||
break
|
||||
case 401:
|
||||
error = 'Invalid token'
|
||||
error = '无效的token'
|
||||
message =
|
||||
`The token is invalid.
|
||||
Follow <a href="${this.getCreateTokenUrl()}" target="_blank">this link</a>
|
||||
to create a new token and paste it below.`
|
||||
`token是无效的.
|
||||
<a href="${this.getCreateTokenUrl()}" target="_blank">点此</a>
|
||||
去创建一个access token并粘贴到下面.`
|
||||
needAuth = true
|
||||
break
|
||||
case 409:
|
||||
error = 'Empty repository'
|
||||
message = 'This repository is empty.'
|
||||
error = '空仓库'
|
||||
message = '空仓库.'
|
||||
break
|
||||
case 404:
|
||||
error = 'Private repository'
|
||||
error = '私人仓库'
|
||||
message =
|
||||
`访问私有仓库需要access token.
|
||||
<a href="${this.getCreateTokenUrl()}" target="_blank">点些链接</a>
|
||||
|
|
@ -145,15 +142,15 @@ class Adapter {
|
|||
case 403:
|
||||
if (~jqXHR.getAllResponseHeaders().indexOf('X-RateLimit-Remaining: 0')) {
|
||||
// It's kinda specific for GitHub
|
||||
error = 'API limit exceeded'
|
||||
error = 'API超过限制'
|
||||
message =
|
||||
`You have exceeded the GitHub API hourly limit and need GitHub access token
|
||||
to make extra requests. Follow <a href="${this.getCreateTokenUrl()}" target="_blank">this link</a>
|
||||
to create one and paste it below.`
|
||||
`你已经超过GitHub API小时限制和需要GitHub访问令牌进行额外的请求.
|
||||
<a href="${this.getCreateTokenUrl()}" target="_blank">点此</a>
|
||||
去创建一个access token并粘贴到下面.`
|
||||
needAuth = true
|
||||
break
|
||||
} else {
|
||||
error = 'Forbidden'
|
||||
error = '禁止访问'
|
||||
message =
|
||||
`禁止访问.
|
||||
你可能需要提供 access token.
|
||||
|
|
@ -168,7 +165,7 @@ class Adapter {
|
|||
break
|
||||
}
|
||||
cb({
|
||||
error: `Error: ${error}`,
|
||||
error: `错误信息: ${error}`,
|
||||
message: message,
|
||||
needAuth: needAuth
|
||||
})
|
||||
|
|
@ -189,7 +186,7 @@ class Adapter {
|
|||
* @api protected
|
||||
*/
|
||||
getCssClass() {
|
||||
throw new Error('Not implemented')
|
||||
throw new Error('没有实现的方法')
|
||||
}
|
||||
|
||||
/**
|
||||
|
|
@ -214,7 +211,7 @@ class Adapter {
|
|||
* @api public
|
||||
*/
|
||||
loadCodeTree(opts, cb) {
|
||||
throw new Error('Not implemented')
|
||||
throw new Error('没有实现的方法')
|
||||
}
|
||||
|
||||
/**
|
||||
|
|
@ -222,7 +219,7 @@ class Adapter {
|
|||
* @api public
|
||||
*/
|
||||
getCreateTokenUrl() {
|
||||
throw new Error('Not implemented')
|
||||
throw new Error('没有实现的方法')
|
||||
}
|
||||
|
||||
/**
|
||||
|
|
@ -230,7 +227,7 @@ class Adapter {
|
|||
* @api public
|
||||
*/
|
||||
updateLayout(togglerVisible, sidebarVisible, sidebarWidth) {
|
||||
throw new Error('Not implemented')
|
||||
throw new Error('没有实现的方法')
|
||||
}
|
||||
|
||||
/**
|
||||
|
|
@ -238,7 +235,7 @@ class Adapter {
|
|||
* @api public
|
||||
*/
|
||||
getRepoFromPath(showInNonCodePage, currentRepo, token, cb) {
|
||||
throw new Error('Not implemented')
|
||||
throw new Error('没有实现的方法')
|
||||
}
|
||||
|
||||
/**
|
||||
|
|
@ -282,7 +279,7 @@ class Adapter {
|
|||
* @api protected
|
||||
*/
|
||||
_getTree(path, opts, cb) {
|
||||
throw new Error('Not implemented')
|
||||
throw new Error('没有实现的方法')
|
||||
}
|
||||
|
||||
/**
|
||||
|
|
@ -291,7 +288,7 @@ class Adapter {
|
|||
* @api protected
|
||||
*/
|
||||
_getSubmodules(tree, opts, cb) {
|
||||
throw new Error('Not implemented')
|
||||
throw new Error('没有实现的方法')
|
||||
}
|
||||
|
||||
/**
|
||||
|
|
|
|||
|
|
@ -171,19 +171,34 @@ class Oschina extends PjaxAdapter {
|
|||
_get(path, opts, cb) {
|
||||
const host = location.href.startsWith("https") ? 'https://git.oschina.net/api/v5' : 'http://git.oschina.net/api/v5'
|
||||
var url = `${host}/repos/${opts.repo.username}/${opts.repo.reponame}${path || ''}`
|
||||
var request = (retry) => {
|
||||
if (!retry && opts.token) {
|
||||
url += (url.indexOf("?") >= 0 ? "&" : "?") + `access_token=${opts.token}`
|
||||
}
|
||||
const cfg = {
|
||||
url,
|
||||
method: 'GET',
|
||||
cache: false,
|
||||
xhrFields: {
|
||||
withCredentials: true
|
||||
},
|
||||
}
|
||||
|
||||
if (opts.token) {
|
||||
url += (url.indexOf("?") >= 0 ? "&" : "?") + `access_token=${opts.token}`
|
||||
$.ajax(cfg)
|
||||
.done((data) => {
|
||||
if (path && path.indexOf('/git/trees') === 0 && data.truncated) {
|
||||
this._handleError({ status: 206 }, cb)
|
||||
}
|
||||
else cb(null, data)
|
||||
})
|
||||
.fail((jqXHR) => {
|
||||
if (retry) {
|
||||
request(false)
|
||||
} else {
|
||||
this._handleError(jqXHR, cb)
|
||||
}
|
||||
})
|
||||
}
|
||||
const cfg = { url, method: 'GET', cache: false }
|
||||
|
||||
$.ajax(cfg)
|
||||
.done((data) => {
|
||||
if (path && path.indexOf('/git/trees') === 0 && data.truncated) {
|
||||
this._handleError({ status: 206 }, cb)
|
||||
}
|
||||
else cb(null, data)
|
||||
})
|
||||
.fail((jqXHR) => this._handleError(jqXHR, cb))
|
||||
request(true)
|
||||
}
|
||||
}
|
||||
|
|
|
|||
Loading…
Reference in New Issue