Press / to focus
Codeberg Documentation

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
Citable Code Pull requests and Git flow Invite Collaborators Create and Manage an Organization Repository Permissions Resolve Conflicts
Working with Git Repositories
Using .gitignore Configuring Git Clone & Commit via CLI Clone & Commit via Web Merge multiple commits into one Tags and Releases Working with large files
Writing in Markdown
Introduction to Markdown Using Links Topics Preformatted Text Using Lists Using Images 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)
Integrations with Other Services
Integrating with Keycloak Integrating with LiberaPay Integrating with Matrix Integrating with Read the Docs
Codeberg Translate
Introduction to Weblate Manual Component configuration Getting started
Improving Codeberg
Contributing Code
Improving the Documentation
Style Guide How to create a new article? Can I preview my article? How to make screenshots for Codeberg Documentation? Documentation Contributor FAQ
Contact

Using Links

You can use links to refer to other articles, sections in articles or other websites.

Links with description

It is always good for readability to not only paste a URL into your text but to provide a description of your link. Only the description of the link will be in the rendered form of your text and the link will be added as an HTML hyperlink.

Hyperlinks have the following markup: [Link description](link-url).

For example:

[Link to Codeberg](https://codeberg.org/)

Gets rendered as:

Link to Codeberg

Links without description

To add a link using the URL within your text use < and > to mark the link. For example, if you want to add a link to https://codeberg.org/, add <https://codeberg.org> to your text. This will render as https://codeberg.org/. You can also just add the link to your text normally to have the same effect: https://codeberg.org. However it is easier to navigate to links if they are explicitly marked by the less than < and greater than > characters.

URIs and URLs

You can link to another article by specifying the file or path name URI (a URL, without specifying the protocol and domain).

For example, you can link to the introductory article of this section of the documentation by using its path name in the link:

[Link to introductory article](/markdown/)

This is rendered as:

Link to introductory article

You can also link to a heading in an article by specifying the heading using a hash character #.

For example, you can link to the heading on "Links without description" in this same article by using:

[Link to the "links-without-description" section](#links-without-description)

This is rendered as:

Link to the "links-without-description" section

You can link to another article's heading using the same syntax.

For example, you can link to the heading on "Bold" in the article "Introduction to Markdown" by using:

[Link to the bold section](/markdown/introduction-to-markdown/#bold)

This is rendered as:

Link to the bold section

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