Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

How to format a code block in Github-flavored markdown #3

Open
mk-pmb opened this issue Feb 18, 2020 · 0 comments
Open

How to format a code block in Github-flavored markdown #3

mk-pmb opened this issue Feb 18, 2020 · 0 comments

Comments

@mk-pmb
Copy link
Owner

mk-pmb commented Feb 18, 2020

Want to post indented code or a tabular text block? Please make it easy to read. A fenced code block is the way to go.

Pro Tip: Use the syntax highlight notation with language name "text". This way it's unambiguous whether the fence line is the start or end of a code block. It reduces the impact area when accidentially deleting a fence line.

Example:

```text
Address                  HWtype  HWaddress           Flags Mask            Iface
192.168.0.4                      (incomplete)                              eth2
192.168.0.6              ether   4f:12:cc:df:9d:37   C                     eth2
192.168.0.7                      (incomplete)                              eth2
192.168.0.8              ether   5e:f9:c4:58:3b:ab   C                     eth2
```

should render as

Address                  HWtype  HWaddress           Flags Mask            Iface
192.168.0.4                      (incomplete)                              eth2
192.168.0.6              ether   4f:12:cc:df:9d:37   C                     eth2
192.168.0.7                      (incomplete)                              eth2
192.168.0.8              ether   5e:f9:c4:58:3b:ab   C                     eth2
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant