Documentation/content/markdown/using-images.md
Javier Pérez c6ac9a9f94 Reduce line length limit and format content (#623)
# 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>
2025-06-14 11:38:21 +02:00

31 lines
1.1 KiB
Markdown

---
eleventyNavigation:
key: UsingImages
title: Using Images
parent: Markdown
order: 60
---
It is possible to include images into the rendered form of a Markdown file.
Please refer to the [article on Screenshots](/improving-documentation/screenshots/) to learn how to use and include
images in the Codeberg documentation.
The syntax of including images is similar to the syntax of links.
```shell
![Alternative text](images/image.png "title")
```
![Codeberg Logo](https://design.codeberg.org/logo-kit/horizontal.png 'The Codeberg Logo')
The image link consists of three parts:
- The alternative text - is added to the `alt` attribute of the rendered image
- the link - a URI or URL to an image file, which is then included in the rendered article
- the title - is added to the `title` attribute of the rendered image (most browsers show it on hover)
## Location of image files
Image files can be placed within the folder structure of your article or documentation.
Apart from that, images can be referenced by a URL and are thus included from the internet location the URL points to.