Skip to content

Commit 37d608d

Browse files
committed
Run markdownlint on README.md
Fix these errors: 1 MD001/heading-increment/header-increment 5 MD005/list-indent 13 MD007/ul-indent 1 MD024/no-duplicate-heading/no-duplicate-header 7 MD034/no-bare-urls 2 MD040/fenced-code-language Ignore these issues: 2 MD004/ul-style 53 MD013/line-length 6 MD014/commands-show-output 50 MD022/blanks-around-headings/blanks-around-headers 10 MD031/blanks-around-fences 19 MD032/blanks-around-lists 4 MD033/no-inline-html 1 MD041/first-line-heading/first-line-h1 Signed-off-by: Anders F Björklund <[email protected]>
1 parent 7de95ca commit 37d608d

File tree

2 files changed

+19
-9
lines changed

2 files changed

+19
-9
lines changed

.markdownlint.json

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
{
2+
"first-line-h1": false,
3+
"no-inline-html": false,
4+
"blanks-around-headers": false,
5+
"blanks-around-lists": false,
6+
"blanks-around-fences": false,
7+
"commands-show-output": false,
8+
"ul-style": false,
9+
"line-length": false
10+
}

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -56,8 +56,8 @@ GUI:
5656
### Communication channels
5757
- [GitHub Discussions](https://github.com/lima-vm/lima/discussions)
5858
- `#lima` channel in the CNCF Slack
59-
- New account: https://slack.cncf.io/
60-
- Login: https://cloud-native.slack.com/
59+
- New account: <https://slack.cncf.io/>
60+
- Login: <https://cloud-native.slack.com/>
6161

6262
### Code of Conduct
6363
Lima follows the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md).
@@ -98,9 +98,9 @@ $ lima nerdctl run -d --name nginx -p 127.0.0.1:8080:80 nginx:alpine
9898

9999
> You don't need to run "lima nerdctl" everytime, instead you can use special shortcut called "nerdctl.lima" to do the same thing. By default, it'll be installed along with the lima, so, you don't need to do anything extra. There will be a symlink called nerdctl pointing to nerdctl.lima. This is only created when there is no nerdctl entry in the directory already though. It worths to mention that this is created only via make install. Not included in Homebrew/MacPorts/nix packages.
100100
101-
http://127.0.0.1:8080 is accessible from both macOS and Linux.
101+
<http://127.0.0.1:8080> is accessible from both macOS and Linux.
102102

103-
For the usage of containerd and nerdctl (contaiNERD ctl), visit https://github.com/containerd/containerd and https://github.com/containerd/nerdctl.
103+
For the usage of containerd and nerdctl (contaiNERD ctl), visit <https://github.com/containerd/containerd> and <https://github.com/containerd/nerdctl>.
104104

105105
## Getting started
106106
### Installation
@@ -121,7 +121,7 @@ Install QEMU 7.0 or later.
121121

122122
#### Install Lima
123123

124-
- Download the binary archive of Lima from https://github.com/lima-vm/lima/releases ,
124+
- Download the binary archive of Lima from <https://github.com/lima-vm/lima/releases>,
125125
and extract it under `/usr/local` (or somewhere else). For instance:
126126

127127
```bash
@@ -308,7 +308,6 @@ The current default spec:
308308

309309
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
310310
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
311-
### Generic
312311

313312
- [Generic](#generic)
314313
- ["What's my login password?"](#whats-my-login-password)
@@ -336,6 +335,7 @@ The current default spec:
336335
- ["Hints for debugging other problems?"](#hints-for-debugging-other-problems)
337336

338337
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
338+
339339
### Generic
340340
#### "What's my login password?"
341341
Password is disabled and locked by default.
@@ -424,7 +424,7 @@ codesign -s - --entitlements entitlements.xml --force /usr/local/bin/qemu-system
424424

425425
Note: **Only** on macOS versions **before** 10.15.7 you might need to add this entitlement in addition:
426426

427-
```
427+
```xml
428428
<key>com.apple.vm.hypervisor</key>
429429
<true/>
430430
```
@@ -441,7 +441,7 @@ Note: **Only** on macOS versions **before** 10.15.7 you might need to add this e
441441
This error is known to happen when running an image of RHEL8-compatible distribution such as Rocky Linux 8.x on Intel Mac.
442442
A workaround is to set environment variable `QEMU_SYSTEM_X86_64="qemu-system-x86_64 -cpu Haswell-v4"`.
443443

444-
https://bugs.launchpad.net/qemu/+bug/1838390
444+
<https://bugs.launchpad.net/qemu/+bug/1838390>
445445

446446
## VZ
447447
#### "Lima gets stuck at `Installing rosetta...`"
@@ -462,7 +462,7 @@ See [`./docs/network.md`](./docs/network.md).
462462

463463
Lima uses QEMU's SLIRP networking which does not support `ping` out of the box:
464464

465-
```
465+
```console
466466
$ ping google.com
467467
PING google.com (172.217.165.14): 56 data bytes
468468
64 bytes from 172.217.165.14: seq=0 ttl=42 time=2395159.646 ms

0 commit comments

Comments
 (0)