github1s README

The project's README from github.com/conwnet/github1s. As one markdown file: README.md.

GitHub1s

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

VS Code - GitHub1s

You can also use https://gitlab1s.com or https://npmjs1s.com in the same way.

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' })

Develop in the cloud

To edit files, run Docker containers, create pull requests and more, click the "Develop your project on Gitpod" button in the status bar. You can also open the Command Palette (default shortcut Ctrl+Shift+P) and choose GitHub1s: Edit files in Gitpod.

Gitpod Status Bar

Documentation

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

VS Code - GitHub1s

VS Code - GitHub1s

Development

Cloud-based development

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

Gitpod ready-to-code

Local development

git clone [email protected]:conwnet/github1s.git
cd github1s
npm install
npm run watch
# The cli will automatically open http://localhost:8080 once the build is completed.
# You can visit http://localhost:8080/conwnet/github1s if it doesn't.

Local development with full VS Code build

You need these prerequisites (the same ones as for VS Code) for development with full VS Code build. Please make sure you could build VS Code locally before the watch mode.

To verify the build:

cd github1s
npm run build:vscode

After the initial successful build, you could use the watch mode:

cd github1s
npm install
npm run watch-with-vscode
# The cli will automatically open http://localhost:8080 once the build is completed.
# You can visit http://localhost:8080/conwnet/github1s if it doesn't.

... 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 npm install commands listed above.

npm install
npm run watch
# The cli will automatically open http://localhost:8080 once the build is completed.
# You can visit http://localhost:8080/conwnet/github1s if it doesn't.

Format all codes

npm run format

It uses prettier to format all possible codes.

Build

npm install
npm run build

Feedback

Sponsors

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

Partners

We are partnered with OSS Insight to get the Trending Repositories & some more Interesting Analytics. OSS Insight provides deep insights into GitHub repos, developers, and curated repo lists from billions of GitHub events. It’s built with TiDB Cloud.

Maintainers! :blush:


netcon
💻 🖋
xcv58
💻 🖋
Siddhant Khare
💻 🖋

Stargazers over time

Stargazers over time

Third-party Related Projects

Chrome Extensions

Firefox Extensions

Microsoft Edge Extensions

Safari Extension

Tampermonkey scripts

github1s (conwnet/github1s)

code-editor
Searching Database…

23.3K ·GitHub
Github1s
What is this?github1s is a free web app that opens any GitHub repository in a full VS Code-style editor right in your browser, so you read code with a file tree and editor instead of clicking through github.com page by page.
Is it a website I visit, or something I have to install?It is just a website — github1s.com — nothing to install. There are also optional browser extensions and a bookmarklet, listed in the README as third-party projects, if you want one-click jumps from github.com.
How do I open a repository with it?Add 1s right after github in the browser address bar — github.com/user/repo becomes github1s.com/user/repo — and press Enter. It works for any repository URL you can open.
Does it work with private repositories?Yes, but you need to add a GitHub OAuth token via the icon at the bottom of the left icon row — the dialog even takes you to GitHub's token settings page to generate one. The token never leaves your browser except to fetch your files from GitHub.
Why is it called github1s?The name is the URL trick itself: insert 1s into the domain and github.com becomes github1s.com — the repo opens in a VS Code view in about one second.
Is it free to use?Yes. The website costs nothing, and the whole project is open source under the MIT license.
Which browsers have ready-made extensions for it?Community builds exist for Chrome, Firefox, Microsoft Edge and Safari, plus Tampermonkey scripts — all listed under Third-party Related Projects in the README.
What are similar projects?git-history, core, monaco-editor, refined-github, awesome-vscode, BrowserKitten, agentbox, LunarVim
Which topics is it in?code-editor, ide, vscode, browser-extension, github, browser, developers, web-app, productivity, agent, frontend, tool
Creator
conwnet
Size
19.4 MB
Stars
23.3K
Updated
CommitOct 15Releasev0.35.3Oct 09
Age
7y
Commits · 90 Days