Skip to content

Commit 369ad66

Browse files
committed
Add a short stub page for themes
Start of #173
1 parent 57c9f2d commit 369ad66

File tree

2 files changed

+28
-2
lines changed

2 files changed

+28
-2
lines changed

docs/.vuepress/config/locales/en/sidebar.js

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,8 @@ module.exports = {
2525
'forms',
2626
'permissions',
2727
'settings',
28-
'testing'
28+
'testing',
29+
'theme'
2930
]
3031
},
3132
{

docs/extend/theme.md

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,26 @@
1-
# Quick Start
1+
# Themes
2+
3+
Flarum "themes" are just extensions. Typically, you'll want to use the `Frontend` extender to register custom LESS and JS.
4+
Of course, you can use other extenders too: for example, you might want to support settings to allow configuring your theme.
5+
6+
You can indicate that your extension is a theme by setting the "extra.flarum-extension.category" key to "theme". For example:
7+
8+
```json
9+
{
10+
// other fields
11+
"extra": {
12+
"flarum-extension": {
13+
"category": "theme",
14+
// other fields
15+
}
16+
```
17+
18+
All this will do is show your extension in the "theme" section in the admin dashboard extension list.
19+
20+
## LESS Variable Customization
21+
22+
You can define new LESS variables in your extension's LESS files. There currently isn't an extender to modify LESS variable values in the PHP layer, but this is planned for future releases.
23+
24+
## Switching Between Themes
25+
26+
Flarum doesn't currently have a comprehensive system that would support switching between themes. This is planned for future releases.

0 commit comments

Comments
 (0)