Skip to content

Commit dd6f3a7

Browse files
docs: More tweaks to text and formatting.
1 parent 4ba01f9 commit dd6f3a7

File tree

6 files changed

+15
-8
lines changed

6 files changed

+15
-8
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ https://microbit-foundation.github.io/microbit-universal-hex/.
1818

1919
## Web Tool
2020

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">
2222

2323
An implementation example can be found in the
2424
[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/
3131

3232
This software is under the MIT open source license.
3333

34-
SPDX-License-Identifier: MIT
34+
[SPDX-License-Identifier: MIT](LICENSE.md)

docs/_config.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,11 @@ kramdown:
1111
exclude:
1212
- api-readme.md
1313

14+
# Need to include files with underscore for Typedoc output pages
15+
include:
16+
- '_*_.html'
17+
- '_*_.*.html'
18+
1419
# Just The Docs settings
1520

1621
logo: 'img/microbit-uh-logo-text.png'

docs/api-docs.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,11 @@ nav_order: 3
77
# API Documentation
88

99
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:
1111
[https://microbit-foundation.github.io/microbit-universal-hex/api/](https://microbit-foundation.github.io/microbit-universal-hex/api/)
1212

13+
[Click here to open the API docs](api/){: .btn .btn-purple }
14+
1315
The source code is well annotated with docstring and
1416
[TypeDoc](http://typedoc.org) is used to generate the API pages.
1517

docs/img/api-screenshot-2.png

72.8 KB
Loading

docs/img/api-screenshot.png

-4.88 KB
Loading

docs/index.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ nav_order: 1
1010

1111
{: .fs-9 }
1212

13-
<img alt="microbit-universal-hex logo" src="img/microbit-uh-logo.png" style="max-height: 164px; float: left; padding-right: 16px;">
13+
<img alt="microbit-universal-hex logo" src="img/microbit-uh-logo.png" style="max-height: 160px; float: left; padding-right: 16px;">
1414

1515
Create Universal Hex files for the micro:bit.
1616
{: .fs-6 .fw-300 }
@@ -25,10 +25,10 @@ Create Universal Hex files for the micro:bit.
2525

2626
This is the documentation for the micro:bit Universal Hex library.
2727

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.
3232

3333
The Universal Hex file format can contain the binary data for multiple micro:bit
3434
board versions and this TypeScript/JavaScript library can be used to create a

0 commit comments

Comments
 (0)