Skip to content

Commit db4dcdd

Browse files
docs: Tweaks to text and formatting.
1 parent b614c92 commit db4dcdd

File tree

5 files changed

+10
-10
lines changed

5 files changed

+10
-10
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# micro:bit Universal Hex TypeScript Library
22

3+
<img width="30%" alt="microbit-universal-hex logo" src="docs/img/microbit-uh-logo.png" align="right">
4+
35
[![CircleCI](https://circleci.com/gh/microbit-foundation/microbit-universal-hex.svg?style=svg)](https://circleci.com/gh/microbit-foundation/microbit-universal-hex)
46

57
TypeScript/JavaScript library to create micro:bit Universal Hex files for
68
micro:bit.
79

8-
<img width="50%" alt="microbit-universal-hex logo" src="docs/img/microbit-uh-logo.png">
9-
1010
The Universal Hex file format was created to be able to contain the binary data
1111
for micro:bit V1 and V2 boards in a single file, so that it works in all
1212
versions of the micro:bit.

docs/_config.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ color_scheme: 'light'
2626
# Create URL anchors for headings
2727
heading_anchors: true
2828
# Footer appears at the bottom of every page's main content
29-
footer_content: 'Copyright &copy; 2017-2020 Micro:bit Educational Foundation and project contributors. Distributed under the <a href="https://github.com/microbit-foundation/microbit-universal-hex/blob/master/LICENSE.md">MIT open source license</a>.'
29+
footer_content: '&copy; 2020 Micro:bit Educational Foundation and project contributors. Distributed under the <a href="https://github.com/microbit-foundation/microbit-universal-hex/blob/master/LICENSE.md">MIT open source license</a>.'
3030

3131
# Footer "Edit this page on GitHub" link text
3232
gh_edit_link: true

docs/api-docs.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,5 +10,5 @@ The API documentation is generated independently of the rest of these docs and
1010
can be found here:
1111
[https://microbit-foundation.github.io/microbit-universal-hex/api/](https://microbit-foundation.github.io/microbit-universal-hex/api/)
1212

13-
The source code is well annotated with in-line documentation and
14-
[TypeDoc](http://typedoc.org) is used to generate the API documentation.
13+
The source code is well annotated with docstring and
14+
[TypeDoc](http://typedoc.org) is used to generate the API pages.

docs/img/microbit-uh-logo-text.png

-12 Bytes
Loading

docs/index.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,10 @@ Create Universal Hex files for the micro:bit.
1616
{: .fs-6 .fw-300 }
1717

1818
[Quick Guide](quick-guide.html){: .btn .btn-primary .mb-4 .mb-md-0 .mr-2 }
19-
[API](api/){: .btn .btn-blue .mb-4 .mb-md-0 .mr-2 }
19+
[API](api/){: .btn .btn-purple .mb-4 .mb-md-0 .mr-2 }
2020
[View it on GitHub](https://github.com/microbit-foundation/microbit-universal-hex/){: .btn .mb-4 .mb-md-0 }
2121

22-
---
22+
<br><hr>
2323

2424
This is the documentation for the micro:bit Universal Hex library.
2525

@@ -34,6 +34,6 @@ micro:bit Universal Hex from two or more micro:bit Intel Hex files.
3434

3535
## Navigation
3636

37-
⬅️ The menu on the left shows you the available documentation pages.
38-
⬆️ The header at the top contains search bar
39-
⬇️ If you'd like to contribute to the docs there is an edit link at the footer
37+
- ⬅️ The menu on the left shows you the available documentation pages.
38+
- ⬆️ The header at the top contains search bar
39+
- ⬇️ If you'd like to contribute to the docs there is an edit link at the footer

0 commit comments

Comments
 (0)