Commit graph

27 commits

Author SHA1 Message Date
Iridium13
246a9e43de Just some minor tweaks to spelling, phrasing etc. (#753)
Co-authored-by: Robert Wolff <mahlzahn@posteo.de>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/753
Reviewed-by: Robert Wolff <mahlzahn@posteo.de>
2026-07-17 12:28:14 +02:00
mukunda katta
64e97c1190 docs: clarify HTTPS auth with 2FA (#784)
## Summary
- clarify that HTTPS Git auth should use an access token as the password when 2FA is enabled
- update both the first repository guide and the CLI clone/commit guide for consistency

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/784
Reviewed-by: Gusted <gusted@noreply.codeberg.org>
2026-05-05 10:41:45 +02:00
mahlzahn
47bc63f657 chore: replace outdated v9 links by redirects to latest version (#754)
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/754
Reviewed-by: Gusted <gusted@noreply.codeberg.org>
Co-authored-by: mahlzahn <mahlzahn@posteo.de>
Co-committed-by: mahlzahn <mahlzahn@posteo.de>
2026-03-02 02:28:16 +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
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
Clea F. Rees
8e6ea413b1 Avoid conflicts if local source tree already exists (#489)
Add instructions for when you already have a local source tree.

Co-authored-by: Clea F. Rees <ReesC21@cardiff.ac.uk>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/489
Reviewed-by: Gusted <gusted@noreply.codeberg.org>
Co-authored-by: Clea F. Rees <cfr@noreply.codeberg.org>
Co-committed-by: Clea F. Rees <cfr@noreply.codeberg.org>
2024-11-28 20:28:00 +00:00
Gusted
b66ba78d58 Update links (#484)
Update Gitea link to Forgejo link.

Add GNU link to ignore.

Remove recommendation for Atom (no longer maintained) instead recommend VSCodium.

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/484
Co-authored-by: Gusted <postmaster@gusted.xyz>
Co-committed-by: Gusted <postmaster@gusted.xyz>
2024-11-27 00:40:44 +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
And4po
d852c5ac0d Getting Started: Fix small typo (#402)
It fixes a small typo on the "First repository" document.

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/402
Reviewed-by: Panagiotis "Ivory" Vasilopoulos <git@n0toose.net>
Co-authored-by: And4po <anderromeroaldana@proton.me>
Co-committed-by: And4po <anderromeroaldana@proton.me>
2024-03-06 12:27:05 +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
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
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
narF
ceec82002b add missing number in first-repository.md 2022-11-29 17:18:29 +00:00
Jeremy
adb83d680d Fix getting-started/first-repository.md 2022-07-26 21:46:39 +02:00
Fauzi Ramadaniza
5d3450e98d Reordering certain Text and Correcting its URL
Combining [Clone & Commit via HTTP] & [Clone & Commit via SSH] to [Clone & Commit via CLI] because it goes to the same URL.

Signed-off-by: Fauzi Ramadaniza <faustzero1@noreply.codeberg.org>
2022-05-15 16:14:35 +02:00
Otto Richter
0e30fb4fe8 Fix internal link 2022-02-13 21:02:00 +01:00
Otto Richter
2bda61e74d Diverse changes (#189)
a bunch of (typo) fixes, additions, rewordings

Update references

- remove mentions of the master branch, as it's removed for many repos
and might change in the future for others (fixes some dead links)
- remove mentions of moved repos with our official examples
- some on-the-fly additions or rewordings

Close #186 foobar->examples

Co-authored-by: fnetx <git@fralix.ovh>
Co-authored-by: fnetX <git@fralix.ovh>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/189
Co-authored-by: Otto Richter <fnetx@noreply.codeberg.org>
Co-committed-by: Otto Richter <fnetx@noreply.codeberg.org>
2022-01-21 11:36:38 +01:00
n
170914185d Add anchor links to headings (#159)
This PR adds anchor links to any markdown headings. It also replaces any hacky workarounds used previously.

Closes #83.

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/159
Co-authored-by: n <n@noreply.codeberg.org>
Co-committed-by: n <n@noreply.codeberg.org>
2021-08-09 11:59:36 +02:00
fnetx
fa7a04afa7
Make all Git and Codeberg mentions uppercase 2021-05-29 15:09:43 +02:00
Martijn de Boer
db1995d687
Getting-started; some grammar and typos 2020-10-16 16:33:00 +02:00
Lucas Hinderberger
0788c1aa65 First Repository Article (#79)
Co-authored-by: Ivan Calandra <12525997+ivan-paleo@users.noreply.github.com>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/79
2020-09-30 04:40:37 +02:00
Lucas Hinderberger
e080c61be2 Knut-ified Screenshots / Typos / Fixes #55 2020-09-02 17:05:09 +02:00
Lucas Hinderberger
897d805b4d Styling fixes 2020-08-31 16:50:44 +02:00
Lucas Hinderberger
cfa9cbbbf5 Blending together codeberg-docs-prototype and original Codeberg/Documentation 2020-08-13 12:31:45 +02:00
Renamed from doc/getting-started/create-repo.md (Browse further)