blob: 0ce126eb3e468a416aa8531e558e84f12abfad87 (
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
37
38
39
|
# Federated Wiki - Wmap Plugin
This plugin, type: wmap, extends the markup of the federated wiki.
It allows for the rendering of inline wardley maps using the wmap syntax.
## Development workflow
This project has a `Makefile` that encapsulates some of the common development
tasks.
To help with development, you can to run the plugin in a local instance of
wiki. You need to set the path of that using the `WIKIDIR` environment variable.
The `Makefile` assumes the wiki is in `../../vendor/wiki`.
```
# If your wiki directory is elsehwere.
WIKIDIR=$HOME/workspace/wiki make link
```
The source needs to be built before it can be used. `make build` builds it.
### Linking the project.
`make link` will create a link from this project to the local fedwiki instance,
so it can load the latest version of your code.
### Running the local Wiki.
`make` will run the wiki.
`make watch` will rebuild the client on any change.
### Code quality.
- Run tests with `make test`
- Format the code with `make format`
- Lint the code with `make lint`
- Generate typescript types with `make types`
|
