Commit graph

27 commits

Author SHA1 Message Date
Dependency bot
a8f296562d chore(deps): update dependency prettier to v3.9.4 (#841)
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/841
Reviewed-by: Gusted <gusted@noreply.codeberg.org>
2026-07-13 00:45:22 +02:00
Kevin Ernst
18cbfe76e8 Add more complete examples to Markdown preformatted text sections (#805)
Inline `code spans` are now mentioned alongsize bold and italics where it makes the most sense to have them, and the preformatted text document has been updated to show the raw Markdown for each example. Each of these documents also cross-references the other, as an aid to the reader.

Several sections in `preformatted-text.md` have been renamed for clarity, with  `<a id="old-section-title"></a>` anchors such that inbound links with [fragment identifiers](https://en.wikipedia.org/wiki/URI_fragment#Basics) (direct section links) should not break as a result.

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/805
Reviewed-by: Robert Wolff <mahlzahn@posteo.de>
2026-06-25 14:03:45 +02:00
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
Gusted
41f747ab47 Introduction to markdown other style (#724)
The linter enforced one style but the introduction should show both
styles, add a ignore lint and make it show the other style.

Reported-by: @mahlzahn
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/724
Reviewed-by: Bastian Greshake Tzovaras <gedankenstuecke@noreply.codeberg.org>
Reviewed-by: Robert Wolff <mahlzahn@posteo.de>
Co-authored-by: Gusted <postmaster@gusted.xyz>
Co-committed-by: Gusted <postmaster@gusted.xyz>
2025-12-19 20:10:04 +01:00
Gusted
ad9e3c53e0 Make linters happy (#723)
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/723
Co-authored-by: Gusted <postmaster@gusted.xyz>
Co-committed-by: Gusted <postmaster@gusted.xyz>
2025-12-19 02:12:14 +01:00
d2weber
824a6bf458 Adjust decsription of checkboxes (#720)
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/720
Reviewed-by: Robert Wolff <mahlzahn@posteo.de>
Co-authored-by: d2weber <d2weber@noreply.codeberg.org>
Co-committed-by: d2weber <d2weber@noreply.codeberg.org>
2025-12-13 16:59:10 +01:00
bgg
10f7ef9593 Add how to add footnotes in a markdown file. (#718)
It could be useful to have this information in the documentation.

Co-authored-by: bgg <bgg@bombe>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/718
Reviewed-by: Bastian Greshake Tzovaras <gedankenstuecke@noreply.codeberg.org>
Reviewed-by: Robert Wolff <mahlzahn@posteo.de>
Co-authored-by: bgg <bgg@noreply.codeberg.org>
Co-committed-by: bgg <bgg@noreply.codeberg.org>
2025-12-12 19:32:28 +01:00
mystie
ac93059053 fix typo in content/markdown/faq.md (#703)
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/703
Reviewed-by: Gusted <gusted@noreply.codeberg.org>
Co-authored-by: mystie <mystie@noreply.codeberg.org>
Co-committed-by: mystie <mystie@noreply.codeberg.org>
2025-11-22 11:07:10 +01: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
Jan Koll
b97624349b fix: correct typo in inline-css (#647)
Fixes #646

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/647
Reviewed-by: Robert Wolff <mahlzahn@posteo.de>
Co-authored-by: Jan Koll <jan.niklas.koll@gmail.com>
Co-committed-by: Jan Koll <jan.niklas.koll@gmail.com>
2025-07-21 13:09:13 +02:00
Bastian Greshake Tzovaras
7cfd905bd4 add docs on alternative link syntax (#638)
This adds a small section to the markdown link section of the docs to also outline the `[[ link ]]` syntax that is supported in markdown texts that are rendered to html.

Closes #524.

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/638
Reviewed-by: Robert Wolff <mahlzahn@posteo.de>
Co-authored-by: Bastian Greshake Tzovaras <bgreshake@googlemail.com>
Co-committed-by: Bastian Greshake Tzovaras <bgreshake@googlemail.com>
2025-07-11 21:09:46 +02: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
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
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
Abdur-Rahman Mansoor
8e0118c9c5
refactor: use american spelling convention and fix grammar 2024-05-24 20:51:47 -04:00
Otto Richter
d5f6f22999 Refresh Contact, Getting Started, Contributing Pages (#394)
Update contact page

Prefer references to Forgejo, more relevant to users

Updates to Getting Started Pages / FAQ
- a lot of content was outdated and generally rewritten or rephrased
- implement procedure for size limits as determined by annual assembly
  2023, see Codeberg-e.V./Discussion#92
- people are sometimes confused wheter you need to be a paying member in
  Codeberg e.V. in order to use the platform

Update improving Codeberg guides
- reduce redundancy in code contribution guide and reference the
  Contributing Issue Tracker instead
- separate (and ideally more appealing) donation page (deserves even
  more love IMHO)
- shorten and strip outdated information

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/394
Reviewed-by: Panagiotis "Ivory" Vasilopoulos <git@n0toose.net>
Co-authored-by: Otto Richter <git@otto.splvs.net>
Co-committed-by: Otto Richter <git@otto.splvs.net>
2024-02-17 22:04:10 +00:00
ToaKraka
6c2ced0ab3 Remove references to a specific version of CommonMark (#390)
The current text refers to CommonMark 0.30, but the latest version of CommonMark is 0.31.2, and the latest version of GoldMark is compatible with that version of CommonMark.

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/390
Reviewed-by: Gusted <gusted@noreply.codeberg.org>
Co-authored-by: ToaKraka <toakraka@noreply.codeberg.org>
Co-committed-by: ToaKraka <toakraka@noreply.codeberg.org>
2024-02-06 22:15:06 +00:00
Lucas Hinderberger
a27a71bf0f Workaround: Markdown parser does not ignore backtick fence inside tilde fence 2023-07-21 21:17:17 +02:00
Lucas Hinderberger
d55c1397f7 Replacing indented code blocks with fenced code blocks 2023-07-21 21:17:17 +02:00
f0sh
77bfb6cc15 Change all Gitea references to Forgejo, fix #315 (#322)
Where possible, changed all references from Gitea to Forgejo.
Wherever documentation mentions specifically Gitea, it is preserved.

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/322
Co-authored-by: f0sh <f0sh@mailbox.org>
Co-committed-by: f0sh <f0sh@mailbox.org>
2023-07-18 00:43:47 +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
Felipe Leopoldo Sologuren Gutiérrez
98c40b8a07 Fixing broken links (#267)
Changes:
 * Fallback images links are all lowercase now.
 * Fix html redirect (meta tag http-equiv redirect) from ```/git/clone-commit-via-http ```to ```/git/clone-commit-via-web```.
 * Added protocol to an email link.
 * Fix some pages links.

To detect broken links I used wget:

```
wget --spider --recursive --level=0 --debug -e robots=off --base=http://localhost:8080 http://localhost:8080 2>&1 | grep ^Found\ [0-9]*\ broken\ link
```

However, wget detects html redirects (meta tag http-equiv refresh) as false positive.

If broken links have found, then the referer header will be searched for find out where they are:
```
wget --spider --recursive --level=0 --save-headers --debug -e robots=off --base=http://localhost:8080 http://localhost:8080 2>&1 | less
```

Co-authored-by: fsologureng <sologuren@estudiohum.cl>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/267
Co-authored-by: Felipe Leopoldo Sologuren Gutiérrez <fsologureng@noreply.codeberg.org>
Co-committed-by: Felipe Leopoldo Sologuren Gutiérrez <fsologureng@noreply.codeberg.org>
2022-10-03 21:35:01 +02:00
Jeremy
f85f9e601a Fix markdown/* 2022-07-26 21:46:39 +02:00
jklippel
5f022adfc6 Initial version of a Markdown documentation (#221)
Add initial version of a Markdown documentation to explain Markdown to new contributors. Also provides a styleguide to guide to a consistent use of the Markdown markup within Codeberg.

Fixes #59

Co-authored-by: Jan Klippel <c0d3b3rg@kl1pp3l.de>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/221
Co-authored-by: jklippel <jklippel@noreply.codeberg.org>
Co-committed-by: jklippel <jklippel@noreply.codeberg.org>
2022-04-23 21:18:08 +02:00
Lucas Hinderberger
cfa9cbbbf5 Blending together codeberg-docs-prototype and original Codeberg/Documentation 2020-08-13 12:31:45 +02:00