pulsar-edit/pulsar
1
1
Fork 0
mirror of https://github.com/pulsar-edit/pulsar.git synced 2024-09-21 16:08:24 +03:00
Code Issues Packages Projects Releases Wiki Activity
beb000ceaf
pulsar/docs/authoring-themes.md
Nathan Sobo da36db22da Major documentation reorganization. 
The goal is to start with the shortest overview possible of all the
major features, then get into more detail later in the documentation.
2013-02-15 14:13:54 -07:00

2.1 KiB
Raw Blame History

Authoring A Theme

If you understand CSS, you can write an Atom theme easily. Your theme can style Atom's user interface, specify the appearance of syntax-highlighted code, or both. For making a syntax highlighting theme, refer to section 12.4 of the TextMate Manual for a list of the common scopes used by TextMate grammars. You'll just need to translate scope names to CSS classes. To theme Atom's user interface, take a look at the existing light and dark themes for an example. Pressing alt-meta-i and inspecting the Atom's markup directly can also be helpful.

The most basic theme is just a .css file. More complex themes occupy their own folder, which can contain multiple stylesheets along with an optional package.cson file containing a manifest to control their load-order:

~/.atom/themes/
  rockstar.css
  rainbow/
    package.json
    core.css
    editor.css
    tree-view.css

package.cson:

stylesheets: ["core.css", "editor.less", "tree-view.css"]

The package.cson file specifies which stylesheets to load and in what order with the stylesheets key. If no manifest is specified, all stylesheets are loaded in alphabetical order when the user selects the theme.

Theme Extensions (Not Yet Implemented)

A theme may need to be extended to cover DOM elements that are introduced by a third-party Atom package. When a package is loaded, stylesheets with the same name as the package will automatically be loaded from the packages directory of active themes:

~/.atom/themes/
  midnight/midnight.less
  midnight/packages/terminal.less
  midnight/packages/tree-view.less

In the example above, if the midnight theme is active, its terminal and tree-view stylesheets will be loaded automatically if and when those packages are activated. If you author an extension to a theme consider sending its author a pull request to have it included in the theme by default. Package-specific theme stylesheets need not be listed in the theme's package.json because they will be loaded automatically when the package is loaded.