Skip to content

Commit 881e88f

Browse files
Merge pull request #150 from code42/INTEG-2900/host-export-docs
host export documentation
2 parents e3c1d7b + 7c1b2fb commit 881e88f

File tree

3 files changed

+48
-0
lines changed

3 files changed

+48
-0
lines changed

docs/export.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
---
2+
hide:
3+
- navigation
4+
- toc
5+
---
6+
#
7+
<script>
8+
var opts = {
9+
scrollYOffset: 120,
10+
hideHostname: true,
11+
hideDownloadButton: true,
12+
hideSingleRequestSampleTab: true,
13+
expandResponses: 'all',
14+
theme: {
15+
colors: {
16+
primary: {
17+
main: "#333333"
18+
}
19+
},
20+
sidebar: {
21+
width: "345px",
22+
backgroundColor: "#FFFFFF",
23+
textColor: "#424242"
24+
},
25+
rightPanel: {
26+
backgroundColor: "#00284c"
27+
},
28+
typography: {
29+
headings: {
30+
fontFamily: "'proxima-nova', sans-serif",
31+
fontWeight: 700
32+
}
33+
},
34+
schema: {
35+
arrow: {
36+
size: '1.4em',
37+
color: '#1d8127'
38+
}
39+
}
40+
}
41+
};
42+
window.addEventListener('load', function () {
43+
Redoc.init("../assets/exportapi.json", opts, document.getElementById("redoc-container"))
44+
})
45+
</script>

docs/overrides/main.html

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@
77
{% block footer %}
88
{% if page.url == "api/" %}
99
{% include "partials/redoc.html" %}
10+
{% elif page.url == "export/" %}
11+
{% include "partials/redoc.html" %}
1012
{% else %}
1113
{{ super() }}
1214
{% endif %}

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ edit_uri: ""
3434
nav:
3535
- Introduction: 'index.md'
3636
- API Reference: 'api.md'
37+
- Event Data Export: 'export.md'
3738
- SDK:
3839
- Introduction: 'sdk/index.md'
3940
- Client: 'sdk/client.md'

0 commit comments

Comments
 (0)