Skip to content

Commit

Permalink
Docs: Add basic docs.
Browse files Browse the repository at this point in the history
Only a crude Quick Start right now.
  • Loading branch information
microbit-carlos committed Oct 27, 2020
1 parent 75543b0 commit db915b0
Show file tree
Hide file tree
Showing 5 changed files with 80 additions and 0 deletions.
2 changes: 2 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# Contributing

Thanks for looking here! We'd love your help. The micro:bit project is only
possible through contributions of companies and individuals around the world.

Expand Down
19 changes: 19 additions & 0 deletions docs/_config.yml
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'
34 changes: 34 additions & 0 deletions docs/contributing.md
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
Binary file added docs/img/microbit-uh-logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
25 changes: 25 additions & 0 deletions docs/index.md
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.

0 comments on commit db915b0

Please sign in to comment.