-
Notifications
You must be signed in to change notification settings - Fork 4
/
Copy pathHOWTO
38 lines (20 loc) · 1.05 KB
/
HOWTO
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
# Installation and running a local version
## Requirements
Docker
## Run documentation locally
Run `./run-local.sh` and open http://localhost:4000
# Extra
## Support and dashboard links
### Support link
By adding a `js-support` class to a link it will try to open intercom first, before opening the e-mail client.
Ex: `<a href="mailto:[email protected]" class="js-support">contact us</a>`
### Dashboard links
When APP_ID cookie is set links with js-dashboard-link will be replaced with an url to the page in href.
When no APP_ID is available these links will be disabled.
Ex: `<a href="http://app.coscale.com" db-href="/alerts/manage/" class="js-dashboard-link">`Alerts > Manage`</a>`
### Include responsive image
`<img src="{{ site.baseurl}}/gfx/installation/events/custom-attributes/automation_job_overview.png" alt="Event overview" class="img-responsive" />`
### Code highlighting
{% highlight xml %}
{% endhighlight %}
`xml` can be replaced with any language, full list available on https://github.com/jneen/rouge/wiki/List-of-supported-languages-and-lexers