summaryrefslogtreecommitdiff
path: root/Readme.md
blob: a0d39f7e537e70467a387fa321a7822a5df80472 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
## Features

- adds a metabox to configurable Post-Types to create and edit Twig templates
- adds Twig support to the WP Theme & Plugin editors
  - you can even customize the CodeMirror theme

## Plugin Dependencies

- https://wordpress.org/plugins/timber-library/
- https://wordpress.org/plugins/classic-editor/

## How to use the MetaBox Feature

The plugin uses the path defined in `Timber::$locations` as the templates path or falls back to the uploads folder if none is provided.

Either adjust your `Timber::render('page.twig', $context)`-functions like this:
```
$filenames = [TimberEditor::getTemplateFilename(), 'page.twig'];
Timber::render($filenames, $context);
```

like this
```
TimberEditor::render('page.twig', $context);
# 'page.twig' serves as a fallback if the current posts's template doesn't exist
```

or like this
```
TimberEditor::renderPost('page.twig', $context);
# renderPost() automatically adds ['post' => new Timber\Post()] to the $context
```

## License

[GPL v2](LICENSE)