README.md: literal cleanups
PATCH 1/1 README.md: literal cleanups
Using ```bash works in almost all markdown renderers, but unfortunately does not work on git.yoctoproject.org. Instead it inserts "bash" at the start of any such literal code block that uses it.
Technically a code block in markdown requires 4 spaces, not 3. Therefore the "git send-email ..." command would not be offset correctly in most markdown renderers. Either add another space, or delimit with ``` to match the other code blocks; I chose the latter.
--- README.md | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-)
README.md +9 -7
@@ -10,33 +10,33 @@ environment file or folder (generated via `bitbake -c rootfs_wicenv ### Using wicenv (one environment file) 1. Ensure you have a BitBake-generated `<image>.env` file (from `rootfs_wicenv`). 2. Install locally for development: - ```bash + ``` hatch shell ``` 3. Run the CLI: - ```bash + ``` hatch run wic --vars /path/to/<image>.env --help ``` ### Using wicenv (environment folder) 1. Ensure you have a folder with BitBake-generated `<image>.env` files (from `rootfs_wicenv`). 2. Install locally for development: - ```bash + ``` hatch shell ``` 3. Run the CLI: - ```bash + ``` hatch run wic --vars /path/to/envfiledir --help ``` ### With bitbake 1. Ensure you have bitbake available in your PATH. 2. Install locally for development: - ```bash + ``` hatch shell ``` 3. Run the CLI: - ```bash + ``` hatch run wic --help ```
@@ -63,7 +63,9 @@ recipients. When generating the patches manually, this will generate what's expected: - git send-email -M -1 --to [email protected] --cc [email protected] --subject-prefix='wic][PATCH' +``` +git send-email -M -1 --to [email protected] --cc [email protected] --subject-prefix='wic][PATCH' +``` Nothing, except running `b4 send` to actually send the patches, needs to be done when using [b4](https://b4.docs.kernel.org/).
Signature · 1 line
2.51.0
Hi Trevor,
Quoted 2 lines · Trevor Woerner via lists.yoctoproject.org
Using ```bash works in almost all markdown renderers, but unfortunately does not work on git.yoctoproject.org. Instead it inserts "bash" at the
TIL cgit supports markdown. Archwiki says it's done with python-markdown (or possibly md4c). It seems the former supports some syntax highlighting in fenced code blocks, c.f. https://python-markdown.github.io/extensions/fenced_code_blocks/#syntax-highlighting
Maybe it's something Michael could enable (but also, I'm not sure we should care too much about it :D).
Note that fenced blocks don't seem to be part of the Markdown "base" but implemented as an extension by many Markdown parsers (to varying level of support), see https://daringfireball.net/projects/markdown/syntax#precode.
Quoted 7 lines
start of any such literal code block that uses it.
Technically a code block in markdown requires 4 spaces, not 3. Therefore the "git send-email ..." command would not be offset correctly in most markdown renderers. Either add another space, or delimit with ``` to match the other code blocks; I chose the latter.
Thanks!
Quentin