Lint markdown files

Author: Sh3Rm4n

.github/workflows/ci.yml

@@ -138,3 +138,12 @@ jobs:
           profile: minimal
           components: rustfmt
       - run: cd codegen && cargo check
+
+  markdown-lint:
+    name: Markdown Lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: nosborn/[email protected]
+        with:
+          files: .
+          ignore_files: "target/"

.markdownlint.yml

@@ -0,0 +1,2 @@
+md024: false
+md014: false

CHANGELOG.md

@@ -44,7 +44,6 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 - Introduced auto-generated GPIO mappings based on the STM32CubeMX database
   ([#129](https://github.com/stm32-rs/stm32f3xx-hal/pull/129))
 
-
 ### Fixed
 
 - Fixed [#151][] not being able to generate 72 MHz HCLK for stm32f303xc devices
@@ -64,8 +63,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
   not mean, that we guarantee any MSRV policy. It is rather for documentation
   purposes and if a new useful feature arises, we will increase the MSRV.
   ([#170](https://github.com/stm32-rs/stm32f3xx-hal/pull/170))
-- Removed I2C2 support for `stm32f303x6`, `stm32f303x8` and `stm32f328` targets. ([#164](https://github.com/stm32-rs/stm32f3xx-hal/pull/164))
-- `I2c::i2c1` and `I2c::i2c2` functions are renamed to `I2c::new`. ([#164](https://github.com/stm32-rs/stm32f3xx-hal/pull/164))
+- Removed I2C2 support for `stm32f303x6`, `stm32f303x8` and `stm32f328` targets.
+  ([#164](https://github.com/stm32-rs/stm32f3xx-hal/pull/164))
+- `I2c::i2c1` and `I2c::i2c2` functions are renamed to `I2c::new`.
+  ([#164](https://github.com/stm32-rs/stm32f3xx-hal/pull/164))
 
 ## [v0.5.0] - 2020-07-21
 
@@ -85,6 +86,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 - The system clock calculation is more fine grained now. ([#67](https://github.com/stm32-rs/stm32f3xx-hal/pull/67))
   Now the system clock can be some value, like 14 MHz, which can not a
   be represented as a multiple of the oscillator clock:
+
 ```rust
 let clocks = rcc
     .cfgr
@@ -97,11 +99,11 @@ let clocks = rcc
     .use_hse(32.mhz())
     .sysclk(72.mhz())
 ```
+
   This is possible through utilizing the divider, which can divide the
   external oscillator clock on most devices. Some devices have even the
   possibility to divide the internal oscillator clock.
 
-
 ### Breaking changes
 
 - The feature gate requires you to select a subvariant if possible. ([#75](https://github.com/stm32-rs/stm32f3xx-hal/pull/75))
@@ -159,15 +161,17 @@ let clocks = rcc
   - This allows using 72 MHz `sysclk` on the `stm32f303`
 - Analog gpio trait ([#33](https://github.com/stm32-rs/stm32f3xx-hal/pull/33))
 - Add PWM Channels ([#34](https://github.com/stm32-rs/stm32f3xx-hal/pull/34))
-- SPI embedded hal modes are now public ([#35](https://github.com/stm32-rs/stm32f3xx-hal/pull/18))
+- SPI embedded hal modes are now public
+  ([#35](https://github.com/stm32-rs/stm32f3xx-hal/pull/18))
 
 ### Breaking changes
 
-- Alternate gpio functions are now **only** made available for devices, which have them.
-  ([#21](https://github.com/stm32-rs/stm32f3xx-hal/pull/21))
+- Alternate gpio functions are now **only** made available for devices, which
+  have them. ([#21](https://github.com/stm32-rs/stm32f3xx-hal/pull/21))
 - `stm32f303` is now split into `stm32f303xd` and `stm32f303xe` as they provide
   different alternate gpio functions. `stm32f303` is still available.
-- Bump `stm32f3` dependency to `0.9.0` ([#39](https://github.com/stm32-rs/stm32f3xx-hal/pull/39))
+- Bump `stm32f3` dependency to `0.9.0`
+  ([#39](https://github.com/stm32-rs/stm32f3xx-hal/pull/39))
 
 ### Fixed
 

Cargo.toml

@@ -16,6 +16,7 @@ documentation = "https://docs.rs/stm32f3xx-hal"
 version = "0.6.0"
 exclude = [
     "codegen",
+    ".markdownlint.yml"
 ]
 
 [package.metadata.docs.rs]

README.md

@@ -9,16 +9,16 @@ peripheral access API for the STMicro STM32F3 series microcontrollers. The
 selection of the MCU is done by feature gates, typically specified by board
 support crates. Currently supported configurations are:
 
-*   stm32f301 ✔️ YES!
-*   stm32f318 ✔️ YES!
-*   stm32f302 ✔️ YES!
-*   stm32f303 ✔️ YES!
-*   stm32f373 ✔️ YES!
-*   stm32f378 ✔️ YES!
-*   stm32f334 ✔️ YES!
-*   stm32f328 ✔️ YES!
-*   stm32f358 ✔️ YES!
-*   stm32f398 ✔️ YES!
+* stm32f301
+* stm32f318
+* stm32f302
+* stm32f303
+* stm32f373
+* stm32f378
+* stm32f334
+* stm32f328
+* stm32f358
+* stm32f398
 
 The idea behind this crate is to gloss over the slight differences in the
 various peripherals available on those MCUs so a HAL can be written for all
@@ -52,29 +52,30 @@ So you want to expand your call to `cargo` with `--features stm32f303xc`.*
 [comment]: # (Any changes here should be mirrored in src/lib.rs)
 
 Note: `x` denotes any character in [a-z]
-*   stm32f301xb
-*   stm32f301xc
-*   stm32f301xd
-*   stm32f301xe
-*   stm32f318
-*   stm32f302xb
-*   stm32f302xc
-*   stm32f302xd
-*   stm32f302xe
-*   stm32f302x6
-*   stm32f302x8
-*   stm32f303xb
-*   stm32f303xc
-*   stm32f303xd
-*   stm32f303xe
-*   stm32f303x6
-*   stm32f303x8
-*   stm32f373
-*   stm32f378
-*   stm32f334
-*   stm32f328
-*   stm32f358
-*   stm32f398
+
+* stm32f301xb
+* stm32f301xc
+* stm32f301xd
+* stm32f301xe
+* stm32f318
+* stm32f302xb
+* stm32f302xc
+* stm32f302xd
+* stm32f302xe
+* stm32f302x6
+* stm32f302x8
+* stm32f303xb
+* stm32f303xc
+* stm32f303xd
+* stm32f303xe
+* stm32f303x6
+* stm32f303x8
+* stm32f373
+* stm32f378
+* stm32f334
+* stm32f328
+* stm32f358
+* stm32f398
 
 ### Background
 
@@ -95,21 +96,30 @@ expect it to do so.*
 
 ### Detailed steps to select the right chip
 
-1. Get the full name of the chip you are using from your datasheet, user manual or other source.
+1. Get the full name of the chip you are using from your datasheet, user manual
+   or other source.
+
+   _Example_:
 
-    *Example: We want to use the STM32F3Discovery kit.*
-    *The [Usermanual][] tells us it's using a STM32F303VC chip.*
+   We want to use the STM32F3Discovery kit.
+   The [Usermanual][] tells us it's using a STM32F303VC chip.
 
 2. Find your chip as a feature in the list above.
 
-    *Example: Looking for the right feature for our STM32F303VC chip we first find
-    `stm32f301xb`. This is the wrong chip, as we're not looking for `f301` but for `f303`.*
+   _Example_:
 
-    *Looking further we find `stm32f303xc`. This matches STM32F303VC (note that VC → xc).*
+   Looking for the right feature for our STM32F303VC chip we first find
+   `stm32f301xb`. This is the wrong chip, as we're not looking for `f301` but
+   for `f303`.
+
+   Looking further we find `stm32f303xc`. This matches STM32F303VC
+   (note that VC → xc).
 
 3. Add the chip name as a feature to your cargo call.
 
-    *Example: Using the STM32F303VC chip we run `cargo check --features stm32f303xc`.*
+    _Example_:
+
+    Using the STM32F303VC chip we run `cargo check --features stm32f303xc`.
 
 [Usermanual]: https://www.st.com/content/ccc/resource/technical/document/user_manual/8a/56/97/63/8d/56/41/73/DM00063382.pdf/files/DM00063382.pdf/jcr:content/translations/en.DM00063382.pdf
 

codegen/README.md

@@ -12,7 +12,7 @@ Because by default cargo tries to use the `x86_64-unknown-linux-gnu` target,
 when building `codegen`, due to what's specified in the `.cargo/config`, you
 need to manually specify your host's target if it differs from that, e.g.:
 
-```
+```bash
 $ cargo run --target x86_64-apple-darwin -- help
 ```
 
@@ -26,7 +26,7 @@ Running `codegen`'s `gpio` subcommand generates the `gpio!` macro
 invocations at the end of `src/gpio.rs`. Re-generating those macro-invocations
 is simply a matter of deleting the old ones and then executing:
 
-```
+```bash
 $ cargo run -- gpio $cubemx_db_path >> ../src/gpio.rs
 ```