2013-05-21 22:34:42 +00:00
StackEdit theming guide
=======================
2013-05-21 23:07:55 +00:00
2013-05-21 23:16:57 +00:00
In **StackEdit** , a theme is pretty much a CSS file that overrides the default look and feel.
2013-05-21 23:07:55 +00:00
2013-05-21 23:16:57 +00:00
*Create your special theme very quickly by following these steps:*
2013-05-21 23:07:55 +00:00
2013-05-21 23:32:10 +00:00
1. Fork **StackEdit** on [GitHub][1].
2013-05-21 23:07:55 +00:00
2013-05-21 23:43:09 +00:00
2. In the `themes` folder, create a sub-folder containing your resources (CSS, images...).
2013-05-21 23:07:55 +00:00
2013-05-22 00:12:47 +00:00
> The CSS file should have the same name as the sub-folder.
2013-05-21 23:07:55 +00:00
> **Example:** `themes/cool-theme/cool-theme.css`
2013-05-21 23:34:54 +00:00
3. Add an entry in `THEME_LIST` at the end of `config.js` with the folder name as a key and the name of your theme as a value.
2013-05-21 23:07:55 +00:00
2013-05-22 00:10:27 +00:00
> **Example:** `"cool-theme": "The coolest ever"`
2013-05-21 23:07:55 +00:00
2013-05-21 23:26:05 +00:00
4. Run the application on your machine, go to `Settings -> Editor -> Theme` and select your theme. Check that everything is marvelous (don't forget to test the `viewer.html` ).
2013-05-21 23:07:55 +00:00
2013-05-21 23:26:05 +00:00
5. List your resource files in `cache.manifest` , commit, push, create a pull request and wait for publishing...
2013-05-21 23:07:55 +00:00
That's it!
2013-05-21 23:26:54 +00:00
### Please, keep in mind these simple rules
2013-05-21 23:16:57 +00:00
2013-05-21 23:26:05 +00:00
- Avoid using gradients, shadows and other effects as much as possible (for performance concern).
2013-05-21 23:16:57 +00:00
- Try to create something at least as nice as the default theme...
2013-05-21 23:07:55 +00:00
> Written with [StackEdit](http://benweet.github.io/stackedit/).
[1]: https://github.com/benweet/stackedit
