README.md

github1s

One second to read GitHub code with VS Code.

Usage

Just add 1s after github and press Enter in the browser address bar for any repository you want to read.

For example, try it on the VS Code repo:

https://github1s.com/microsoft/vscode

For browser extensions, see Third-party Related Projects.

Or save the following code snippet as a bookmarklet, you can use it to quickly switch between github.com and github1s.com (GitHub markdown doesn't allow js links, so just copy it into a bookmark).

javascript: window.location.href = window.location.href.replace(/github(1s)?.com/, function(match, p1) { return p1 ? 'github.com' : 'github1s.com' })

Documentation

• How it works
• Roadmap

Enabling Private Repositories

If you want to view non-public repositories, you need to add an OAuth token. The token is stored only in your browser, and only send to GitHub when fetching your repository's files. Click on the icon near the bottom of the left-hand row of icons, and the dialog box will prompt you for it, and even take you to your GitHub settings page to generate one, if needed.

Screenshots

Development

Cloud-based development

You can start an online development environment with Gitpod by clicking the following button:

Local development

You need these prerequisites (the same ones as for VS Code) for development.

$ git clone [email protected]:conwnet/github1s.git
$ cd github1s
$ yarn
$ yarn watch
$ yarn serve # in another shell
$ # Then visit http://localhost:5000 or http://localhost:5000/conwnet/github1s once the build is completed.

... or ... VS Code + Docker Development

You can use the VS Code plugin Remote-Containers Dev Container to use a Docker container as a development environment.

1. Install the Remote-Containers plugin in VS Code & Docker

2. Open the Command Palette (default shortcut Ctrl+Shift+P) and choose Remote-Containers: Clone Repository in Container Volume...

3. Enter the repo, in this case https://github.com/conwnet/github1s.git or your forked repo

4. Pick either, Create a unique volume or Create a new volume

   • Now VS Code will create the docker container and connect to the new container so you can use this as a fully setup environment!

5. Open a new VS Code Terminal, then you can run the yarn commands listed above.

$ yarn
$ yarn watch
$ yarn serve # in another shell
$ # Then visit http://localhost:5000 or http://localhost:5000/conwnet/github1s once the build is completed.

Format all codes

yarn format

It uses prettier to format all possible codes.

Build

$ yarn
$ yarn build

Feedback

• If something is not working, create an issue

• If you have a question, discuss on gitter

Project Sponsors

The continued development and maintenance of GitHub1s is made possible by these generous sponsors:

Third-party Related Projects

Chrome Extensions

• zulhfreelancer/Open in VS Code

• fhefh2015/GitHub1s_chrome_extension - Chrome Web Store

• febaoshan/edge-extensions-github-code-viewer - Chrome Web Store

• Darkempire78/Github1s-Extension

• zvizvi/Github Web IDE - Chrome Web Store

• katsuhisa91/github1s-shortcut - Chrome Web Store

Firefox Extensions

• Darkempire78/Github1s-Extension - Firefox Browser Addons
• mcherifi/github1s-firefox-addon - Firefox Browser Addons
• zvizvi/Github Web IDE - Firefox Browser Addons

Microsoft Edge Extensions

• febaoshan/edge-extensions-github-code-viewer
• zvizvi/Github Web IDE - Edge Add-ons Store

Tampermonkey scripts

• Mr-B0b/TamperMonkeyScripts/vscode.js

Maintainers! 😊

netcon 💻 🖋

xcv58 💻 🖋

Siddhant Khare 💻 🖋