Skip to content

Commit 982cd3c

Browse files
Code block fix
Enables word/line wrap in code blocks
1 parent c1fdef0 commit 982cd3c

File tree

3 files changed

+13
-7
lines changed

3 files changed

+13
-7
lines changed

docs/firmware_update.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ Open a command prompt (Windows button + <kbd>r</kbd> then type ‘ <kbd>cmd</kbd
141141

142142
You'll then need to run the '**batch_program.bat**' along with the binary file name and COM port. Enter the following command below, where **COM4** should be replaced by the COM port you identified earlier and **BlueSMiRF_Firmware_v1_0.bin** is the firmware that you are updating to. Make sure to send an additional key to run the batch file.
143143

144-
``` bash
144+
```bash
145145
batch_program.bat BlueSMiRF_Firmware_v1_0.bin COM4
146146
```
147147

@@ -171,9 +171,9 @@ After about 20 seconds, you should see the following message: `Done programming!
171171

172172
The batch file runs the following commands, where *COM4* is replaced with the COM port that the BlueSMiRF product enumerated at and *BlueSMiRF_Firmware_vx_x.bin* is the firmware you would like to load.
173173

174-
<pre>
175-
<code class="language-bash" style="white-space: pre-wrap;">esptool.exe --chip esp32 --port COM4 --baud 921600 --before default_reset --after hard_reset write_flash -z --flash_mode dio --flash_freq 80m --flash_size 8MB 0x1000 bins/bootloader.bin 0x8000 bins/partitions.bin 0xe000 bins/boot_app0.bin 0x10000 BlueSMiRF_Firmware_v1_0.bin</code>
176-
</pre>
174+
```bash
175+
esptool.exe --chip esp32 --port COM4 --baud 921600 --before default_reset --after hard_reset write_flash -z --flash_mode dio --flash_freq 80m --flash_size 8MB 0x1000 bins/bootloader.bin 0x8000 bins/partitions.bin 0xe000 bins/boot_app0.bin 0x10000 BlueSMiRF_Firmware_v1_0.bin
176+
```
177177

178178
!!! note
179179
Some users have reported the `921600` baud rate does not work. Decrease this to `115200` as needed.
@@ -201,9 +201,9 @@ Once the correct COM port is identified, head to the [GitHub repo for the BlueSM
201201

202202
Open a Terminal window and run the following command, where */dev/ttyUSB0* is replaced with the port that the USB-to-Serial board enumerated at and *BlueSMiRF_Firmware_vx_x.bin* is the firmware you would like to load.
203203

204-
<pre>
205-
<code class="language-bash" style="white-space: pre-wrap;">py esptool.py --chip esp32 --port /dev/ttyUSB0 --baud 921600 --before default_reset --after hard_reset write_flash -z --flash_mode dio --flash_freq 80m --flash_size 8MB 0x1000 bins/bootloader.bin 0x8000 bins/partitions.bin 0xe000 bins/boot_app0.bin 0x10000 BlueSMiRF_Firmware_vx_x.bin</code>
206-
</pre>
204+
```bash
205+
py esptool.py --chip esp32 --port /dev/ttyUSB0 --baud 921600 --before default_reset --after hard_reset write_flash -z --flash_mode dio --flash_freq 80m --flash_size 8MB 0x1000 bins/bootloader.bin 0x8000 bins/partitions.bin 0xe000 bins/boot_app0.bin 0x10000 BlueSMiRF_Firmware_vx_x.bin
206+
```
207207

208208
!!! note
209209
Some users have reported the `921600` baud rate does not work. Decrease this to `115200` as needed.

docs/stylesheet/extra.css

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,11 @@
2525
max-height: var(--md-codeblock-height, 800px);
2626
} */
2727

28+
/* Word wrap code blocks (no horizontal scroll) */
29+
pre code {
30+
white-space : pre-wrap;
31+
}
32+
2833

2934
/* ================================================================================== */
3035
/* Icons */

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -166,6 +166,7 @@ plugins:
166166
markdown_extensions:
167167
- pymdownx.highlight:
168168
anchor_linenums: true
169+
line_spans: __span
169170
- pymdownx.inlinehilite
170171
- pymdownx.snippets:
171172
# base_path: ['./docs']

0 commit comments

Comments
 (0)