-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Showing
5 changed files
with
80 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
remote_theme: pmarsceill/just-the-docs | ||
|
||
# Markdown settings: https://jekyllrb.com/docs/configuration/markdown/ | ||
kramdown: | ||
# GitHub flavoured markdown | ||
input: GFM | ||
# Interprets line breaks literally | ||
hard_wrap: false | ||
|
||
# Just The Docs settings | ||
|
||
# Enable or disable the site search | ||
search_enabled: true | ||
# Aux links for the upper right navigation | ||
aux_links: | ||
'View on GitHub': | ||
- 'https://github.com/microbit-foundation/microbit-universal-hex/' | ||
# Color scheme currently only supports "dark" or nil (default) | ||
color_scheme: 'light' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
--- | ||
layout: page | ||
title: Contributing | ||
nav_order: 3 | ||
--- | ||
|
||
# Contributing | ||
|
||
{: .no_toc } | ||
|
||
## Table of contents | ||
|
||
{: .no_toc .text-delta } | ||
|
||
1. TOC | ||
{:toc} | ||
|
||
## How To Contribute | ||
|
||
WIP. | ||
|
||
## Code Of Conduct | ||
|
||
WIP. | ||
|
||
## Bugs | ||
|
||
Issue tracker: https://github.com/microbit-foundation/microbit-fs/issues | ||
|
||
## Development Workflow | ||
|
||
- `npm install` to install dependencies | ||
- `npm test` runs the complete test suite | ||
- `npm build` create a build with all the output formats |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
--- | ||
layout: default | ||
title: Home | ||
homepage: true | ||
permalink: / | ||
nav_order: 1 | ||
--- | ||
|
||
# micro:bit Universal Hex | ||
|
||
{: .fs-9 } | ||
|
||
<img alt="microbit-universal-hex logo" src="img/microbit-uh-logo.png" style="max-height: 100px; float: left; padding-right: 16px;"> | ||
|
||
Create Universal Hex files for the micro:bit. | ||
{: .fs-6 .fw-300 } | ||
|
||
[Quick Guide](quick-guide.html){: .btn .btn-primary .fs-5 .mb-4 .mb-md-0 .mr-2 } | ||
[View it on GitHub](https://github.com/microbit-foundation/microbit-universal-hex/){: .btn .fs-5 .mb-4 .mb-md-0 } | ||
|
||
--- | ||
|
||
The documentation is currently a work in progress. | ||
|
||
The menu on the left shows you the available documentation. |