File tree Expand file tree Collapse file tree 6 files changed +15
-8
lines changed Expand file tree Collapse file tree 6 files changed +15
-8
lines changed Original file line number Diff line number Diff line change @@ -18,7 +18,7 @@ https://microbit-foundation.github.io/microbit-universal-hex/.
18
18
19
19
## Web Tool
20
20
21
- <img width =" 30 %" alt =" microbit-universal-hex logo " src =" docs/img/web-tool-screenshot.png " align =" left " >
21
+ <img width =" 18 %" alt =" microbit-universal-hex logo " src =" docs/img/web-tool-screenshot.png " align =" left " >
22
22
23
23
An implementation example can be found in the
24
24
[ docs/examples/webtool.html] ( docs/examples/webtool.html ) file. This web tool can
@@ -31,4 +31,4 @@ https://tech.microbit.org/software/universal-hex-creator/
31
31
32
32
This software is under the MIT open source license.
33
33
34
- SPDX-License-Identifier: MIT
34
+ [ SPDX-License-Identifier: MIT] ( LICENSE.md )
Original file line number Diff line number Diff line change @@ -11,6 +11,11 @@ kramdown:
11
11
exclude :
12
12
- api-readme.md
13
13
14
+ # Need to include files with underscore for Typedoc output pages
15
+ include :
16
+ - ' _*_.html'
17
+ - ' _*_.*.html'
18
+
14
19
# Just The Docs settings
15
20
16
21
logo : ' img/microbit-uh-logo-text.png'
Original file line number Diff line number Diff line change @@ -7,9 +7,11 @@ nav_order: 3
7
7
# API Documentation
8
8
9
9
The API documentation is generated independently of the rest of these docs and
10
- can be found here :
10
+ can be found in this URL :
11
11
[ https://microbit-foundation.github.io/microbit-universal-hex/api/ ] ( https://microbit-foundation.github.io/microbit-universal-hex/api/ )
12
12
13
+ [ Click here to open the API docs] ( api/ ) {: .btn .btn-purple }
14
+
13
15
The source code is well annotated with docstring and
14
16
[ TypeDoc] ( http://typedoc.org ) is used to generate the API pages.
15
17
Original file line number Diff line number Diff line change @@ -10,7 +10,7 @@ nav_order: 1
10
10
11
11
{: .fs-9 }
12
12
13
- <img alt =" microbit-universal-hex logo " src =" img/microbit-uh-logo.png " style =" max-height : 164 px ; float : left ; padding-right : 16px ;" >
13
+ <img alt =" microbit-universal-hex logo " src =" img/microbit-uh-logo.png " style =" max-height : 160 px ; float : left ; padding-right : 16px ;" >
14
14
15
15
Create Universal Hex files for the micro: bit .
16
16
{: .fs-6 .fw-300 }
@@ -25,10 +25,10 @@ Create Universal Hex files for the micro:bit.
25
25
26
26
This is the documentation for the micro: bit Universal Hex library.
27
27
28
- The original hex files for the micro: bit were using the
29
- [ Intel Hex format] ( https://en.wikipedia.org/wiki/Intel_HEX ) . With the micro : bit
30
- V2 release a new hex format was created to be able to flash any micro : bit
31
- version with a single file.
28
+ Originally the micro: bit hex files used the
29
+ [ Intel Hex format] ( https://en.wikipedia.org/wiki/Intel_HEX ) and with the
30
+ micro : bit V2 release a new hex format was created to be able to flash any
31
+ micro : bit board version with a single file.
32
32
33
33
The Universal Hex file format can contain the binary data for multiple micro: bit
34
34
board versions and this TypeScript/JavaScript library can be used to create a
You can’t perform that action at this time.
0 commit comments