Skip to content

Commit c596b37

Browse files
Merge pull request #20 from exokitxr/docs-sections
Docs sections
2 parents ae2e555 + 4c7e760 commit c596b37

19 files changed

+61
-558
lines changed

COPYsrc/index.html

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,6 @@
1414
<div class="collapse navbar-collapse" id="bigNavbar">
1515
<div class="navbar-nav">
1616
<a class="nav-item nav-link pr-4 pl-4" href="docs/"><h5 class="font-weight-normal">Docs</h2></a>
17-
<a class="nav-item nav-link pr-4 pl-4" href="faq/"><h5 class="font-weight-normal">FAQ</h2></a>
1817
<a class="nav-item nav-link pr-4 pl-4" href="community/"><h5 class="font-weight-normal">Community</h2></a>
1918
</div>
2019
</div>
@@ -37,9 +36,6 @@ <h2 style="font-family: Bison;">Exokit</h2>
3736
<div class="col-12 mb-4">
3837
<a href="docs/"><h5 class="font-weight-light">Docs</h5></a>
3938
</div>
40-
<div class="col-12 mb-4">
41-
<a href="faq/"><h5 class="font-weight-light">FAQ</h5></a>
42-
</div>
4339
<div class="col-12 mb-4">
4440
<a href="community/"><h5 class="font-weight-light">Community</h5></a>
4541
</div>

scripts/generators.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ hexo.extend.generator.register('examples', function (locals) {
1313
});
1414
}
1515

16-
addRoute('docs/', utils.createRedirectResponse(hexo, 'docs/introduction'));
17-
addRoute('faq/', utils.createRedirectResponse(hexo, 'docs/introduction/faq.html'));
16+
addRoute('docs/', utils.createRedirectResponse(hexo, 'docs/engine/'));
17+
addRoute('faq/', utils.createRedirectResponse(hexo, 'docs/engine/faq.html'));
1818

1919

2020
return routes;

scripts/redirects.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ var MASTER = 'master';
1010

1111
hexo.extend.generator.register('site-redirects', function () {
1212
return expandRedirectObjs([
13-
['faq/', join('docs', 'introduction', 'faq.html')]
13+
['faq/', join('docs', 'engine', 'faq.html')]
1414
]);
1515
});
1616

@@ -62,8 +62,8 @@ hexo.extend.generator.register('docs-redirects', function () {
6262
// getDocRootRedirectObjs()
6363
];
6464
redirectObjs.push([
65-
['docs/', 'docs/' + 'introduction/'],
66-
['docs/guide/', 'docs/' + 'introduction/']
65+
['docs/', 'docs/' + 'engine/'],
66+
['docs/guide/', 'docs/' + 'engine/']
6767
]);
6868

6969
// Flatten arrays since `redirectObjs` is an array of arrays of arrays. We just want a flat

src/docs/api/iframeAPI.md

Lines changed: 0 additions & 250 deletions
This file was deleted.

src/docs/sdk/buildFromSource.md renamed to src/docs/engine/buildFromSource.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
---
22
title: Build from Source
3-
section_title: SDK
4-
type: sdk
3+
section_title: Engine
4+
type: engine
55
layout: docs
6-
order: 0
7-
parent_section: docs
8-
section_order: 3
6+
order: 1
7+
parent_section: engine
98
---
109

10+
1111
The main project repository is at [`exokitxr/exokit`](https://github.com/exokitxr/exokit). You can clone it the regular way:
1212

1313
```sh

src/docs/sdk/debugging.md renamed to src/docs/engine/debugging.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
22
title: Debugging
3-
type: sdk
3+
type: engine
44
layout: docs
55
order: 5
6-
parent_section: sdk
6+
parent_section: engine
77
---
88

99
## Logging

src/docs/sdk/exokitCommandLineFlags.md renamed to src/docs/engine/exokitCommandLineFlags.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Command Line Flags
3-
type: sdk
3+
type: engine
44
layout: docs
55
order: 4
66
parent_section: sdk

src/docs/introduction/faq.md renamed to src/docs/engine/faq.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
22
title: FAQ
3-
type: introduction
3+
type: engine
44
layout: docs
5-
parent_section: introduction
5+
parent_section: engine
66
order: 14
77
---
88

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,11 @@
11
---
2-
title: What is Exokit?
3-
section_title: Introduction
4-
type: introduction
2+
title: Engine Overview
3+
section_title: Engine
4+
section_order: 3
5+
type: engine
56
layout: docs
67
order: 0
78
parent_section: docs
8-
section_order: 0
9-
installation: true
10-
examples:
119
---
1210

1311
## The Basics
@@ -20,12 +18,12 @@ The Exokit Engine is built using Node.js. It is primarily used to power 3d exper
2018

2119
![DumzXuYU0AEInfW](https://user-images.githubusercontent.com/29695350/57173364-27482c80-6df4-11e9-9464-c8ddf4a00ccd.jpg)
2220

23-
## Exokit and the Web
24-
Exokit provides native hooks for WebGL, WebXR, WebVR, WebAudio, and other APIs used for immersive experiences.
25-
The Exokit engine loads web pages and experiences built with your favorite frameworks like THREE.js, A-Frame, Babylon.js, etc.
21+
## Exokit Engine and the Web
22+
Exokit Engine provides native hooks for WebGL, WebXR, WebVR, WebAudio, and other APIs used for immersive experiences.
23+
The Exokit Engine loads web pages and experiences built with your favorite frameworks like THREE.js, A-Frame, Babylon.js, etc.
2624

2725
![Screenshot from 2019-03-05 19-05-23](https://user-images.githubusercontent.com/29695350/57173374-7c843e00-6df4-11e9-8e5d-9191912a11f7.png)
2826

2927
## Get started
30-
Start your journey, [download Exokit here](https://get.exokit.org/).
31-
If you are a developer, [get started developing on Exokit here](../sdk/buildFromSource).
28+
Start your journey, [download Exokit Engine here](https://get.exokit.org/).
29+
If you are a developer, [get started developing on Exokit Engine here](../sdk/buildFromSource).

0 commit comments

Comments
 (0)