An open source code editor for the web, written in JavaScript, HTML and CSS.
JavaScript HTML CSS TypeScript PHP Ruby Other
Clone or download
Pull request Compare This branch is 510 commits ahead, 273 commits behind adobe:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
app fixes #86 May 8, 2017
build mac icns file Aug 31, 2016
samples Translated English to Japanese Comments (#13327) May 4, 2017
src Reenable 'Run test' menu and unit tests Nov 9, 2017
tasks update codemirror Apr 26, 2017
test Reenable 'Run test' menu and unit tests Nov 9, 2017
tools Added brackets around root_path in the mkdir directive of setup_for_h… Feb 11, 2014
.brackets.json use typescript-eslint-parser to lint sources Aug 29, 2016
.eslintrc.js Add no-unsafe-negation rule and upgrade grunt-eslint to 19.0.0 Mar 20, 2017
.eslintrc.json Merge remote-tracking branch 'adobe/master' Sep 16, 2016
.gitattributes Normalized Line Endings and added .gitattributes Feb 2, 2013
.gitignore Git ignore package-lock.json (#13827) Nov 9, 2017
.gitmodules fix install Dec 23, 2016
.npmrc Git ignore package-lock.json (#13827) Nov 9, 2017
.travis.yml remove npm prune Aug 21, 2017
CODE_OF_CONDUCT.md Add a Code of Conduct Sep 4, 2016
CONTRIBUTING.md Update 'Extension Ideas' query link so it shows both open & closed is… Aug 7, 2014
Gruntfile.js update codemirror Apr 26, 2017
ISSUE_TEMPLATE.md add a simple issue template Aug 31, 2016
LICENSE Make license year evergreen Jan 27, 2016
NOTICE Fixed a copy / paste bug. Oct 6, 2014
README.md Merge remote-tracking branch 'adobe/master' Feb 20, 2017
appveyor.yml remove npm prune Aug 21, 2017
build.json Brackets 1.10 Pre-release 2 May 22, 2017
gulpfile.js Reenable 'Run test' menu and unit tests Nov 9, 2017
npm-shrinkwrap.json Add npm-shrinkwrap.json Nov 9, 2017
package.json start on version 1.10.4 May 26, 2017
tsconfig.json update deps for 1.9.4 Feb 20, 2017
tslint.json update deps Apr 26, 2017

README.md

brackets-electron

Windows: Build status

Mac, Linux: Build Status

how does this differ to regular brackets?

Brackets-Electron x.y.z will follow x.y of Brackets releases, with z being reserved for patches and merges of latest features which are available in brackets master repository and planned to be released in the next version. This way you can preview the upcoming features without running brackets from source.

  • CEF shell is gone, improves experience mainly to Linux users
  • shell websocket server is gone, improves performance and stability for node domain code
  • node domains run in their own processes, improves perfomance as they don't block each other

how to build from master

git clone https://github.com/zaggino/brackets-electron
cd brackets-electron
git submodule update --init
npm install
npm run dist

You'll find runnable Brackets-Electron in dist-build directory.

how to hack

run npm run dev in one terminal, npm start in the other, be sure to do the usual updates (git pull, git submodule update, npm install, etc) before.

Welcome to Brackets!

Brackets is a modern open-source code editor for HTML, CSS and JavaScript that's built in HTML, CSS and JavaScript.

What makes Brackets different from other web code editors?

  • Tools shouldn't get in your way. Instead of cluttering up your coding environment with lots of panels and icons, the Quick Edit UI in Brackets puts context-specific code and tools inline.
  • Brackets is in sync with your browser. With Live Preview, Brackets works directly with your browser to push code edits instantly and jump back and forth between your real source code and the browser view.
  • Do it yourself. Because Brackets is open source, and built with HTML, CSS and JavaScript, you can help build the best code editor for the web.

Brackets may have reached version 1, but we're not stopping there. We have many feature ideas on our trello board that we're anxious to add and other innovative web development workflows that we're planning to build into Brackets. So take Brackets out for a spin and let us know how we can make it your favorite editor.

You can see some screenshots of Brackets on the wiki, intro videos on YouTube, and news on the Brackets blog.

How to install and run Brackets

Download

Installers for the latest stable build for Mac, Windows and Linux (Debian/Ubuntu) can be downloaded here.

The Linux version has most of the features of the Mac and Windows versions, but is still missing a few things. See the Linux wiki page for a list of known issues and to find out how you can help.

Additionally, for a list of common Linux installation issues and workarounds you can visit this guide.

Usage

By default, Brackets opens a folder containing some simple "Getting Started" content. You can choose a different folder to edit using File > Open Folder.

Most of Brackets should be pretty self-explanatory, but for information on how to use its unique features, like Quick Edit and Live Preview, please read How to Use Brackets. Also, see the release notes for a list of new features and known issues in each build.

In addition to the core features built into Brackets, there is a large and growing community of developers building extensions that add all sorts of useful functionality. See the Brackets Extension Registry for a list of available extensions. For installation instructions, see the extensions wiki page.

Need help?

Having problems starting Brackets the first time, or not sure how to use Brackets? Please review Troubleshooting, which helps you to fix common problems and find extra help if needed.

Helping Brackets

I found a bug!

If you found a repeatable bug, and troubleshooting tips didn't help, then be sure to search existing issues first. Include steps to consistently reproduce the problem, actual vs. expected results, screenshots, and your OS and Brackets version number. Disable all extensions to verify the issue is a core Brackets bug. Read more guidelines for filing good bugs.

I have a new suggestion, but don't know how to program!

For feature requests please first check our Trello board to see if it's already there; you can upvote it if so. If not, feel free to file it as an issue as above; we'll move it to the feature backlog for you.

I want to help with the code!

Awesome! There are lots of ways you can help. First read CONTRIBUTING.md, then learn how to pull the repo and hack on Brackets.

The text editor inside Brackets is based on CodeMirror—thanks to Marijn for taking our pull requests, implementing feature requests and fixing bugs! See Notes on CodeMirror for info on how we're using CodeMirror.

Although Brackets is built in HTML/CSS/JS, it currently runs as a desktop application in a thin native shell, so that it can access your local files. (If you just try to open the index.html file in a browser, it won't work yet.) The native shell for Brackets lives in a separate repo, adobe/brackets-shell.

I want to keep track of how Brackets is doing!

Not sure you needed the exclamation point there, but we like your enthusiasm.

What's Brackets working on next?

Contact info


Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.