mirror of
https://codeberg.org/Codeberg/Documentation.git
synced 2026-06-16 05:13:54 -07:00
c6ac9a9f94
# Changelog The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/). ## Changed - Update line length limit from 500 characters to 120 characters. ## Fixed - Most instances of these lint issues: 1. Lines longer than 120 characters ([MD013](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md013.md)). 2. Trailing whitespaces ([MD009](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md009.md)). 3. Ordered list item prefix ([MD029](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md029.md)). 4. Bare links ([MD034](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md034.md)). Co-authored-by: Patrick Schratz <pat-s@noreply.codeberg.org> Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/623 Reviewed-by: Patrick Schratz <pat-s@noreply.codeberg.org> Co-authored-by: Javier Pérez <walpo@noreply.codeberg.org> Co-committed-by: Javier Pérez <walpo@noreply.codeberg.org>
62 lines
1.7 KiB
Markdown
62 lines
1.7 KiB
Markdown
---
|
|
eleventyNavigation:
|
|
key: PreformattedText
|
|
title: Preformatted Text
|
|
parent: Markdown
|
|
order: 50
|
|
---
|
|
|
|
There are two ways to use monospace preformatted text within your Markdown document:
|
|
|
|
- Using indentation
|
|
- Using one or more backticks at the beginning and the end of a preformatted section
|
|
|
|
## Using indentation
|
|
|
|
You can preformat a section of text or code by indenting the code with 4 or more spaces, or a tab.
|
|
|
|
Using indentation, it's not possible to add a rendering hint. It's also not possible to preformat text within a line
|
|
using this syntax.
|
|
|
|
Indentation-based preformatting sometimes causes false positives where text is
|
|
preformatted that isn't supposed to. For this reason, it is disabled in some
|
|
Markdown renderers, including in Codeberg Documentation.
|
|
|
|
## Using backticks
|
|
|
|
A better way of preformatting a section of text is by starting a section of text with one or more backtick characters.
|
|
|
|
Here, we use 3 backtick characters on its own line, then our text, then another line containing 3 more backticks.
|
|
|
|
```
|
|
this
|
|
is
|
|
displayed
|
|
as
|
|
preformatted
|
|
```
|
|
|
|
You can also preformat a section of text within a line using backtick syntax.
|
|
The following text is for example `preformatted` by using the backtick syntax.
|
|
|
|
### Rendering hints
|
|
|
|
Sometime renderers use hints to syntax highlight the code in a preformatted section.
|
|
|
|
To provide a hint, simply add the language name at the end of the introductory backtick(s).
|
|
|
|
For example, using `shell` as the hint will tell the renderer that the given code should be highlighted as a shell script:
|
|
|
|
```shell
|
|
#!/bin/bash
|
|
|
|
echo "Hello world"
|
|
```
|
|
|
|
The same thing would be rendered without syntax highlighting if the hint is not given:
|
|
|
|
```
|
|
#!/bin/bash
|
|
|
|
echo "Hello world"
|
|
```
|