mirror of
https://github.com/okalachev/flix.git
synced 2025-07-27 01:29:33 +00:00
Improve Markdown linting
* Move .markdownlint to the root so it applies to the main readme. * Improve .markdownlint, enable proper names checks. * Use markdownlint-cli2 instead of markdownlint-cli as it's more compatible with VSCode extension.
This commit is contained in:
parent
0608765347
commit
d01d5b7ecb
4
.github/workflows/docs.yml
vendored
4
.github/workflows/docs.yml
vendored
@ -17,9 +17,9 @@ jobs:
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- name: Install markdownlint
|
||||
run: npm install -g markdownlint-cli
|
||||
run: npm install -g markdownlint-cli2
|
||||
- name: Run markdownlint
|
||||
run: cd docs && markdownlint .
|
||||
run: markdownlint-cli2 "**/*.md"
|
||||
|
||||
build_book:
|
||||
runs-on: ubuntu-latest
|
||||
|
67
.markdownlint.json
Normal file
67
.markdownlint.json
Normal file
@ -0,0 +1,67 @@
|
||||
{
|
||||
"MD004": {
|
||||
"style": "asterisk"
|
||||
},
|
||||
"MD010": false,
|
||||
"MD013": false,
|
||||
"MD024": false,
|
||||
"MD033": false,
|
||||
"MD034": false,
|
||||
"MD044": {
|
||||
"html_elements": false,
|
||||
"code_blocks": false,
|
||||
"names": [
|
||||
"FlixPeriph",
|
||||
"Wi-Fi",
|
||||
"STM",
|
||||
"Li-ion",
|
||||
"GitHub",
|
||||
"github.com",
|
||||
"PPM",
|
||||
"PWM",
|
||||
"Futaba",
|
||||
"S.Bus",
|
||||
"C++",
|
||||
"PID",
|
||||
"Arduino IDE",
|
||||
"Arduino",
|
||||
"Arduino Nano",
|
||||
"ESP32",
|
||||
"IMU",
|
||||
"MEMS",
|
||||
"imu.ino",
|
||||
"InvenSense",
|
||||
"MPU-6050",
|
||||
"MPU-9250",
|
||||
"GY-91",
|
||||
"ICM-20948",
|
||||
"Linux",
|
||||
"Windows",
|
||||
"macOS",
|
||||
"iOS",
|
||||
"Android",
|
||||
"Bluetooth",
|
||||
"GPS",
|
||||
"GPIO",
|
||||
"USB",
|
||||
"SPI",
|
||||
"I²C",
|
||||
"UART",
|
||||
"GND",
|
||||
"3V3",
|
||||
"VCC",
|
||||
"SCL",
|
||||
"SDA",
|
||||
"SAO",
|
||||
"AD0",
|
||||
"MOSI",
|
||||
"MISO",
|
||||
"NCS",
|
||||
"MOSFET",
|
||||
"ArduPilot",
|
||||
"Betaflight",
|
||||
"PX4"
|
||||
]
|
||||
},
|
||||
"MD045": false
|
||||
}
|
@ -1,10 +0,0 @@
|
||||
{
|
||||
"MD004": {
|
||||
"style": "asterisk"
|
||||
},
|
||||
"MD010": false,
|
||||
"MD013": false,
|
||||
"MD024": false,
|
||||
"MD033": false,
|
||||
"MD045": false
|
||||
}
|
Loading…
x
Reference in New Issue
Block a user