Преглед на файлове

Update website

customisations
alemart преди 9 месеца
родител
ревизия
233f6830dc

+ 3
- 3
README.md Целия файл

@@ -2,9 +2,9 @@
2 2
 
3 3
 [![GitHub release (latest by date)](https://img.shields.io/github/v/release/alemart/encantar-js)](https://github.com/alemart/encantar-js/releases/) ![GitHub file size in bytes on a specified ref (branch/commit/tag)](https://img.shields.io/github/size/alemart/encantar-js/dist/encantar.min.js?branch=master&label=minified%20js) [![GitHub Repo stars](https://img.shields.io/github/stars/alemart/encantar-js?logo=github)](https://github.com/alemart/encantar-js/stargazers) [![GitHub Sponsors](https://img.shields.io/github/sponsors/alemart?logo=github)](https://github.com/sponsors/alemart/)
4 4
 
5
-The Augmented Reality engine that will enchant you!
5
+The Augmented Reality engine for the web that will enchant you!
6 6
 
7
-:magic_wand: **[Demos](https://alemart.github.io/encantar-js/demos/)** | :arrow_down: **[Download](https://alemart.github.io/encantar-js/download)** | :books: **[Learn](https://alemart.github.io/encantar-js/)** | :heart: **[Sponsor](https://github.com/sponsors/alemart)**
7
+:magic_wand: **[Demos](https://alemart.github.io/encantar-js/demos/)** | :eyes: **[Try it!](https://alemart.github.io/encantar-js/demos/hello-three/poster.html)** | :books: **[Learn](https://alemart.github.io/encantar-js/)** | :heart: **[Sponsor](https://github.com/sponsors/alemart)**
8 8
 
9 9
 ![Demo](docs/img/mage.gif)
10 10
 
@@ -17,7 +17,7 @@ The Augmented Reality engine that will enchant you!
17 17
 ## Key points
18 18
 
19 19
 * **AR everywhere**: it runs on Android, on iOS, and even on Desktop computers! Only a modern web browser is required.
20
-* **Easy to use**: just load a static HTML page! No need of heavy app downloads, API keys, subscriptions or server-side stuff.
20
+* **Easy to use**: just load a static HTML page! No need of heavy app downloads, server-side components or subscriptions.
21 21
 * **Device-agnostic**: no need of AR-capable devices! encantar.js is AR built from scratch with computer vision!
22 22
 * **Fast & powerful**: encantar.js is GPU-accelerated. It uses WebGL2 and WebAssembly for turbocharged performance.
23 23
 * **Open source**: personal, professional and educational uses are allowed.

+ 13
- 9
demos/assets/poster.css Целия файл

@@ -39,23 +39,27 @@ body {
39 39
 
40 40
 #back {
41 41
     position: fixed;
42
-    top: 0px;
43
-    right: 0px;
44
-    padding: 8px;
45
-    color: #9999a6;
46
-    background-color: #33334c;
42
+    top: 24px;
43
+    right: 24px;
44
+    padding: 16px;
45
+    color: rgb(184, 98, 184);
46
+    background-color: white;
47
+    border: 0;
48
+    border-radius: 24px;
47 49
     font-family: sans-serif;
48
-    font-size: 1em;
50
+    font-size: 1.25em;
51
+    font-weight: bold;
49 52
     text-decoration: underline;
50
-    transition: color 0.125s;
53
+    transition: transform 0.25s;
51 54
 }
52 55
 
53 56
 #back:visited {
54
-    color: #9999a6;
57
+    color: rgb(184, 98, 184);
55 58
 }
56 59
 
57 60
 #back:active, #back:hover {
58
-    color: white;
61
+    color: rgb(184, 98, 184);
62
+    transform: scale(1.1);
59 63
 }
60 64
 
61 65
 #prev, #next {

+ 1
- 1
demos/hello-aframe/poster.html Целия файл

@@ -14,7 +14,7 @@
14 14
         <nav>
15 15
             <a id="prev" href="#"></a>
16 16
             <a id="next" href="#"></a>
17
-            <a id="back" href="https://alemart.github.io/encantar-js" target="_blank" rel="external">Back to encantar.js</a>
17
+            <a id="back" href="https://alemart.github.io/encantar-js/download" target="_blank" rel="external">Get encantar.js</a>
18 18
         </nav>
19 19
         <section id="qr-code-area">
20 20
             <h4>QR code</h4>

+ 1
- 1
demos/hello-babylon/poster.html Целия файл

@@ -14,7 +14,7 @@
14 14
         <nav>
15 15
             <a id="prev" href="#"></a>
16 16
             <a id="next" href="#"></a>
17
-            <a id="back" href="https://alemart.github.io/encantar-js" target="_blank" rel="external">Back to encantar.js</a>
17
+            <a id="back" href="https://alemart.github.io/encantar-js/download" target="_blank" rel="external">Get encantar.js</a>
18 18
         </nav>
19 19
         <section id="qr-code-area">
20 20
             <h4>QR code</h4>

+ 1
- 1
demos/hello-three/poster.html Целия файл

@@ -14,7 +14,7 @@
14 14
         <nav>
15 15
             <a id="prev" href="#"></a>
16 16
             <a id="next" href="#"></a>
17
-            <a id="back" href="https://alemart.github.io/encantar-js" target="_blank" rel="external">Back to encantar.js</a>
17
+            <a id="back" href="https://alemart.github.io/encantar-js/download" target="_blank" rel="external">Get encantar.js</a>
18 18
         </nav>
19 19
         <section id="qr-code-area">
20 20
             <h4>QR code</h4>

+ 1
- 1
demos/hello-webgl/poster.html Целия файл

@@ -14,7 +14,7 @@
14 14
         <nav>
15 15
             <a id="prev" href="#"></a>
16 16
             <a id="next" href="#"></a>
17
-            <a id="back" href="https://alemart.github.io/encantar-js" target="_blank" rel="external">Back to encantar.js</a>
17
+            <a id="back" href="https://alemart.github.io/encantar-js/download" target="_blank" rel="external">Get encantar.js</a>
18 18
         </nav>
19 19
         <section id="qr-code-area">
20 20
             <h4>QR code</h4>

+ 1
- 1
demos/hello-world/poster.html Целия файл

@@ -14,7 +14,7 @@
14 14
         <nav>
15 15
             <a id="prev" href="#"></a>
16 16
             <a id="next" href="#"></a>
17
-            <a id="back" href="https://alemart.github.io/encantar-js" target="_blank" rel="external">Back to encantar.js</a>
17
+            <a id="back" href="https://alemart.github.io/encantar-js/download" target="_blank" rel="external">Get encantar.js</a>
18 18
         </nav>
19 19
         <section id="qr-code-area">
20 20
             <h4>QR code</h4>

+ 1
- 1
demos/pointer-demo/poster.html Целия файл

@@ -14,7 +14,7 @@
14 14
         <nav>
15 15
             <a id="prev" href="#"></a>
16 16
             <a id="next" href="#"></a>
17
-            <a id="back" href="https://alemart.github.io/encantar-js" target="_blank" rel="external">Back to encantar.js</a>
17
+            <a id="back" href="https://alemart.github.io/encantar-js/download" target="_blank" rel="external">Get encantar.js</a>
18 18
         </nav>
19 19
         <section id="qr-code-area">
20 20
             <h4>QR code</h4>

+ 0
- 37
docs/getting-started/index.md Целия файл

@@ -1,37 +0,0 @@
1
-# Welcome to encantar.js!
2
-
3
-[![GitHub release (latest by date)](https://img.shields.io/github/v/release/alemart/encantar-js)](https://github.com/alemart/encantar-js/releases/) ![GitHub file size in bytes on a specified ref (branch/commit/tag)](https://img.shields.io/github/size/alemart/encantar-js/dist/encantar.min.js?branch=master&label=minified%20js) [![GitHub Repo stars](https://img.shields.io/github/stars/alemart/encantar-js?logo=github)](https://github.com/alemart/encantar-js/stargazers) [![GitHub Sponsors](https://img.shields.io/github/sponsors/alemart?logo=github)](https://github.com/sponsors/alemart/)
4
-
5
-**encantar.js** is the Augmented Reality engine that will enchant you!
6
-
7
-[:sparkles: Demos](../demos.md){ .md-button ._blank } [:arrow_down: Download](../download.md){ .md-button ._blank } [:books: Learn](./introduction.md){ .md-button } [:heart:{ .heart } Sponsor](../support-my-work.md){ .md-button }
8
-
9
-## Features
10
-
11
-* **Image tracking**: track detailed images such as book covers, cartoons and photos. No need of manual training!
12
-* **Pointer tracking**: create interactive experiences based on touch and mouse input with an easy-to-use API.
13
-* **Plugins**: use encantar.js with the 3D framework of your choice, including A-Frame, Babylon.js, Three.js and more!
14
-
15
-## Key points
16
-
17
-* **AR everywhere**: it runs on Android, on iOS, and even on Desktop computers! Only a modern web browser is required.
18
-* **Easy to use**: just load a static HTML page! No need of heavy app downloads, API keys, subscriptions or server-side stuff.
19
-* **Device-agnostic**: no need of AR-capable devices! encantar.js is AR built from scratch with computer vision!
20
-* **Fast & powerful**: encantar.js is GPU-accelerated. It uses WebGL2 and WebAssembly for turbocharged performance.
21
-* **Open source**: personal, professional and educational uses are allowed.
22
-
23
-## Browser compatibility
24
-
25
-encantar.js is compatible with all major web browsers:
26
-
27
-| Chrome | Edge | Firefox | Opera | Safari* |
28
-|:------:|:----:|:-------:|:-----:|:-------:|
29
-| :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
30
-
31
-\* use Safari 15.2 or later.
32
-
33
-encantar.js requires WebGL2 and WebAssembly, which are widely supported.
34
-
35
-## About
36
-
37
-encantar.js is developed by [Alexandre Martins](https://github.com/alemart) and released under the [LGPL](../license.md). It is based on [Speedy Vision](https://github.com/alemart/speedy-vision).

+ 39
- 4
docs/index.md Целия файл

@@ -1,4 +1,39 @@
1
----
2
-template: index.html
3
-title: ""
4
----
1
+# Welcome to encantar.js!
2
+
3
+[![GitHub release (latest by date)](https://img.shields.io/github/v/release/alemart/encantar-js)](https://github.com/alemart/encantar-js/releases/) ![GitHub file size in bytes on a specified ref (branch/commit/tag)](https://img.shields.io/github/size/alemart/encantar-js/dist/encantar.min.js?branch=master&label=minified%20js) [![GitHub Repo stars](https://img.shields.io/github/stars/alemart/encantar-js?logo=github)](https://github.com/alemart/encantar-js/stargazers) [![GitHub Sponsors](https://img.shields.io/github/sponsors/alemart?logo=github)](https://github.com/sponsors/alemart/)
4
+
5
+The Augmented Reality engine for the web that will enchant you!
6
+
7
+[:sparkles: Demos](./demos.md){ .md-button ._blank }
8
+[:eyes: Try it!](https://alemart.github.io/encantar-js/demos/hello-three/poster.html){ .md-button ._blank }
9
+[:books: Learn](./getting-started/introduction.md){ .md-button } [:heart:{ .heart } Sponsor](./support-my-work.md){ .md-button }
10
+
11
+## Features
12
+
13
+* **Image tracking**: track detailed images such as book covers, cartoons and photos. No need of manual training!
14
+* **Pointer tracking**: create interactive experiences based on touch and mouse input with an easy-to-use API.
15
+* **Plugins**: use encantar.js with the 3D framework of your choice, including A-Frame, Babylon.js, Three.js and more!
16
+
17
+## Key points
18
+
19
+* **AR everywhere**: it runs on Android, on iOS, and even on Desktop computers! Only a modern web browser is required.
20
+* **Easy to use**: just load a static HTML page! No need of heavy app downloads, server-side components or subscriptions.
21
+* **Device-agnostic**: no need of AR-capable devices! encantar.js is AR built from scratch with computer vision!
22
+* **Fast & powerful**: encantar.js is GPU-accelerated. It uses WebGL2 and WebAssembly for turbocharged performance.
23
+* **Open source**: personal, professional and educational uses are allowed.
24
+
25
+## Browser compatibility
26
+
27
+encantar.js is compatible with all major web browsers:
28
+
29
+| Chrome | Edge | Firefox | Opera | Safari* |
30
+|:------:|:----:|:-------:|:-----:|:-------:|
31
+| :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
32
+
33
+\* use Safari 15.2 or later.
34
+
35
+encantar.js requires WebGL2 and WebAssembly, which are widely supported.
36
+
37
+## About
38
+
39
+encantar.js is developed by [Alexandre Martins](https://github.com/alemart) and released under the [LGPL](./license.md). It is based on [Speedy Vision](https://github.com/alemart/speedy-vision).

+ 17
- 14
mkdocs.yml Целия файл

@@ -46,24 +46,27 @@ markdown_extensions:
46 46
 dev_addr: 127.0.0.1:8008
47 47
 
48 48
 nav:
49
-  - 'Home': 'index.md'
50
-  - 'Getting started':
51
-    - 'Welcome': 'getting-started/index.md'
52
-    - 'WebAR Crash Course':
53
-      - 'Introduction': 'getting-started/introduction.md'
54
-      - 'Concepts': 'getting-started/concepts.md'
55
-      - 'Set up a web server': 'getting-started/set-up-a-web-server.md'
56
-      - 'Set up the tracker': 'getting-started/set-up-the-tracker.md'
57
-      - 'Set up the session': 'getting-started/set-up-the-session.md'
58
-      - 'Activate your webcam': 'getting-started/activate-your-webcam.md'
59
-      - 'Augment the scene': 'getting-started/augment-the-scene.md'
60
-      - 'Next steps': 'getting-started/next-steps.md'
61
-    - 'Guidelines for Images': 'getting-started/guidelines-for-images.md'
62
-    - 'Questions & Answers': 'faq.md'
49
+  - 'Home':
50
+    - 'Welcome!': 'index.md'
51
+    - 'Download': 'download.md'
52
+    - 'Demos': 'demos.md'
53
+    - 'Learn': 'getting-started/introduction.md'
54
+    - 'API Reference': 'api/ar.md'
63 55
     - 'Support my work': 'support-my-work.md'
64 56
     - 'License': 'license.md'
65 57
   - 'Download': 'download.md'
66 58
   - 'Demos': 'demos.md'
59
+  - 'Learn':
60
+    - 'Introduction': 'getting-started/introduction.md'
61
+    - 'Concepts': 'getting-started/concepts.md'
62
+    - 'Set up a web server': 'getting-started/set-up-a-web-server.md'
63
+    - 'Set up the tracker': 'getting-started/set-up-the-tracker.md'
64
+    - 'Set up the session': 'getting-started/set-up-the-session.md'
65
+    - 'Activate your webcam': 'getting-started/activate-your-webcam.md'
66
+    - 'Augment the scene': 'getting-started/augment-the-scene.md'
67
+    - 'Next steps': 'getting-started/next-steps.md'
68
+    - 'Guidelines for Images': 'getting-started/guidelines-for-images.md'
69
+    - 'Questions & Answers': 'faq.md'
67 70
   - 'API':
68 71
     - 'General':
69 72
       - 'AR': 'api/ar.md'

Loading…
Отказ
Запис