Press / to focus
Getting Started with Codeberg
What is Codeberg? Your First Steps on Codeberg Install Git Your First Repository The Basics of Issue Tracking Integrated Wiki Email Settings Licensing on Codeberg Frequently Asked Questions
Collaborating with Others
Pull requests and Git flow Invite Collaborators Create and Manage an Organization Repository Permissions Resolve Conflicts Citable Code
Working with Git Repositories
Clone & Commit via CLI Clone & Commit via Web Merge multiple commits into one Tags and Releases Working with large files Using .gitignore Configuring Git Reducing the size of a repository
Writing in Markdown
Introduction to Markdown Using Links Topics Preformatted Text Using Images Using Lists Tables in Markdown Markdown FAQ
Security
Setting up two-factor authentication Adding an SSH key to your account Verifying you're connected to Codeberg using SSH fingerprints Adding a GPG key to your account
Codeberg Pages
Using Custom Domains Troubleshooting Example: Docs as Code with Sphinx Pushing output from SSGs into Codeberg Pages Redirects
Advanced Usage
Generating an Access Token Migrating Repositories Using Webhooks
Working with Codeberg's CI
Using Forgejo Actions (Self-hosted) Adding Self-Hosted Agents
Integrations with Other Services
Integrating with Keycloak Integrating with Matrix Integrating with Read the Docs Integrating with LiberaPay
Codeberg Translate
Introduction to Weblate Getting started Manual Component configuration
Improving Codeberg
Contributing Code
Improving the Documentation
How to create a new article? Can I preview my article? How to make screenshots for Codeberg Documentation? Documentation Contributor FAQ Style Guide
Contact

Codeberg Documentation

Preformatted Text

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:

#!/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"

Hey there! 👋 Thank you for reading this article!

Is there something missing, or do you have an idea on how to improve the documentation? Do you want to write your own article?

You're invited to contribute to the Codeberg Documentation at its source code repository, for example, by adding a pull request or joining in on the discussion in the issue tracker.

For an introduction on contributing to Codeberg Documentation, please have a look at the Contributor FAQ.

© Codeberg Docs Contributors. See LICENSE