sambuc/microrust
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

bump mdbook to v0.2.1, fix ci and links

Browse Source
This commit is contained in:
Michael Droogleever
2018-10-13 22:34:32 +02:00
parent ec59c1c010
commit 28e7da3ad1
11 changed files with 47 additions and 56 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
src/appendix/troubleshooting.md
View File

@@ -26,7 +26,7 @@ in procedure 'ocd_bouncer'
without root privilege.
- Windows: You are probably missing the USB drivers.
[these instructions]: setup/LINUX.html#udev%20rules
[these instructions]: ../setup/LINUX.html#udev%20rules
### can't connect to OpenOCD - "Polling again in X00ms"

2
src/getting-started/04.00.SOLUTION.md
View File

@@ -17,7 +17,7 @@ This is a recap of what we have done so far.
## `.cargo/config`
``` toml
{{#include .cargo/config}}
{{#include ../../.cargo/config}}
```
## `.gdbinit`

4
src/hello-world/02.00.UART.md
View File

@@ -18,8 +18,8 @@ The micro:bit allows us to transmit and receive this serial communication over U
To read and write to the serial bus from your computer, you will need to configure your tooling:
- [*nix](hello-world/02.01.NIX.html)
- [Windows](hello-world/02.02.WINDOWS.html)
- [*nix](02.01.NIX.html)
- [Windows](02.02.WINDOWS.html)
## Code

2
src/hello-world/03.01.SOLUTION.md
View File

@@ -12,4 +12,4 @@ You now know enough to start playing around with the micro:bit's LED display and
as well as logging data back to the host.
You should know that the microbit crate already includes an abstraction for the LED display for you to use.
How to implemented a simple blocking display driver is demonstrated in the [LED display chapter](display/00.00.README.html).
How to implemented a simple blocking display driver is demonstrated in the [LED display chapter](../display/00.00.README.html).

2
src/microbit/03.00.DISPLAY.md
View File

@@ -1,7 +1,7 @@
# Display
The micro:bit display is not trivial to control, so a driver is needed;
see [the display chapter](display/00.00.README.html) for more details.
see [the display chapter](../display/00.00.README.html) for more details.
Display calls for now are only blocking, and can either be for binary images (0 for off, 1 for on),
or for monochrome images with differing brightness levels

4
src/setup/LINUX.md
View File

@@ -85,8 +85,6 @@ $ # ^^^^
If `uucp` appears in the output. You are all set! Go to the [next section]. Otherwise, keep reading:
[next section]: setup/VERIFY.html
- Add yourself to the `uucp` group.
``` shell
@@ -117,3 +115,5 @@ shells *won't* have access to `uucp` devices unless you manually re-log on them
command.
Now, go to the [next section].
[next section]: ../setup/VERIFY.html

2
src/setup/MACOS.md
View File

@@ -16,4 +16,4 @@ Caskroom/tap` first and try again.
That's all! Go to the [next section].
[next section]: setup/VERIFY.html
[next section]: ../setup/VERIFY.html

6
src/setup/README.md
View File

@@ -56,6 +56,6 @@ rustc 1.28.0-nightly (056f589fb 2018-06-22)
Now follow the instructions specific to the OS you are using:
- [Linux](setup/LINUX.html)
- [Windows](setup/WINDOWS.html)
- [macOS](setup/MACOS.html)
- [Linux](../setup/LINUX.html)
- [Windows](../setup/WINDOWS.html)
- [macOS](../setup/MACOS.html)

4
src/setup/VERIFY.md
View File

@@ -30,7 +30,7 @@ crw-rw---- 1 root uucp 189, 160 Jul 8 14:06 /dev/bus/usb/002/033
The group should be `uucp`.
If it's not ... then check your [udev rules] and try re-loading them with:
[udev rules]: setup/LINUX.html#udev%20rules
[udev rules]: ../setup/LINUX.html#udev%20rules
``` shell
$ sudo udevadm control --reload-rules
@@ -79,7 +79,7 @@ Info : nrf51.cpu: hardware has 4 breakpoints, 2 watchpoints
(If you don't ... then check the [general troubleshooting] instructions.)
[general troubleshooting]: appendix/troubleshooting.html
[general troubleshooting]: ../appendix/troubleshooting.html
`openocd` will block the terminal. That's fine.

2
src/setup/WINDOWS.md
View File

@@ -40,4 +40,4 @@ Download the latest `putty.exe` from [this site] and place it somewhere in your
That's all! Go to the [next section].
[next section]: setup/VERIFY.html
[next section]: ../setup/VERIFY.html

73
src/theme/index.hbs
View File

@@ -9,42 +9,36 @@
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="theme-color" content="#ffffff" />
<base href="{{ path_to_root }}">
<link rel="shortcut icon" href="{{ path_to_root }}{{ favicon }}">
<link rel="stylesheet" href="{{ path_to_root }}css/variables.css">
<link rel="stylesheet" href="{{ path_to_root }}css/general.css">
<link rel="stylesheet" href="{{ path_to_root }}css/chrome.css">
<link rel="stylesheet" href="{{ path_to_root }}css/print.css" media="print">
<link rel="stylesheet" href="book.css">
<!-- Fonts -->
<link rel="stylesheet" href="{{ path_to_root }}FontAwesome/css/font-awesome.css">
<link href="https://fonts.googleapis.com/css?family=Open+Sans:300italic,400italic,600italic,700italic,800italic,400,300,600,700,800" rel="stylesheet" type="text/css">
<link href="https://fonts.googleapis.com/css?family=Source+Code+Pro:500" rel="stylesheet" type="text/css">
<link rel="shortcut icon" href="{{ favicon }}">
<!-- Font Awesome -->
<link rel="stylesheet" href="FontAwesome/css/font-awesome.css">
<link rel="stylesheet" href="highlight.css">
<link rel="stylesheet" href="tomorrow-night.css">
<link rel="stylesheet" href="ayu-highlight.css">
<!-- Highlight.js Stylesheets -->
<link rel="stylesheet" href="{{ path_to_root }}highlight.css">
<link rel="stylesheet" href="{{ path_to_root }}tomorrow-night.css">
<link rel="stylesheet" href="{{ path_to_root }}ayu-highlight.css">
<!-- Custom theme stylesheets -->
{{#each additional_css}}
<link rel="stylesheet" href="{{this}}">
<link rel="stylesheet" href="{{ this }}">
{{/each}}
{{#if mathjax_support}}
<!-- MathJax -->
<script async type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
{{/if}}
<!-- Global site tag (gtag.js) - Google Analytics -->
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-111729278-2"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());
gtag('config', 'UA-111729278-2');
</script>
</head>
<body class="light">
<!-- Provide site root to javascript -->
<script type="text/javascript">var path_to_root = "{{ path_to_root }}";</script>
<!-- Work around some values being stored in localStorage wrapped in quotes -->
<script type="text/javascript">
try {
@@ -116,7 +110,7 @@
<h1 class="menu-title">{{ book_title }}</h1>
<div class="right-buttons">
<a href="print.html" class="icon-button" title="Print this book" aria-label="Print this book">
<a href="{{ path_to_root }}print.html" title="Print this book" aria-label="Print this book">
<i id="print-button" class="fa fa-print"></i>
</a>
<a href="https://github.com/droogmic/microrust" class="icon-button" title="Go to GitHub repo" aria-label="Link to GitHub repo">
@@ -156,13 +150,13 @@
<nav class="nav-wrapper" aria-label="Page navigation">
<!-- Mobile navigation buttons -->
{{#previous}}
<a rel="prev" href="{{link}}" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
<a rel="prev" href="{{ path_to_root }}{{link}}" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
<i class="fa fa-angle-left"></i>
</a>
{{/previous}}
{{#next}}
<a rel="next" href="{{link}}" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
<a rel="next" href="{{ path_to_root }}{{link}}" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
<i class="fa fa-angle-right"></i>
</a>
{{/next}}
@@ -174,13 +168,13 @@
<nav class="nav-wide-wrapper" aria-label="Page navigation">
{{#previous}}
<a href="{{link}}" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
<a href="{{ path_to_root }}{{link}}" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
<i class="fa fa-angle-left"></i>
</a>
{{/previous}}
{{#next}}
<a href="{{link}}" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
<a href="{{ path_to_root }}{{link}}" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
<i class="fa fa-angle-right"></i>
</a>
{{/next}}
@@ -225,29 +219,26 @@
{{/if}}
{{#if playpen_js}}
<script src="ace.js" type="text/javascript" charset="utf-8"></script>
<script src="editor.js" type="text/javascript" charset="utf-8"></script>
<script src="mode-rust.js" type="text/javascript" charset="utf-8"></script>
<script src="theme-dawn.js" type="text/javascript" charset="utf-8"></script>
<script src="theme-tomorrow_night.js" type="text/javascript" charset="utf-8"></script>
<script src="{{ path_to_root }}ace.js" type="text/javascript" charset="utf-8"></script>
<script src="{{ path_to_root }}editor.js" type="text/javascript" charset="utf-8"></script>
<script src="{{ path_to_root }}mode-rust.js" type="text/javascript" charset="utf-8"></script>
<script src="{{ path_to_root }}theme-dawn.js" type="text/javascript" charset="utf-8"></script>
<script src="{{ path_to_root }}theme-tomorrow_night.js" type="text/javascript" charset="utf-8"></script>
{{/if}}
{{#if search_enabled}}
<script src="searchindex.js" type="text/javascript" charset="utf-8"></script>
{{/if}}
{{#if search_js}}
<script src="elasticlunr.min.js" type="text/javascript" charset="utf-8"></script>
<script src="mark.min.js" type="text/javascript" charset="utf-8"></script>
<script src="searcher.js" type="text/javascript" charset="utf-8"></script>
<script src="{{ path_to_root }}elasticlunr.min.js" type="text/javascript" charset="utf-8"></script>
<script src="{{ path_to_root }}mark.min.js" type="text/javascript" charset="utf-8"></script>
<script src="{{ path_to_root }}searcher.js" type="text/javascript" charset="utf-8"></script>
{{/if}}
<script src="clipboard.min.js" type="text/javascript" charset="utf-8"></script>
<script src="highlight.js" type="text/javascript" charset="utf-8"></script>
<script src="book.js" type="text/javascript" charset="utf-8"></script>
<script src="{{ path_to_root }}clipboard.min.js" type="text/javascript" charset="utf-8"></script>
<script src="{{ path_to_root }}highlight.js" type="text/javascript" charset="utf-8"></script>
<script src="{{ path_to_root }}book.js" type="text/javascript" charset="utf-8"></script>
<!-- Custom JS scripts -->
{{#each additional_js}}
<script type="text/javascript" src="{{this}}"></script>
<script type="text/javascript" src="{{ path_to_root }}{{this}}"></script>
{{/each}}
{{#if is_print}}