Skip to content

Commit b415dee

Browse files
committed
Merge pull request #212 from Qard/knowledge-base-index
Add auto-generated index to knowledge base
2 parents 317bc49 + 9729af8 commit b415dee

File tree

5 files changed

+41
-16
lines changed

5 files changed

+41
-16
lines changed

build.js

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,10 @@ function buildlocale (source, locale) {
101101
sortBy: 'date',
102102
reverse: true,
103103
refer: false
104+
},
105+
knowledgeBase: {
106+
pattern: 'knowledge/**/*.md',
107+
refer: false
104108
}
105109
}))
106110
.use(markdown(markedOptions))

layouts/docs.hbs

Lines changed: 1 addition & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -8,22 +8,7 @@
88
<div id="main">
99
<div class="container has-side-nav">
1010

11-
<aside>
12-
<ul>
13-
<li{{#equals path site.docs.link}} class="active"{{/equals}}>
14-
<a href="/{{site.locale}}/{{site.docs.link}}/">{{site.docs.text}}</a>
15-
</li>
16-
<li{{#equals path site.docs.es6.link}} class="active"{{/equals}}>
17-
<a href="/{{site.locale}}/{{site.docs.es6.link}}/">{{site.docs.es6.text}}</a>
18-
</li>
19-
<li{{#equals path site.docs.faq.link}} class="active"{{/equals}}>
20-
<a href="/{{site.locale}}/{{site.docs.faq.link}}/">{{site.docs.faq.text}}</a>
21-
</li>
22-
<li{{#equals path site.docs.api.link}} class="active"{{/equals}}>
23-
<a href="{{site.docs.api.link}}">{{site.docs.api.text}}</a>
24-
</li>
25-
</ul>
26-
</aside>
11+
{{> docs-menu }}
2712

2813
<article>
2914
{{{ contents }}}

layouts/knowledge-base-index.hbs

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
<!DOCTYPE html>
2+
<html lang="{{site.locale}}">
3+
{{> html-head }}
4+
5+
<body>
6+
{{> header }}
7+
8+
<div id="main">
9+
<div class="container has-side-nav">
10+
11+
{{> docs-menu }}
12+
13+
<article>
14+
{{{ contents }}}
15+
16+
{{#each collections.knowledgeBase}}
17+
<li><a href="/{{../site.locale}}/{{ path }}/">{{ title }}</a></li>
18+
{{/each}}
19+
</article>
20+
21+
</div>
22+
</div>
23+
24+
{{> footer }}
25+
</body>
26+
</html>

locale/en/knowledge/index.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: Knowledge Base
3+
layout: knowledge-base-index.hbs
4+
---
5+
6+
# Knowledge Base

locale/en/site.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,10 @@
7373
"api": {
7474
"link": "/api/",
7575
"text": "API"
76+
},
77+
"knowledge": {
78+
"link": "knowledge",
79+
"text": "Knowledge Base"
7680
}
7781
},
7882
"foundation": {

0 commit comments

Comments
 (0)