GHEdit Documentation
GHEdit is derived from Microsoft's Visual Studio Code. We developed it to learn about web-based development environments and think it is useful enough to share.
Features
- GitHub integration (view and edit repositories and files, in place)
- Complete project explorer and text editor
- Syntax highlighting and auto-complete for all major programming and markup languages
- IntelliSense for Javascript, TypeScript, JSON
- Project-wide search and replace
- Fuzzy filename search
- Side-by-side file comparison
- Themes
- Customizable Keyboard Shortcuts
- Per-user, per-project customizable editor settings
- Free and Open Source!
- Debugger
- Extensions
- Git integration
- Integrated Terminal
- Project-wide IntelliSense
- Task Runner
- Markdown Preview
Usage
- - Select one of your GitHub repositories to get started.
- - Select a file for viewing/editing from the Explorer panel on the left.
- - Edit the file as you wish!
- - Saved files are committed directly to GitHub.
- - If you don't see your private repositories, sign out, check the "Include my private repositories" box, and sign back in again.
- - Customize GHEdit User and Workspace Settings, Keyboard Shortcuts, and Color Theme.
FAQ
Q: Why did you do it?
A: We think Visual Studio Code is a great IDE and that Cloud IDEs have tremendous potential. We decided to see if VSCode could be adapted to run in the Cloud. It can!
Q: How does it work?
A: GHEdit runs entirely in the browser without server-side processing. It is hosted as a static GitHub Page and uses the GitHub API to read/write repositories and files. The only custom "back-end" is a tiny Google Cloud Function to facilitate the GitHub authorization process. User Settings are saved to a GitHub Gist.
Q: What next?
A: We're testing what people think of GHEdit and deciding what to do next. Tell us what YOU think.
Q: Why do I need to give GHEdit GitHub permissions?
A: GHEdit needs permission to operate on your behalf and to not be throttled by GitHub API rate limits.
Q: Go To Symbol, Go To Definition, and IntelliSense don't always seem to work. What's up with that?
A: GHEdit can only perform these operations across open files :(
Q: What's your privacy policy?
A: We don't retain any user information, including GitHub credentials. We use Google Analytics to monitor overall usage.