Commit graph

19 commits

Author SHA1 Message Date
Dave Anselmi
8215c254bc Move duplicate article list snippets to shortcode. (#780)
Closes #335.

This is my first attempt coding for eleventy/liquid so I'd be happy to get feedback on making the code cleaner or more idiomatic, or just more like the Codeberg style.

Co-authored-by: David Anselmi <danselmi@intecrowd.com>
Co-authored-by: Gusted <postmaster@gusted.xyz>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/780
Reviewed-by: Gusted <gusted@noreply.codeberg.org>
2026-04-27 14:36:08 +02:00
Javier Pérez
941914f698 Fix lint issues (#629)
# Changelog

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).

## Fixed

- Lint issues:
  - Line length ([MD013](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md013.md)).
  -  Heading levels should only increment by one level at a time ([MD001](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md001.md)).
  - Link fragments should be valid ([MD051](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md051.md)).
---

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/629
Reviewed-by: Gusted <gusted@noreply.codeberg.org>
Co-authored-by: Javier Pérez <walpo@noreply.codeberg.org>
Co-committed-by: Javier Pérez <walpo@noreply.codeberg.org>
2025-11-21 12:35:05 +01:00
Javier Pérez
875cb34bdc Refactor and fix tables (#627)
# Changelog

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).

## Changed

- Refactor tables to respect `indent_size = 1`.

## Fixed

- Tables with `<tr>` and `<td>` tags in wrong ending order.

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/627
Reviewed-by: Bastian Greshake Tzovaras <gedankenstuecke@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-16 22:57:17 +02:00
Javier Pérez
e405ae93ae Lint the documentation (#626)
# Changelog

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).

## Removed

- Disable the Markdownlint rule MD024 (`Multiple headings with the same content`).

## Fixed

- Syntax errors in `.markdownlint.yaml`.
- Markdownlint issues:
  - Heading levels should only increment by one level at a time([MD001](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md001.md))
  - Hard tabs ([MD010](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md010.md))
  - Reversed link syntax ([MD011](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md011.md))
  - Dollar signs used before commands without showing output ([MD014](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md014.md))
  - Multiple top-level headings in the same document ([MD025](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md025.md))
  - Trailing punctuation in heading ([MD026](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md026.md))
  - Ordered list item prefix([MD029](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md029.md))
  - Emphasis used instead of a heading([MD036](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md036.md))
  - Fenced code blocks should have a language specified ([MD040](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md040.md))
  - Link fragments should be valid ([MD051](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md051.md))
  - Link text should be descriptive ([MD059](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md059.md))

- Prettier issues.

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/626
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 15:39:01 +02:00
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
Gusted
f169569807 chore: disable avif transcoding (#495)
The trade-off is not worth it, it isn't *that* good for screenshots and
it uses too much memory and increases build time by a order of magnitude

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/495
Co-authored-by: Gusted <postmaster@gusted.xyz>
Co-committed-by: Gusted <postmaster@gusted.xyz>
2024-11-30 13:13:22 +00:00
Gusted
03342e98ec feat: use Eleventy's image plugin for image transformation (#488)
Use https://www.11ty.dev/docs/plugins/image/ to transform images on build time to avif, webp and jpeg.

Images are moved to `/content/images`.

`<picture>` is no longer needed, the plugin does this automatically.

Remove webp images from the source.

Resolves #152
Resolves #368

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/488
Co-authored-by: Gusted <postmaster@gusted.xyz>
Co-committed-by: Gusted <postmaster@gusted.xyz>
2024-11-29 06:12:05 +00:00
Mark Pitblado
193b4cf639 Define acronyms on first use, add reference to codeberg-ci/examples, and remove reference to knut org (#435)
- All acronyms should be defined in first use. This adds this for Continuous Integration (CI) and Role Based Access Control (RBAC).
- Changes language around acceptance to soften tone, and shift from guaranteed to conditional acceptance.
- Specifies that login to woodpecker-ci is via codeberg account, and that repositories are automatically available to link.
- Adds reference to codeberg-ci/examples repository.
- Removes reference to knut organization.

Co-authored-by: Patrick Schratz <pat-s@noreply.codeberg.org>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/435
Reviewed-by: Patrick Schratz <pat-s@noreply.codeberg.org>
Co-authored-by: Mark Pitblado <mark@pitblado.me>
Co-committed-by: Mark Pitblado <mark@pitblado.me>
2024-06-12 20:02:39 +00:00
pat-s
74e8925bec add spellchecker (#439)
fix #148

Adds a spell checker via `cspell` and fixes some spelling issues in the docs.

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/439
Co-authored-by: pat-s <patrick.schratz@gmail.com>
Co-committed-by: pat-s <patrick.schratz@gmail.com>
2024-06-12 10:20:37 +00:00
crapStone
da1b77aa6a Add woodpecker ci & many linters (and their required fixes) (#377)
closes #238

Co-authored-by: pat-s <patrick.schratz@gmail.com>
Co-authored-by: Patrick Schratz <pat-s@noreply.codeberg.org>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/377
Co-authored-by: crapStone <crapstone01@gmail.com>
Co-committed-by: crapStone <crapstone01@gmail.com>
2024-06-11 07:51:22 +00:00
adagio
ca0475ad93 Updates styleguide wording and terminology (#429)
Based on https://codeberg.org/forgejo/forgejo/issues/3844

Equivalent PR in the Forgejo documentation: https://codeberg.org/forgejo/docs/pulls/681

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/429
Reviewed-by: Panagiotis "Ivory" Vasilopoulos <git@n0toose.net>
Co-authored-by: adagio <h759bkyo4@mozmail.com>
Co-committed-by: adagio <h759bkyo4@mozmail.com>
2024-06-05 08:09:38 +00:00
Igor
91bc7ec69f added notes about obtaining webp (#408)
Resolves #407

Co-authored-by: I <igor@its.rel.pl>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/408
Reviewed-by: Otto <otto@codeberg.org>
Co-authored-by: Igor <309631@noreply.codeberg.org>
Co-committed-by: Igor <309631@noreply.codeberg.org>
2024-04-03 11:51:57 +00:00
Panagiotis "Ivory" Vasilopoulos
b9a17086c9 Style Guide: Markdown Code Blocks (#403)
Fixes #401.

Refs: https://codeberg.org/Codeberg/Documentation/issues/401
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/403
Reviewed-by: Leo Heitmann Ruiz <eo@noreply.codeberg.org>
2024-03-12 18:38:42 +00:00
Panagiotis "Ivory" Vasilopoulos
8386857b1c Use admonition boxes more consistently
- Formatting fixes, relevant text adjustments
- Some more complicated cases (e.g. attribution), as well as outdated
  information that should be removed in a later commit were
  deliberately left unchanged.
- Some minor mistakes (speling, trailing whitespaces, punctuation)
  in the admonition boxes were also fixed.
2023-11-27 07:16:04 +01:00
Panagiotis "Ivory" Vasilopoulos
9a19c900e3 Style Guide: Add image-specific rules 2023-11-27 05:37:38 +01:00
Andre601
b234b71bb7 Create new admonition boxes (#337)
Related issue: https://codeberg.org/Codeberg/Documentation/issues/330

This is my attempt at adding admonition-like boxes to the documentation. The goal is to make important stuff stand out more (especially warnings and alike).

The system uses a custom `<admonition>` box which allows classes for further customization. I.e. `<admonition class="warning">` to display a warning box.

I first wanted to make individual boxes (`<warning>`, `<note>`, ...) but decided against it, as it would've created a lot of duplicate CSS.

The CSS is designed in such a way that the first paragraph of the box is made bold (font-weight 700) while any subsequent ones are not.

The following forms of admonitions are included:
- Info (default)
- Note
- Tip
- Warning

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/337
Co-authored-by: Andre601 <github@andre601.ch>
Co-committed-by: Andre601 <github@andre601.ch>
2023-09-18 15:17:17 +00:00
f0sh
1984032bdd Add improvements to the Documentation according to open issues (#314)
Tried to close some open issues in the issue tracker by submitting the following changes as my first contribution to Codeberg:

 - added list on every section index page, should fix #63
 - added webhooks documentation, should fix #282
 - described behaviour of a limited user profile, should fix #279
 - added further explanation to 2fa section, according to Codeberg/Documentation#268, should fix #268
 - added codeberg badge generator to first-repository description, should fix #39
 - added dns record description to custom-domains, should fix #302
 - added description how to use 2fa with git, should fix #278
 - added and updated repo migration service description, should fix #312

Feedback highly appreciated.

Co-authored-by: f0sh <f0sh@mailbox.org>
Co-authored-by: Panagiotis "Ivory" Vasilopoulos <git@n0toose.net>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/314
Co-authored-by: f0sh <f0sh@noreply.codeberg.org>
Co-committed-by: f0sh <f0sh@noreply.codeberg.org>
2023-07-08 16:27:44 +00:00
fnetx
b4fd4812aa
Style guide is for docs only 2022-10-06 00:49:42 +02:00
Jan Klippel
5bdac45ee5 Create a new section documentation
Extract important articles from the now lengthy FAQ.
This helps to find the documented basics.
Move the Docs-Contributor-FAQ to the new documentation section.
2022-04-14 12:34:58 +02:00