2013-05-21 22:34:42 +00:00
|
|
|
StackEdit theming guide
|
|
|
|
|
=======================
|
2013-05-21 23:07:55 +00:00
|
|
|
|
2013-09-16 00:13:17 +00:00
|
|
|
In **StackEdit**, a theme is pretty much a [LESS][1] file that overrides the default look and feel.
|
2013-05-21 23:07:55 +00:00
|
|
|
|
2013-09-16 00:13:17 +00:00
|
|
|
### Create your special theme very quickly by following these steps
|
2013-05-21 23:07:55 +00:00
|
|
|
|
2013-09-16 00:13:17 +00:00
|
|
|
1. Fork **StackEdit** on [GitHub][2] and clone the repository localy.
|
2013-05-21 23:07:55 +00:00
|
|
|
|
2013-09-16 00:16:13 +00:00
|
|
|
2. Install the development tools as described in the [Developer guide][3].
|
2013-05-21 23:07:55 +00:00
|
|
|
|
2013-09-16 00:13:17 +00:00
|
|
|
3. In `res/themes`, create a LESS file, just like the other themes.
|
2013-05-21 23:07:55 +00:00
|
|
|
|
2013-09-16 00:13:17 +00:00
|
|
|
> You can put images in `res/img`.
|
2013-05-21 23:07:55 +00:00
|
|
|
|
2014-01-19 18:54:54 +00:00
|
|
|
4. Add an entry in `THEME_LIST` at the end of `public/res/constants.js` with the filename as a key and the name of your theme as a value.
|
2013-05-21 23:07:55 +00:00
|
|
|
|
2013-09-16 00:13:17 +00:00
|
|
|
> **Example:** `"cool": "The coolest ever"`
|
2013-05-21 23:07:55 +00:00
|
|
|
|
2013-09-16 00:13:17 +00:00
|
|
|
5. Run the application on your machine using the `?debug` flag. Basically:
|
|
|
|
|
|
|
|
|
|
http://localhost/stackedit/?debug
|
|
|
|
|
|
|
|
|
|
6. Go to `Settings -> Editor -> Theme` and select your theme. Check that everything is fine.
|
2013-05-21 23:07:55 +00:00
|
|
|
|
2013-09-16 00:13:17 +00:00
|
|
|
7. Commit, push, create a pull request and wait for publishing.
|
2013-05-21 23:16:57 +00:00
|
|
|
|
|
|
|
|
|
2013-05-21 23:07:55 +00:00
|
|
|
> Written with [StackEdit](http://benweet.github.io/stackedit/).
|
|
|
|
|
|
|
|
|
|
|
2013-09-16 00:13:17 +00:00
|
|
|
[1]: http://lesscss.org/
|
|
|
|
|
[2]: https://github.com/benweet/stackedit
|
2014-01-19 18:54:54 +00:00
|
|
|
[3]: https://github.com/benweet/stackedit/blob/master/doc/developer-guide.md#getting-started
|
