Skip to content

Commit 1abfdda

Browse files
committed
merged in jsdoc template
1 parent ba7f2b2 commit 1abfdda

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

42 files changed

+2720
-2
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ lib-cov
1313
data/
1414
out/
1515
docs/public
16+
public/
1617

1718
# Directory for dbs
1819
db

.npmignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ examples/
2121
test/
2222
out/
2323
performance/
24+
public/
2425
.coverage_data/
2526
docs/public
2627

Makefile

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
NODE = node
2+
NPM = npm
3+
JSDOC = jsdoc
4+
name = all
5+
6+
generate_docs:
7+
hugo -s docs/ -d ../public
8+
$(JSDOC) -c conf.json -t docs/jsdoc-template/ -d ./public/api
9+
cp -R ./public/api/scripts ./public/.
10+
cp -R ./public/api/styles ./public/.
11+
12+
.PHONY: total

docs/config.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ MetaDataFormat = "yaml"
88
[[menu.main]]
99
name = "api"
1010
pre = "<i class='fa fa-file-text'></i>"
11+
url = "/api-docs/index.html"
1112
weight = -90
1213
[[menu.main]]
1314
name = "about driver"

docs/content/api-docs/index.html

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
aliases:
3+
- /doc/installing/
4+
date: 2013-07-01
5+
menu:
6+
main:
7+
parent: api
8+
title: API Documentation
9+
weight: 15
10+
---
11+
<iframe src="/api/index.html" frameborder="0" style="overflow:hidden;height:100%;width:100%" height="100%" width="100%"></iframe>

docs/content/overview/quickstart.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ date: 2013-07-01
55
menu:
66
main:
77
parent: getting started
8-
next: /overview/installing
9-
prev: /overview/introduction
8+
next: /overview/introduction
9+
prev: /overview/installing
1010
title: QuickStart
1111
weight: 20
1212
---

0 commit comments

Comments
 (0)