Skip to content

Brackets-Themes/BoilerPlate

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

26 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

BoilerPlate

This is a boilerplate project to get you started with the essentials to create your new theme as an extension. Clone this repo and start customizing your theme by modifying main.less.

In order to install your new theme, you need to publish it to a git repo and install it via the extension manager.

How do you manually install a Theme?

We will use this boilerplate to illustrate a simple workflow.

  1. Install the boilerplate theme by going through Brackets extension manager and install it using the URL https://github.com/Brackets-Themes/BoilerPlate.
  2. Or you can bundle it up as a zip and drag the zip into the extension manager.
  3. Select the Brackets View menu and click Themes…
  4. Choose "Title for my theme" to select the boilerplate as the theme.
  5. That's it!

Customizing BoilerPlate

Now that you have installed and selected boilerplate theme, you can customize it. Since the theme was installed as an extension, you will need to navigate to the extensions folder to get to the theme. Go ahead and do that and open main.less, and start adding your favorite colors. Notice that when you make changes to main.less, the changes will automatically be applied when you save those changes. I personally do all my customization to main.less right from Brackets so that I can see my changes right as I work.

Important bits of a Theme extension

  1. The most important bit, the theme file. This can be a css or a less file with all your css rules. This is the file you modify when you want to make your own custom theme. In BoilerPlate, it is main.less.
  2. It needs a package.json, the same way all other Brackets extensions need one.
  3. The package.json must have a theme object. This object as of right now contains a file field, which is the file name; in the case of BoilerPlate, it is "main.less". Another field is dark, which is a boolean that tells Brackets to setup an all around dark theme.
  4. It must have a name field, with the name for the theme. In BoilerPlate the name is simply "boilerplate".
  5. Brackets 0.44 and ealier required themes to include an empty main.js file in order to be installed. This is no longer the case with Brackets 1.0, and it not included in BoilerPlate. However, you may still include this file for short-term support of older releases.

About

Boilerplate theme for brackets

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages