Skip to content

Commit e3e598b

Browse files
committed
Move documentation under documentation sub menu
1 parent 1f97cb8 commit e3e598b

File tree

6 files changed

+64
-23
lines changed

6 files changed

+64
-23
lines changed

doc/configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ currentMenu: configuration
66
# Configuration
77

88
__InEngine.NET__ is configured with a JSON file called IntegrationEngine.json.
9-
The configuration file has four sections: _WebApi_, _MessageQueue_, _Mail_, and _Database_.
9+
The configuration file has several sections, outlined below.
1010

1111
### WebApi
1212

doc/couscous.yml

Lines changed: 17 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -20,18 +20,23 @@ menu:
2020
text: Change Log
2121
iconClass: 'fa fa-fw fa-refresh'
2222
relativeUrl: change-log.html
23-
configuration:
24-
text: Configuration
25-
iconClass: 'fa fa-fw fa-gear'
26-
relativeUrl: configuration.html
27-
integration-jobs:
28-
text: Integration Jobs
29-
iconClass: 'fa fa-fw fa-exchange'
30-
relativeUrl: integration-jobs.html
31-
web-api:
32-
text: Web API
33-
iconClass: 'fa fa-fw fa-cloud'
34-
relativeUrl: web-api/cron-trigger.html
23+
documentation:
24+
text: Documentation
25+
iconClass: 'fa fa-fw fa-book'
26+
relativeUrl: documentation.html
27+
items:
28+
configuration:
29+
text: Configuration
30+
iconClass: 'fa fa-fw fa-gear'
31+
relativeUrl: configuration.html
32+
integration-jobs:
33+
text: Integration Jobs
34+
iconClass: 'fa fa-fw fa-exchange'
35+
relativeUrl: integration-jobs.html
36+
web-api:
37+
text: Web API
38+
iconClass: 'fa fa-fw fa-cloud'
39+
relativeUrl: web-api/cron-trigger.html
3540

3641
webApiMenu:
3742
items:

doc/documentation.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
layout: default
3+
currentMenu: documentation
4+
---
5+
6+
# Documentation
7+
8+
## Configuration
9+
10+
The [Configuration documentation](configuration.html) describes how the values in the IntegrationEngine.json file can be set.
11+
12+
## Integration Jobs
13+
14+
The [Integration Jobs documentation](configuration.html) lists the built-in integration jobs, and explains their usage.
15+
16+
## Web API
17+
18+
The [Web API documentation](configuration.html) lists the available HTTP endpoints, and explains their usage.
19+

doc/website/css/main.css

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -147,3 +147,8 @@ pre code {
147147
letter-spacing: -2px;
148148
line-height: 100px;
149149
}
150+
151+
152+
.nav.nav-sub-items li a {
153+
padding-left: 1.6em;
154+
}

doc/website/home.twig

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@
3737
</div>
3838
<div class="jumbotron text-center">
3939
<h1>{{ title }}</h1>
40+
4041
<p class="lead">{{ subTitle }}</p>
4142
</div>
4243
</header>
@@ -45,16 +46,13 @@
4546
<div class="container">
4647
<section id="content">
4748
<div class="row text-center jumbo-nav-icons">
48-
{% for itemId, item in menu.items %}
49-
<div class="col-sm-2">
50-
<p>
51-
<a href="{{ item.absoluteUrl|default(baseUrl ~ '/' ~ item.relativeUrl) }}">
52-
<span class="{{ item.iconClass }} fa-5x"></span>
53-
<br>
54-
{{ item.text|raw }}
55-
</a>
56-
57-
<p>
49+
{% for itemId, item in menu.items if itemId != 'home' %}
50+
<div class="col-md-4">
51+
<a href="{{ item.absoluteUrl|default(baseUrl ~ '/' ~ item.relativeUrl) }}">
52+
<span class="{{ item.iconClass }} fa-5x"></span>
53+
<br>
54+
{{ item.text|raw }}
55+
</a>
5856
</div>
5957
{% endfor %}
6058
</div>

doc/website/menu-items.twig

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,18 @@
55
<span>{{ item.text|raw }}</span>
66
</a>
77
</li>
8+
{% if item.items is defined %}
9+
{% for subItemId, subItem in item.items %}
10+
<li>
11+
<ul class="nav nav-pills nav-stacked nav-sub-items">
12+
<li class="{{ subItemId == currentMenu ? 'active' }}">
13+
<a href="{{ subItem.absoluteUrl|default(baseUrl ~ '/' ~ subItem.relativeUrl) }}">
14+
<span class="{{ subItem.iconClass }}"></span>
15+
<span>{{ subItem.text|raw }}</span>
16+
</a>
17+
</li>
18+
</ul>
19+
</li>
20+
{% endfor %}
21+
{% endif %}
822
{% endfor %}

0 commit comments

Comments
 (0)