From 875cb34bdcd7a00d074ac197c309c3cf03f81549 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Javier=20P=C3=A9rez?= Date: Mon, 16 Jun 2025 22:57:17 +0200 Subject: [PATCH] Refactor and fix tables (#627) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit # 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 `` and `` tags in wrong ending order. Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/627 Reviewed-by: Bastian Greshake Tzovaras Co-authored-by: Javier Pérez Co-committed-by: Javier Pérez --- content/advanced/index.md | 16 +- content/codeberg-pages/index.md | 16 +- content/codeberg-pages/using-custom-domain.md | 154 ++++++++------- content/codeberg-translate/index.md | 16 +- content/collaborating/index.md | 16 +- content/collaborating/repo-permissions.md | 176 +++++++++--------- content/getting-started/index.md | 16 +- content/git/index.md | 16 +- content/improving-documentation/index.md | 16 +- content/integrations/index.md | 16 +- content/markdown/index.md | 16 +- content/security/index.md | 16 +- 12 files changed, 258 insertions(+), 232 deletions(-) diff --git a/content/advanced/index.md b/content/advanced/index.md index 42dd8cd..d2d5af2 100644 --- a/content/advanced/index.md +++ b/content/advanced/index.md @@ -17,18 +17,18 @@ Codeberg is based on. {% if entry.url == page.url %} {%- if entry.children.length -%} - +
- + -{%- for child in entry.children %} - -{%- endfor %} + {%- for child in entry.children %} + + + + {%- endfor %} -
Find out more in this section: Find out more in this section:
- {{ child.title }} -
{{ child.title }}
+ {% endif %} {% endif %} {%- endfor %} diff --git a/content/codeberg-pages/index.md b/content/codeberg-pages/index.md index c817ef6..aa57329 100644 --- a/content/codeberg-pages/index.md +++ b/content/codeberg-pages/index.md @@ -40,18 +40,18 @@ See also: {% if entry.url == page.url %} {%- if entry.children.length -%} - +
- + -{%- for child in entry.children %} - -{%- endfor %} + {%- for child in entry.children %} + + + + {%- endfor %} -
Find out more in this section: Find out more in this section:
- {{ child.title }} -
{{ child.title }}
+ {% endif %} {% endif %} {%- endfor %} diff --git a/content/codeberg-pages/using-custom-domain.md b/content/codeberg-pages/using-custom-domain.md index cc9068e..fd87e10 100644 --- a/content/codeberg-pages/using-custom-domain.md +++ b/content/codeberg-pages/using-custom-domain.md @@ -50,24 +50,37 @@ For all of the options it is important that the Pages server knows where to look Depending on from where you want to serve your files, there is a naming scheme for the domain: - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + +
Domain SchemePages URL
username.codeberg.pagehttps://username.codeberg.page
which will serve codeberg.org/username/pages
reponame.username.codeberg.pagehttps://username.codeberg.page/reponame
which will serve codeberg.org/username/reponame
branchname.reponame.username.codeberg.pagehttps://username.codeberg.page/reponame/@branchname/
which will serve codeberg.org/username/reponame/src/branch/branchname
Domain SchemePages URL
+ username.codeberg.page + + https://username.codeberg.page
which will serve codeberg.org/username/pages +
+ reponame.username.codeberg.page + + https://username.codeberg.page/reponame
which will serve codeberg.org/username/reponame +
+ branchname.reponame.username.codeberg.page + + https://username.codeberg.page/reponame/@branchname/
+ which will serve codeberg.org/username/reponame/src/branch/branchname +
_We assume for the following description, that you want to serve your website with and without www in front. @@ -91,18 +104,23 @@ The easiest and recommended way is to just setup a CNAME record for your domain, In the end, it should look like this:
- - - - - - - - - - - - + + + + + + + + + + + + + + + + +
DomainTypeData
yourdomain.comCNAMEreponame.username.codeberg.page
www.yourdomain.comCNAMEreponame.username.codeberg.page
DomainTypeData
yourdomain.comCNAMEreponame.username.codeberg.page
www.yourdomain.comCNAMEreponame.username.codeberg.page

@@ -130,21 +148,22 @@ If you cannot use a CNAME record to configure the target you can use this method In the end it should look like this: - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + +
DomainTypeData
yourdomain.comALIAScodeberg.page
yourdomain.comTXTreponame.username.codeberg.page
www.yourdomain.comCNAMEreponame.username.codeberg.page
DomainTypeData
yourdomain.comALIAScodeberg.page
yourdomain.comTXTreponame.username.codeberg.page
www.yourdomain.comCNAMEreponame.username.codeberg.page
### Option 3: A/AAAA record @@ -161,24 +180,33 @@ If your service provider does not support `ALIAS records` you can also use `A re In the end, it should look like this: - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + +
DomainTypeData
yourdomain.comA217.197.84.141
yourdomain.comAAAA2a0a:4580:103f:c0de::2
yourdomain.comTXTreponame.username.codeberg.page
www.yourdomain.comCNAMEreponame.username.codeberg.page
DomainTypeData
yourdomain.comA217.197.84.141
yourdomain.comAAAA2a0a:4580:103f:c0de::2
yourdomain.comTXTreponame.username.codeberg.page
www.yourdomain.comCNAMEreponame.username.codeberg.page
## Examples diff --git a/content/codeberg-translate/index.md b/content/codeberg-translate/index.md index 27e1b02..94c4652 100644 --- a/content/codeberg-translate/index.md +++ b/content/codeberg-translate/index.md @@ -14,18 +14,18 @@ These documentation pages contain information on how you can use [Codeberg Trans {% if entry.url == page.url %} {%- if entry.children.length -%} - +
- + -{%- for child in entry.children %} - -{%- endfor %} + {%- for child in entry.children %} + + + + {%- endfor %} -
Find out more in this section: Find out more in this section:
- {{ child.title }} -
{{ child.title }}
+ {% endif %} {% endif %} {%- endfor %} diff --git a/content/collaborating/index.md b/content/collaborating/index.md index 65cd395..cac985c 100644 --- a/content/collaborating/index.md +++ b/content/collaborating/index.md @@ -18,18 +18,18 @@ issue tracking and wikis on Codeberg. {% if entry.url == page.url %} {%- if entry.children.length -%} - +
- + -{%- for child in entry.children %} - -{%- endfor %} + {%- for child in entry.children %} + + + + {%- endfor %} -
Find out more in this section: Find out more in this section:
- {{ child.title }} -
{{ child.title }}
+ {% endif %} {% endif %} {%- endfor %} diff --git a/content/collaborating/repo-permissions.md b/content/collaborating/repo-permissions.md index 73f5238..ea4dec9 100644 --- a/content/collaborating/repo-permissions.md +++ b/content/collaborating/repo-permissions.md @@ -42,95 +42,93 @@ By default, the person who creates a repository is an **_Owner_**. The table below gives an overview of what collaborators are allowed to do when granted each of these permission levels: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Task Read Write Admin Owner
View, clone and pull repository {% fas_icon "check" %} {% fas_icon "check" %} {% fas_icon "check" %} {% fas_icon "check" %}
Contribute pull requests {% fas_icon "check" %} {% fas_icon "check" %} {% fas_icon "check" %} {% fas_icon "check" %}
Push to/update contributed pull requests {% fas_icon "check" %} {% fas_icon "check" %} {% fas_icon "check" %} {% fas_icon "check" %}
Push directly to repository {% fas_icon "times" %} {% fas_icon "check" %} {% fas_icon "check" %} {% fas_icon "check" %}
Merge pull requests {% fas_icon "times" %} {% fas_icon "check" %} {% fas_icon "check" %} {% fas_icon "check" %}
Moderate/delete issues and comments {% fas_icon "times" %} {% fas_icon "check" %} {% fas_icon "check" %} {% fas_icon "check" %}
Force-push/rewrite history (if enabled) {% fas_icon "times" %} {% fas_icon "check" %} {% fas_icon "check" %} {% fas_icon "check" %}
Add/remove collaborators to repository {% fas_icon "times" %} {% fas_icon "times" %} {% fas_icon "check" %} {% fas_icon "check" %}
Configure branch settings (protect/un-protect, enable force-push) {% fas_icon "times" %} {% fas_icon "times" %} {% fas_icon "check" %} {% fas_icon "check" %}
Configure repository settings (enable wiki, issues, PRs, update profile) {% fas_icon "times" %} {% fas_icon "times" %} {% fas_icon "check" %} {% fas_icon "check" %}
- Configure repository settings in the danger zone (transfer ownership, delete wiki data / repository, archive repository) - {% fas_icon "times" %} {% fas_icon "times" %} {% fas_icon "times" %} {% fas_icon "check" %}
TaskReadWriteAdminOwner
View, clone and pull repository{% fas_icon "check" %}{% fas_icon "check" %}{% fas_icon "check" %}{% fas_icon "check" %}
Contribute pull requests{% fas_icon "check" %}{% fas_icon "check" %}{% fas_icon "check" %}{% fas_icon "check" %}
Push to/update contributed pull requests{% fas_icon "check" %}{% fas_icon "check" %}{% fas_icon "check" %}{% fas_icon "check" %}
Push directly to repository{% fas_icon "times" %}{% fas_icon "check" %}{% fas_icon "check" %}{% fas_icon "check" %}
Merge pull requests {% fas_icon "times" %}{% fas_icon "check" %}{% fas_icon "check" %}{% fas_icon "check" %}
Moderate/delete issues and comments{% fas_icon "times" %}{% fas_icon "check" %}{% fas_icon "check" %}{% fas_icon "check" %}
Force-push/rewrite history (if enabled){% fas_icon "times" %}{% fas_icon "check" %}{% fas_icon "check" %}{% fas_icon "check" %}
Add/remove collaborators to repository{% fas_icon "times" %}{% fas_icon "times" %}{% fas_icon "check" %}{% fas_icon "check" %}
Configure branch settings (protect/un-protect, enable force-push){% fas_icon "times" %}{% fas_icon "times" %}{% fas_icon "check" %}{% fas_icon "check" %}
Configure repository settings (enable wiki, issues, PRs, update profile){% fas_icon "times" %}{% fas_icon "times" %}{% fas_icon "check" %}{% fas_icon "check" %}
Configure repository settings in the danger zone (transfer ownership, delete wiki data / repository, archive repository){% fas_icon "times" %}{% fas_icon "times" %}{% fas_icon "times" %}{% fas_icon "check" %}
## Teams diff --git a/content/getting-started/index.md b/content/getting-started/index.md index 4616841..0b9b815 100644 --- a/content/getting-started/index.md +++ b/content/getting-started/index.md @@ -29,18 +29,18 @@ Welcome to Codeberg! 😊 {% if entry.url == page.url %} {%- if entry.children.length -%} - +
- + -{%- for child in entry.children %} - -{%- endfor %} + {%- for child in entry.children %} + + + + {%- endfor %} -
Find out more in this section: Find out more in this section:
- {{ child.title }} -
{{ child.title }}
+ {% endif %} {% endif %} {%- endfor %} diff --git a/content/git/index.md b/content/git/index.md index 90883c8..c9e3b41 100644 --- a/content/git/index.md +++ b/content/git/index.md @@ -24,18 +24,18 @@ use (no need to provide credentials on every push). {% if entry.url == page.url %} {%- if entry.children.length -%} - +
- + -{%- for child in entry.children %} - -{%- endfor %} + {%- for child in entry.children %} + + + + {%- endfor %} -
Find out more in this section: Find out more in this section:
- {{ child.title }} -
{{ child.title }}
+ {% endif %} {% endif %} {%- endfor %} diff --git a/content/improving-documentation/index.md b/content/improving-documentation/index.md index 063cdab..4517cbb 100644 --- a/content/improving-documentation/index.md +++ b/content/improving-documentation/index.md @@ -13,18 +13,18 @@ We're very happy you're considering to contribute to Codeberg Documentation! {% if entry.url == page.url %} {%- if entry.children.length -%} - +
- + -{%- for child in entry.children %} - -{%- endfor %} + {%- for child in entry.children %} + + + + {%- endfor %} -
Find out more in this section: Find out more in this section:
- {{ child.title }} -
{{ child.title }}
+ {% endif %} {% endif %} {%- endfor %} diff --git a/content/integrations/index.md b/content/integrations/index.md index 6858342..9436791 100644 --- a/content/integrations/index.md +++ b/content/integrations/index.md @@ -18,18 +18,18 @@ solutions should work with our Forgejo instance, too. {% if entry.url == page.url %} {%- if entry.children.length -%} - +
- + -{%- for child in entry.children %} - -{%- endfor %} + {%- for child in entry.children %} + + + + {%- endfor %} -
Find out more in this section: Find out more in this section:
- {{ child.title }} -
{{ child.title }}
+ {% endif %} {% endif %} {%- endfor %} diff --git a/content/markdown/index.md b/content/markdown/index.md index 376f800..d522113 100644 --- a/content/markdown/index.md +++ b/content/markdown/index.md @@ -28,18 +28,18 @@ look them up and learn more about Markdown. {% if entry.url == page.url %} {%- if entry.children.length -%} - +
- + -{%- for child in entry.children %} - -{%- endfor %} + {%- for child in entry.children %} + + + + {%- endfor %} -
Find out more in this section: Find out more in this section:
- {{ child.title }} -
{{ child.title }}
+ {% endif %} {% endif %} {%- endfor %} diff --git a/content/security/index.md b/content/security/index.md index 1fcf603..418e236 100644 --- a/content/security/index.md +++ b/content/security/index.md @@ -13,18 +13,18 @@ This section contains information on how to securely use Codeberg. {% if entry.url == page.url %} {%- if entry.children.length -%} - +
- + -{%- for child in entry.children %} - -{%- endfor %} + {%- for child in entry.children %} + + + + {%- endfor %} -
Find out more in this section: Find out more in this section:
- {{ child.title }} -
{{ child.title }}
+ {% endif %} {% endif %} {%- endfor %}