diff --git a/docs/creating-a-theme.md b/docs/creating-a-theme.md index 244272b66..2116df7c8 100644 --- a/docs/creating-a-theme.md +++ b/docs/creating-a-theme.md @@ -33,7 +33,7 @@ Let's create your first theme. To get started, hit `cmd-shift-P`, and start typing "Generate Syntax Theme" to generate a new theme package. Select "Generate Syntax Theme," and you'll be asked for the path where your theme will be created. Let's call ours -_motif-syntax_. Please suffix syntax themes with _-syntax_ and ui themes with _-ui_. +_motif-syntax_. __Tip:__ suffix syntax themes with _-syntax_! Atom will pop open a new window, showing the _motif-syntax_ theme, with a default set of folders and files created for us. If you open the settings view (`cmd-,`) @@ -72,13 +72,14 @@ To create an interface UI theme, do the following: 2. Clone the forked repository to the local filesystem 3. Open a terminal in the forked theme's directory 4. Open your new theme in a Dev Mode Atom window run `atom --dev .` in the - terminal or use the _View > Developer > Open in Dev Mode_ menu) + terminal or use the _View > Developer > Open in Dev Mode_ menu 5. Change the name of the theme in the theme's `package.json` file -6. Run `apm link` to symlink your repository to `~/.atom/packages` -7. Reload Atom using `cmd-alt-ctrl-L` -8. Enable the theme via _UI Theme_ drop-down in the _Themes_ section of the +6. Name your theme with a `-ui` suffix. i.e. `super-white-ui` +7. Run `apm link` to symlink your repository to `~/.atom/packages` +8. Reload Atom using `cmd-alt-ctrl-L` +9. Enable the theme via _UI Theme_ drop-down in the _Themes_ section of the settings view -9. Make changes! Since you opened the theme in a Dev Mode window, changes will +10. Make changes! Since you opened the theme in a Dev Mode window, changes will be instantly reflected in the editor without having to reload. ## Development workflow