File tree Expand file tree Collapse file tree 5 files changed +80
-0
lines changed Expand file tree Collapse file tree 5 files changed +80
-0
lines changed Original file line number Diff line number Diff line change
1
+ # Contributing
2
+
1
3
Thanks for looking here! We'd love your help. The micro: bit project is only
2
4
possible through contributions of companies and individuals around the world.
3
5
Original file line number Diff line number Diff line change
1
+ remote_theme : pmarsceill/just-the-docs
2
+
3
+ # Markdown settings: https://jekyllrb.com/docs/configuration/markdown/
4
+ kramdown :
5
+ # GitHub flavoured markdown
6
+ input : GFM
7
+ # Interprets line breaks literally
8
+ hard_wrap : false
9
+
10
+ # Just The Docs settings
11
+
12
+ # Enable or disable the site search
13
+ search_enabled : true
14
+ # Aux links for the upper right navigation
15
+ aux_links :
16
+ ' View on GitHub ' :
17
+ - ' https://github.com/microbit-foundation/microbit-universal-hex/'
18
+ # Color scheme currently only supports "dark" or nil (default)
19
+ color_scheme : ' light'
Original file line number Diff line number Diff line change
1
+ ---
2
+ layout : page
3
+ title : Contributing
4
+ nav_order : 3
5
+ ---
6
+
7
+ # Contributing
8
+
9
+ {: .no_toc }
10
+
11
+ ## Table of contents
12
+
13
+ {: .no_toc .text-delta }
14
+
15
+ 1 . TOC
16
+ {: toc }
17
+
18
+ ## How To Contribute
19
+
20
+ WIP.
21
+
22
+ ## Code Of Conduct
23
+
24
+ WIP.
25
+
26
+ ## Bugs
27
+
28
+ Issue tracker: https://github.com/microbit-foundation/microbit-fs/issues
29
+
30
+ ## Development Workflow
31
+
32
+ - ` npm install ` to install dependencies
33
+ - ` npm test ` runs the complete test suite
34
+ - ` npm build ` create a build with all the output formats
Original file line number Diff line number Diff line change
1
+ ---
2
+ layout : default
3
+ title : Home
4
+ homepage : true
5
+ permalink : /
6
+ nav_order : 1
7
+ ---
8
+
9
+ # micro: bit Universal Hex
10
+
11
+ {: .fs-9 }
12
+
13
+ <img alt =" microbit-universal-hex logo " src =" img/microbit-uh-logo.png " style =" max-height : 100px ; float : left ; padding-right : 16px ;" >
14
+
15
+ Create Universal Hex files for the micro: bit .
16
+ {: .fs-6 .fw-300 }
17
+
18
+ [ Quick Guide] ( quick-guide.html ) {: .btn .btn-primary .fs-5 .mb-4 .mb-md-0 .mr-2 }
19
+ [ View it on GitHub] ( https://github.com/microbit-foundation/microbit-universal-hex/ ) {: .btn .fs-5 .mb-4 .mb-md-0 }
20
+
21
+ ---
22
+
23
+ The documentation is currently a work in progress.
24
+
25
+ The menu on the left shows you the available documentation.
You can’t perform that action at this time.
0 commit comments