Compare commits

...

307 commits

Author SHA1 Message Date
pat-s 2d9da16b4b
trigger pipeline on pull_request_closed event 2024-06-15 12:35:31 +02:00
pat-s 958ae25b8b
prettier: ignore pnpm lock 2024-06-15 10:39:12 +02: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
pat-s 72c195924b
use pnpm in deploy preview 2024-06-12 11:43:56 +02:00
pat-s 52dd22ef8e
remove package-lock.json after switch to pnpm 2024-06-12 11:20:04 +02:00
niko4u 1b84cd41a4 Minor rewording (#428)
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/428
Reviewed-by: Patrick Schratz <pat-s@noreply.codeberg.org>
Co-authored-by: niko4u <niko4u@noreply.codeberg.org>
Co-committed-by: niko4u <niko4u@noreply.codeberg.org>
2024-06-12 08:57:35 +00:00
Patrick Schratz 65e44a8cfa Add deploy preview via surge (#434)
fix #345

- [x] Use a dummy user instead of my personal one (to avoid getting notifications from surge)

- [x] README doc

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/434
2024-06-12 08:52:08 +00:00
pat-s d7197f935a
lychee: ignore openclipart.org due to timeouts 2024-06-12 10:50:26 +02:00
pat-s c12e26e446 Switch to pnpm (#432)
As `pnpm` is xx times faster than `npm`.

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/432
Co-authored-by: pat-s <patrick.schratz@gmail.com>
Co-committed-by: pat-s <patrick.schratz@gmail.com>
2024-06-12 08:44:42 +00:00
pat-s c7a2a29c7f
increase lychee timeout from 20 to 40 2024-06-12 10:35:42 +02:00
pat-s 3cab99a27f
fix liberapay lint issues and broken link 2024-06-12 10:25:04 +02:00
fnetX c6c7b418e7 Fix typo
Build was failing. This was overlooked, because CI was only added after the PR was last updated.
2024-06-11 11:51:51 +00:00
Igor 0d872ea674 Integrating LiberaPay with Codeberg (#406)
This should resolve issue #327 opened by @n0toose

I have written a little bit of example, how do I see it

Co-authored-by: I <igor@its.rel.pl>
Co-authored-by: Panagiotis "Ivory" Vasilopoulos <git@n0toose.net>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/406
Co-authored-by: Igor <309631@noreply.codeberg.org>
Co-committed-by: Igor <309631@noreply.codeberg.org>
2024-06-11 11:47:25 +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
Dependency bot 8f5231283e chore: Configure Renovate (#433)
Welcome to [Renovate](https://github.com/renovatebot/renovate)! This is an onboarding PR to help you understand and configure settings before regular Pull Requests begin.

🚦 To activate Renovate, merge this Pull Request. To disable Renovate, simply close this Pull Request unmerged.

---
### Detected Package Files

 * `Dockerfile` (dockerfile)
 * `package.json` (npm)

### Configuration Summary

Based on the default config's presets, Renovate will:

  - Start dependency updates only once this onboarding PR is merged
  - Enable Renovate Dependency Dashboard creation.
  - Use semantic commit type `fix` for dependencies and `chore` for all others if semantic commits are in use.
  - Ignore `node_modules`, `bower_components`, `vendor` and various test/tests directories.
  - Group known monorepo packages together.
  - Use curated list of recommended non-monorepo package groupings.
  - Apply crowd-sourced package replacement rules.
  - Apply crowd-sourced workarounds for known problems with packages.
  - Run lock file maintenance (updates) early Monday mornings.
  - Schedule automerge daily.
  - Schedule for weekends.
  - Enable Renovate Dependency Dashboard creation.
  - Use semantic commit type `fix` for dependencies and `chore` for all others if semantic commits are in use.
  - Ignore `node_modules`, `bower_components`, `vendor` and various test/tests directories.
  - Group known monorepo packages together.
  - Use curated list of recommended non-monorepo package groupings.
  - Apply crowd-sourced package replacement rules.
  - Apply crowd-sourced workarounds for known problems with packages.
  - Run lock file maintenance (updates) early Monday mornings.
  - Schedule automerge daily.
  - Schedule for weekends.
  - Run Renovate on following schedule: every weekend

🔡 Do you want to change how Renovate upgrades your dependencies? Add your custom config to `renovate.json` in this branch. Renovate will update the Pull Request description the next time it runs.

---

### What to Expect

With your current configuration, Renovate will create 5 Pull Requests:

<details>
<summary>chore(deps): update dependency pagefind to v1.1.0</summary>

  - Schedule: ["every weekend"]
  - Branch name: `renovate/pagefind-1.x-lockfile`
  - Merge into: `main`
  - Upgrade [pagefind](https://github.com/CloudCannon/pagefind) to `1.1.0`

</details>

<details>
<summary>chore(deps): update font awesome to v6.5.2</summary>

  - Schedule: ["every weekend"]
  - Branch name: `renovate/font-awesome`
  - Merge into: `main`
  - Upgrade [@fortawesome/fontawesome-svg-core](https://github.com/FortAwesome/Font-Awesome) to `6.5.2`
  - Upgrade [@fortawesome/free-solid-svg-icons](https://github.com/FortAwesome/Font-Awesome) to `6.5.2`

</details>

<details>
<summary>chore(deps): update dependency markdown-it-anchor to v9</summary>

  - Schedule: ["every weekend"]
  - Branch name: `renovate/markdown-it-anchor-9.x`
  - Merge into: `main`
  - Upgrade [markdown-it-anchor](https://github.com/valeriangalliat/markdown-it-anchor) to `^9.0.0`

</details>

<details>
<summary>chore(deps): update node.js to v16</summary>

  - Schedule: ["every weekend"]
  - Branch name: `renovate/node-16.x`
  - Merge into: `main`
  - Upgrade [node](https://github.com/nodejs/node) to `16.15.1-stretch-slim`

</details>

<details>
<summary>chore(deps): lock file maintenance</summary>

  - Schedule: ["before 4am on Monday"]
  - Branch name: `renovate/lock-file-maintenance`
  - Merge into: `main`
  - Regenerate lock files to use latest dependency versions

</details>

<br />

🚸 Branch creation will be limited to maximum 2 per hour, so it doesn't swamp any CI resources or overwhelm the project. See docs for `prhourlylimit` for details.

---

 Got questions? Check out Renovate's [Docs](https://docs.renovatebot.com/), particularly the Getting Started section.
If you need any further assistance then you can also [request help here](https://github.com/renovatebot/renovate/discussions).

---

This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).

<!--renovate-config-hash:67259f1d62398ce599523778399b8abd7a312190509ac1958cd9cc122e7196ad-->

Co-authored-by: woodpecker-bot <woodpecker-bot@obermui.de>
Co-authored-by: pat-s <pat-s@noreply.codeberg.org>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/433
Co-authored-by: Dependency bot <renovate-bot@noreply.codeberg.org>
Co-committed-by: Dependency bot <renovate-bot@noreply.codeberg.org>
2024-06-11 07:47:06 +00:00
Sammy Hori 8bd521c7f6 Codeberg Pages: Add warning for setting up records on some registrars (#431)
Many users setting up Codeberg Pages that use the records have limited experience with DNS.

Therefore, adding this warning to make it clear what they may need to be entering into
their records will likely save them time and effort in troubleshooting why their page may
not be loading correctly.

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/431
Co-authored-by: Sammy Hori <sammyhori@noreply.codeberg.org>
Co-committed-by: Sammy Hori <sammyhori@noreply.codeberg.org>
2024-06-09 14:23:36 +00:00
adbagio 79d2ac2682 Getting Started: Add detail to use of git push --mirror (#422)
Based on discussion in the Forgejo repository (#2834)

See: https://codeberg.org/forgejo/forgejo/pulls/2834

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/422
Co-authored-by: adbagio <h759bkyo4@mozmail.com>
Co-committed-by: adbagio <h759bkyo4@mozmail.com>
2024-06-07 11:05:44 +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
Abdur-Rahman Mansoor 8e0118c9c5
refactor: use american spelling convention and fix grammar 2024-05-24 20:51:47 -04:00
Skye 51da37c7d4 Pedantic capitalization changes to brand names (#425)
Some instances of Github and Gitlab have been changed to GitHub and GitLab
respectively.

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/425
Reviewed-by: Panagiotis "Ivory" Vasilopoulos <git@n0toose.net>
Co-authored-by: Skye <skyeforeverblue@outlook.com>
Co-committed-by: Skye <skyeforeverblue@outlook.com>
2024-05-19 21:24:00 +00:00
Sergey Volkov d475852dc2 Add SSH commit signing content (#420)
Add the SSH commit signing section to the SSH key management page. Git has had this feature for a while now and SSH keys are easier to manage since they can be used for both authentication and signing, so I think it makes sense to document this.

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/420
Reviewed-by: Panagiotis "Ivory" Vasilopoulos <git@n0toose.net>
Co-authored-by: Sergey Volkov <ser121512@yandex.ru>
Co-committed-by: Sergey Volkov <ser121512@yandex.ru>
2024-05-16 13:55:48 +00:00
0ko 60d471874b Improve contact/support information 2024-04-10 22:43:53 +05:00
Andrew Kvalheim 0b3c45ce4b Detect slash key by value, not physical position (#415)
The solution is trivial; read the [property](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent#instance_properties) for actual meaning instead of physical position.

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/415
Reviewed-by: Gusted <gusted@noreply.codeberg.org>
Co-authored-by: Andrew Kvalheim <andrew@kvalhe.im>
Co-committed-by: Andrew Kvalheim <andrew@kvalhe.im>
2024-04-03 12:12:54 +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
Gusted adf276bea6
pages: Correct statement about CAA record
- Resolves https://codeberg.org/Codeberg/Documentation/issues/413
2024-03-23 22:15:22 +01: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
Earl Warren 465aaaa107 CI (Actions): Clarify compatibility & link to the latest docs (#405)
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/405
Reviewed-by: Panagiotis "Ivory" Vasilopoulos <git@n0toose.net>
Co-authored-by: Earl Warren <contact@earl-warren.org>
Co-committed-by: Earl Warren <contact@earl-warren.org>
2024-03-12 17:58:13 +00:00
Andre601 7a9017e760 Fix broken link for Git LFS Migrate Man page (#404)
The URL for the man page of Git LFS migrate was broken. This is fixed in this PR.

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/404
Co-authored-by: Andre601 <github@andre601.ch>
Co-committed-by: Andre601 <github@andre601.ch>
2024-03-11 12:19:54 +00:00
Panagiotis "Ivory" Vasilopoulos 2ce0c26e3d Pages: Repositories currently have to be public (#395)
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/395
Reviewed-by: Gusted <gusted@noreply.codeberg.org>
2024-03-10 16:13:45 +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
Leo Heitmann Ruiz 364a316007 Remove unnecessary mention of Git Bash (#400)
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/400
Reviewed-by: Panagiotis "Ivory" Vasilopoulos <git@n0toose.net>
Co-authored-by: Leo Heitmann Ruiz <eo@noreply.codeberg.org>
Co-committed-by: Leo Heitmann Ruiz <eo@noreply.codeberg.org>
2024-03-06 10:19:01 +00:00
kouett 85d333f48b Fix typo in sphinx quickstart cmd (#397)
I believe the "pip" in front is extraneous. This is a small change.

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/397
Co-authored-by: kouett <lou@ynh.kouett.net.eu.org>
Co-committed-by: kouett <lou@ynh.kouett.net.eu.org>
2024-02-22 12:48:37 +00: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
thatonecoder 2b85a21e70 Licensing: Licence -> License (#392)
This should make it comply a bit more with the style guide.

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/392
Reviewed-by: Panagiotis "Ivory" Vasilopoulos <git@n0toose.net>
Co-authored-by: thatonecoder <thatonecoder@noreply.codeberg.org>
Co-committed-by: thatonecoder <thatonecoder@noreply.codeberg.org>
2024-02-12 13:14:41 +00:00
Mark Pitblado 8a32b7cec9 Pages: General typo and grammatical fixes (#391)
Main changes include switching language from ISP to domain registrar, and standardization around the phrase "Codeberg Pages".

Signed-off-by: Mark Pitblado <mark@pitblado.me>

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/391
Reviewed-by: crapStone <codeberg@crapstone.dev>
Co-authored-by: Mark Pitblado <mark-pitblado@noreply.codeberg.org>
Co-committed-by: Mark Pitblado <mark-pitblado@noreply.codeberg.org>
2024-02-09 08:18:50 +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
kita d13287b3a8
fix configuring git link 2024-02-03 13:10:00 +08:00
Panagiotis "Ivory" Vasilopoulos 1de25174bc Codeberg CI: Fix small URL typo
Caused by myself on 4a11765382.
2024-02-01 03:44:41 +01:00
quecomet 4a11765382 Codeberg CI: Improve usage and request instructions (#381)
Closes https://codeberg.org/Codeberg-CI/feedback/issues/153

Co-authored-by: Panagiotis "Ivory" Vasilopoulos <git@n0toose.net>
Co-authored-by: pat-s <patrick.schratz@gmail.com>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/381
Co-authored-by: quecomet <quecomet@proton.me>
Co-committed-by: quecomet <quecomet@proton.me>
2024-01-31 21:39:10 +00:00
jmarsal bf5fe32d6a
refactor: move the command needed to a 'note' ('info') admonition box 2024-01-24 19:29:36 +01:00
jmarsal b7f25f1431
feat: add shell command to add your GPG key to .bashrc, otherwise the signing process will not work 2024-01-23 19:32:22 +01:00
Ralf Stubner 79d5804969 Remove warning about _redirect file on Codeberg Pages (#382)
According to https://codeberg.org/Codeberg/pages-server/issues/234 the `_redirect` file feature has been activated on Codeberg Pages.

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/382
Reviewed-by: Gusted <gusted@noreply.codeberg.org>
Co-authored-by: Ralf Stubner <rstub@noreply.codeberg.org>
Co-committed-by: Ralf Stubner <rstub@noreply.codeberg.org>
2024-01-01 22:36:39 +00:00
A Frederick Christensen 6c05b15edb Minor correction of a missed word (#380)
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/380
Reviewed-by: Panagiotis "Ivory" Vasilopoulos <git@n0toose.net>
Co-authored-by: A Frederick Christensen <fauxmight@noreply.codeberg.org>
Co-committed-by: A Frederick Christensen <fauxmight@noreply.codeberg.org>
2023-12-26 13:02:29 +00:00
Mohamed Wageh ca4290e697 Automatically generate Table of Contents for each page (#376)
Closes #24.

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/376
Co-authored-by: Mohamed Wageh <oatbiscuits@proton.me>
Co-committed-by: Mohamed Wageh <oatbiscuits@proton.me>
2023-12-11 17:32:09 +00:00
oatbiscuits f0408b2c6a Add documentation for Forgejo CI Actions runner (#369)
This should solve #318.

Helped-by: Linus Groh <mail@linusgroh.de>
Reviewed-by: Panagiotis "Ivory" Vasilopoulos <git@n0toose.net>
Reviewed-by: Linus Groh <mail@linusgroh.de>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/369
Co-authored-by: oatbiscuits <oatbiscuits@noreply.codeberg.org>
Co-committed-by: oatbiscuits <oatbiscuits@noreply.codeberg.org>
2023-12-07 16:58:07 +00:00
Gusted 1925a19f11 Better placeholder contrast for search input (#375)
Increase the contrast of the placeholder text in the search input, so it's actually readable.

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/375
Co-authored-by: Gusted <postmaster@gusted.xyz>
Co-committed-by: Gusted <postmaster@gusted.xyz>
2023-12-01 22:26:53 +00:00
Panagiotis "Ivory" Vasilopoulos f499322a61 Pages: More background information (#374)
- Link to repository
- More organized "See also" section
- Link to FEATURES.md of Pages repository

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/374
2023-11-30 22:04:10 +00:00
oatbiscuits 55a504e33a Add search functionality (#370)
This should solve #23.

This is a fully static search implementation powered by [Pagefind](https://pagefind.app/).

In terms of UI, I found and implemented a section in the sidebar for searching the documentation. It was hidden presumably waiting for implementation. It mentioned using the slash (/) key for searching, so I implemented the hotkey as well.

I made the indexing command required by Pagefind run after Eleventy finishes building using the `.after` hook.

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/370
Co-authored-by: oatbiscuits <oatbiscuits@noreply.codeberg.org>
Co-committed-by: oatbiscuits <oatbiscuits@noreply.codeberg.org>
2023-11-30 21:33:22 +00:00
Gusted 57b888bd6c Fix incorrect link (#373)
- Use non-md link.
- Resolves https://codeberg.org/Codeberg/Documentation/issues/372

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/373
Co-authored-by: Gusted <gusted@noreply.codeberg.org>
Co-committed-by: Gusted <gusted@noreply.codeberg.org>
2023-11-29 22:43:48 +00:00
Alex 966404aa5c Using Security keys on Codeberg (#367)
This PR adds docs on WebAuthn usage on Codeberg. It attempts to cover:
- using WebAuthn as a 2FA option on web logins
- using FIDO2 over SSH using the OpenSSH client

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/367
Co-authored-by: Alex <alex@blueselene.com>
Co-committed-by: Alex <alex@blueselene.com>
2023-11-28 20:57:37 +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
Otto a6a0a1c9ba Update weblinks from CI page 2023-11-26 18:33:40 +00:00
Otto e4ea4343ab Update contact information 2023-11-13 15:44:08 +00:00
Andre601 df95d70243 Add entry about Cloudflare in content/codeberg-pages/troubleshooting.md (#351)
Added an entry to the troubleshooting page for Codeberg pages that addresses the situation with Cloudflare, where you should turn DNS entries pointing to Codeberg pages to **DNS only** for it to work reliably.

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/351
Co-authored-by: Andre601 <andre601@noreply.codeberg.org>
Co-committed-by: Andre601 <andre601@noreply.codeberg.org>
2023-11-10 11:24:40 +00:00
narF e9748990e2 For local commits, mention "Configuring Git" in Email Settings guide (#355)
Co-authored-by: Panagiotis "Ivory" Vasilopoulos <git@n0toose.net>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/355
Co-authored-by: narF <narf@noreply.codeberg.org>
Co-committed-by: narF <narf@noreply.codeberg.org>
2023-10-14 14:17:16 +00:00
crystal 7bb8fa5ca5 Add note to not expect responses to abuse reports (#357)
Also clarifies language about custom domains and codeberg.page

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/357
Co-authored-by: crystal <crystal@noreply.codeberg.org>
Co-committed-by: crystal <crystal@noreply.codeberg.org>
2023-09-22 15:44:12 +00: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
Panagiotis "Ivory" Vasilopoulos 536884cd59 Simpify and update instructions for reports
The language was simplified, some explanations as to which methods are
preferred for which situations were provided, and I also added an
explanation for the new "tag @moderation to report spam" feature.

I tried to make the content less ambiguous and easier to read.

This change was made because of the following issue in the Community
repository: https://codeberg.org/Codeberg/Community/issues/1293
2023-09-18 10:02:53 +02:00
Panagiotis "Ivory" Vasilopoulos 3261f41b63 Add note about retaliatory abuse in Contact section (#334)
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/334
2023-09-18 07:47:41 +00:00
Panagiotis "Ivory" Vasilopoulos 7c15ec5243 Improve FAQ section (#347)
- Create two sections, "Codeberg's Structures" and "Before I move..."
- Explain that Codeberg is not necessarily *just* a Forgejo instance
  by mentioning / crediting more open-source projects in a
  non-exhaustive manner.
- Improve wording and phrasing of some questions
- Update Forgejo version instructions
- Private repositories: Split into two questions that are separately
  meant for collaborative projects and ordinary users respectively.
- Use words as "most likely" and "probably" in order to *not* make the
  reader immediately worry about potentially breaking the rules,
  especially as the ToS itself mentions that the platform reserves
  the right to take strict action without a warning. If the user
  choose Codeberg to begin with, it is very likely that "our" values
  align.
- Explain what "fair use" is as far as the repository size is concerned
  better.
- Break text into new lines depending on columns and the ideas that
  each part of a sentence gets across.

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/347
2023-09-11 20:49:18 +00:00
nezbednik b17bda7c61 Fix minor spelling mistake in CI index page (#352)
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/352
Co-authored-by: nezbednik <nezbednik@atlas.cz>
Co-committed-by: nezbednik <nezbednik@atlas.cz>
2023-09-09 19:29:41 +00:00
Panagiotis "Ivory" Vasilopoulos 1403a81d75 Improve 'Contributing Code' guide (#326)
* Improve references to Forgejo and Gitea
* Point reader to potentially good first issues
* Be more specific as to what kinds of patches can be submitted to the
  `Codeberg/forgejo` repository
* Explain how easy Go can be for beginners better
* Include some advice as to what a prospective contributor can work on
  based on personal experiences

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/326
2023-08-22 13:17:52 +00:00
Panagiotis "Ivory" Vasilopoulos 51c394cd3b 'Projects' has been renamed to 'Contributing' 2023-08-03 20:05:12 +00:00
Panagiotis "Ivory" Vasilopoulos 092ae8e74c Mention Codeberg-e.V./requests in FAQ (#336)
This was added because a user was not sure where they could request an
increase to the repository limit of an organization that they intended
to use for a hackathon.

We may want to consider creating a more detailed page about this later.

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/336
2023-08-03 19:59:56 +00:00
rtn 3e3dbf8dd3 Update 'content/codeberg-translate/introduction-to-weblate.md' (#338)
Some language tweaks.

* remove capital letters from some words
* fix typos

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/338
Co-authored-by: rtn <rtn@noreply.codeberg.org>
Co-committed-by: rtn <rtn@noreply.codeberg.org>
2023-07-25 10:49:50 +00:00
Lucas Hinderberger 68d5b2a9a0 Merge branch 'eleventy2' 2023-07-21 21:25:02 +02: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
Lucas Hinderberger 91fbf7a9a0 Replacing tabs with spaces 2023-07-21 21:17:17 +02:00
Lucas Hinderberger 51ea0f2bf1 Updating dependencies 2023-07-21 21:17:17 +02:00
Panagiotis "Ivory" Vasilopoulos 836ce8e83b Remove subreddit from Contact information (#333)
The community has been marked as private.

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/333
2023-07-21 15:45:55 +00:00
Panagiotis "Ivory" Vasilopoulos 37b507b6f7 Fix styling and factual errors in 'Repository Permissions' (#328)
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/328
2023-07-20 21:46:54 +00:00
Andre601 a21dbdd678 Add note about _redirects status (#329)
As mentioned in https://codeberg.org/Codeberg/pages-server/issues/234

The `_redirects` file feature seems to not yet be implemented in the production version of Codeberg Pages. That combined with the fact that the docs give the impression that it is available can and will cause confusion for people.

I've added a simple note at the top of the page, informing about the status of this feature not yet being available.

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/329
Co-authored-by: Andre601 <andre601@noreply.codeberg.org>
Co-committed-by: Andre601 <andre601@noreply.codeberg.org>
2023-07-20 21:06:05 +00:00
Panagiotis "Ivory" Vasilopoulos 5d457efc06 Clean up 'Clone & Commit via CLI' guide (#325)
* Fix typos
* Simplify language
* Increase clarity as to whether the CLI tools are official
* Make language slightly more formal
* Gaps between headers and content

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/325
2023-07-18 14:29:05 +00:00
Panagiotis "Ivory" Vasilopoulos dd6d870c69 Link to Gitea docs on index page (#323)
Based on social media feedback regarding Forgejo's documentation
not always covering everything. Although it is probably best to use
the Forgejo documentation wherever possible, it is probably in the
interest of our users to link back to both sites.

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/323
2023-07-18 09:46:27 +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
Oscar Carballal Prego a25f81e9a2 Improve authentication wording for Matrix integration (#321)
The current documentation fails to specify that the authentication token required a "Bearer" prefix. If a user follows the docs to the letter, it will fail. This patch explains that the user has to add "Bearer" to the token to be able to work.

Co-authored-by: Oscar Carballal Prego <oscar@lareira.digital>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/321
Co-authored-by: Oscar Carballal Prego <oscarcp@noreply.codeberg.org>
Co-committed-by: Oscar Carballal Prego <oscarcp@noreply.codeberg.org>
2023-07-17 09:00:30 +00:00
Panagiotis "Ivory" Vasilopoulos a9d53ca7cb Add documentation for Keycloak (#316)
Simple guide for using Keycloak with Codeberg based on the instructions
provided by Shane Engelman in Codeberg's Matrix chat.

Co-authored-by: shane <contact@shane.gg>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/316
2023-07-15 20:49:21 +00:00
Panagiotis "Ivory" Vasilopoulos 89538796b4 Improve index site (#317)
* Introduce links to other documentation sources
* Improve wording
* Explain the purpose of Codeberg's Documentation

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/317
2023-07-14 21:21:16 +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
JakobDev ff8910c5ee Add Documentation for Codeberg Translate (#300)
This is a simple documentation for Codeberg Translate. I think it can be improved in some points (especially the wording), but it should be a good start.

Closes: https://codeberg.org/Codeberg/Documentation/issues/273
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/300
Co-authored-by: JakobDev <jakobdev@gmx.de>
Co-committed-by: JakobDev <jakobdev@gmx.de>
2023-07-04 21:02:20 +00:00
Otto 065c065e09 Revisit CI section 2023-06-29 23:12:29 +00:00
Panagiotis "Ivory" Vasilopoulos 8fe5dd27d6 Improve clarity of wiki documentation (#305)
Fixes https://codeberg.org/Codeberg/Community/issues/1001#issuecomment-890160

Co-authored-by: Panagiotis "Ivory" Vasilopoulos <git@n0toose.net>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/305
Co-authored-by: Panagiotis "Ivory" Vasilopoulos <n0toose@noreply.codeberg.org>
Co-committed-by: Panagiotis "Ivory" Vasilopoulos <n0toose@noreply.codeberg.org>
2023-06-23 01:06:16 +00:00
NeatNit 2887826c38 Update SSH connection test text to match actual result (#307)
I just went through these steps and noticed that the message is wrong, so here's the update. Note that the message normally shows the username and key name, which I've replaced with "____".

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/307
Co-authored-by: NeatNit <neatnit@noreply.codeberg.org>
Co-committed-by: NeatNit <neatnit@noreply.codeberg.org>
2023-05-30 09:07:14 +00:00
d7415 e91d2ea42e A list of subscriptions is now available (#306)
This feature was added in this Gitea PR: https://github.com/go-gitea/gitea/issues/16111

Co-authored-by: Martin Stone <martin@d7415.co.uk>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/306
Co-authored-by: d7415 <martin@d7415.co.uk>
Co-committed-by: d7415 <martin@d7415.co.uk>
2023-05-24 14:25:23 +00:00
video-prize-ranch 95574213ea Redirects documentation (#294)
Documentation for redirects on Codeberg Pages:
https://codeberg.org/Codeberg/pages-server/pulls/148

Co-authored-by: video-prize-ranch <cb.8a3w5@simplelogin.co>
Co-authored-by: 6543 <6543@obermui.de>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/294
Co-authored-by: video-prize-ranch <video-prize-ranch@noreply.codeberg.org>
Co-committed-by: video-prize-ranch <video-prize-ranch@noreply.codeberg.org>
2023-03-31 07:05:47 +00:00
Otto ebdccd0c67 Update 'content/getting-started/faq.md' 2023-03-26 13:48:23 +00:00
RobWalt 9c4533497b update codeberg-cli section with new binary name (#299)
We noticed that there is an application with the name `cod` already in available as a package in many distros and decided to rename the binary to `berg`. This PR just updates the section about `codeberg-cli` to use the new binary name.

Co-authored-by: RobWalt <robwalter96@gmail.com>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/299
Co-authored-by: RobWalt <robwalt@noreply.codeberg.org>
Co-committed-by: RobWalt <robwalt@noreply.codeberg.org>
2023-03-20 08:33:15 +00:00
n0toose 447946f70b Clarify that Codeberg API can create new releases (#297)
This PR was created in a hurry -- it was created after a person in the Codeberg Matrix room asked for an explicit clarification.

Co-authored-by: Panagiotis "Ivory" Vasilopoulos <git@n0toose.net>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/297
Co-authored-by: n0toose <git@n0toose.net>
Co-committed-by: n0toose <git@n0toose.net>
2023-03-18 14:42:36 +00:00
Otto 38f5587a17 s/Gitea/Forgejo 2023-03-05 14:27:37 +00:00
Loïc Dachary bb020e98e8 explain why the tag may look strange at times 2023-03-04 09:26:43 +00:00
Loïc Dachary 109622e1ea s/1.12/1.18/ 2023-03-04 09:26:43 +00:00
Loïc Dachary 67236e8b2d s/gitea/forgejo/ 2023-03-04 09:26:43 +00:00
Isaac Beverly 08986833f7 Provide additional clarification for custom domains with Codeberg Pages (#293)
This provides more detail when using ALIAS+TXT DNS records.

More context:  https://matrix.to/#/!wkyjxWeAOBpKMvHbno:matrix.org/$Z0mdXrDKTNptIBpENaeZKd9WuuMWhCrawgIWsNjJjXo?via=freeyourgadget.org&via=matrix.org&via=tchncs.de

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/293
Co-authored-by: Isaac Beverly <imbev@noreply.codeberg.org>
Co-committed-by: Isaac Beverly <imbev@noreply.codeberg.org>
2023-03-03 22:17:35 +00:00
RobWalt 4c425e13a4 Mentioning codeberg-cli tool (#285)
Co-authored-by: RobWalt <robwalter96@gmail.com>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/285
Co-authored-by: RobWalt <robwalt@noreply.codeberg.org>
Co-committed-by: RobWalt <robwalt@noreply.codeberg.org>
2023-02-24 20:14:28 +00:00
Lucas Hinderberger 08d985108d Replacing project list with link to Codeberg/Projects repo (#292)
This replaces the project table in the "Improving Codeberg" section with a link to the new Codeberg/Projects repository.

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/292
Co-authored-by: Lucas Hinderberger <mail@lucas-hinderberger.de>
Co-committed-by: Lucas Hinderberger <mail@lucas-hinderberger.de>
2023-02-24 19:39:18 +00:00
JakobDev 448fd740df Add Documentation for integrating with Read the Docs (#289)
This adds a Documentation for connecting Codeberg to [Read the Docs](https://readthedocs.org/). English is not my native Language, so there may be a few things that could be written better.

Co-authored-by: René Wagner <rwa@clttr.info>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/289
Co-authored-by: JakobDev <jakobdev@gmx.de>
Co-committed-by: JakobDev <jakobdev@gmx.de>
2023-02-24 19:37:22 +00:00
Jan Klippel e52d13f76b
replace mentions of Gitea with Forgejo
Replace the mentions of Gitea in the Codeberg projects list
with Forgejo as Codeberg is now based on the Forgejo soft fork of Gitea.

Fixes: #286
2023-02-19 12:03:12 +01:00
René Wagner 669f227ca9 remove contributors, use commit log for reference instead
closes #275
2023-02-14 16:53:14 +00:00
René Wagner d182737311 add contributors reference to README
closes #275
2023-02-14 16:52:04 +00:00
Jeremy d42e22f64c Fixed English mistakes 2022-12-24 09:48:23 +00:00
CameronNemo 9b8b8889ca ci: point to VCS integration docs
Signed-off-by: CameronNemo <cameronnemo@noreply.codeberg.org>
2022-12-20 23:14:19 +00:00
fpare 51570538fd add the ssh url scheme 2022-11-29 17:18:29 +00:00
fpare 1e341a0845 clarify the title 2022-11-29 17:18:29 +00:00
fpare d34e73a2b6 add suggestion to use SSH to avoir entering password every time 2022-11-29 17:18:29 +00:00
fpare 7a9528cfff Revert "add suggestion to use SSH to avoir entering password every time"
This reverts commit a4e17f1ad15d74a1cadceca4debd2c1a08a8dd23.
2022-11-29 17:18:29 +00:00
narF 9b31a3da09 Mise à jour de 'content/security/ssh-key.md' 2022-11-29 17:18:29 +00:00
narF 3cac95303e add suggestion to use SSH to avoir entering password every time 2022-11-29 17:18:29 +00:00
narF ceec82002b add missing number in first-repository.md 2022-11-29 17:18:29 +00:00
narF 7fba31ab1d add instructions to switch from https to ssh in ssh-key.md 2022-11-29 17:18:29 +00:00
fnetx b0b19675f2
Alternatives to Codeberg 2022-11-02 13:34:11 +01:00
eo 45473fb409 Correct SSH key misunderstanding 2022-10-21 17:10:35 +02:00
Lukas N 225f1265c1 Updated Mastodon URL
Updated Mastodon URL, because the account has moved to https://social.anoxinon.de/
2022-10-21 12:04:17 +02:00
fnetx b4fd4812aa
Style guide is for docs only 2022-10-06 00:49:42 +02: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
CSDUMMI f2e24e5aff Update 'content/codeberg-pages/troubleshooting.md' 2022-09-25 12:26:15 +02:00
n 7a4a4e0e11 Edit and merge PR #264 2022-09-11 17:16:52 +09:00
redwerkz 9ab38dd3f9 bump packages to latest version 2022-09-08 15:27:07 +02:00
n 0df8736a85 Add info about fonts and icons used in the website 2022-08-23 16:21:29 +02:00
Pi-Cla 727dd73f77 Make "AGPL-3.0-or-later" hyperlink go to corresponding licence page instead of list of all licences 2022-08-20 02:34:35 +02:00
magicfelix 9787d990ea
Fix typo 2022-08-11 16:30:05 +02:00
Jeremy 71e01038c5 Revise 2022-08-06 15:44:16 +02:00
Jeremy d5ef600ae9 Fix gpg-key.md 2022-08-06 15:44:16 +02:00
Jeremy fecb990686 Fix ssh-fingerprint.md 2022-08-06 15:44:16 +02:00
Jeremy 196fea69f3 Fix ssh-key.md 2022-08-06 15:44:16 +02:00
Jeremy 7115b4976e Fix 2fa.md 2022-08-06 15:44:16 +02:00
jklippel f7e3e24d3a added line to explain that a git push is necessary (#257)
add line to explain that a git push is necessary

Fixes #242

Co-authored-by: Jan Klippel <c0d3b3rg@kl1pp3l.de>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/257
Co-authored-by: jklippel <jklippel@noreply.codeberg.org>
Co-committed-by: jklippel <jklippel@noreply.codeberg.org>
2022-08-06 15:39:35 +02:00
René W f586d658f0 Merge pull request 'Fix mistakes in the Codeberg Pages section of the documentation' (#256) from jtbx/codeberg-documentation:pagesfix into main
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/256
2022-08-06 15:06:19 +02:00
Jeremy 9148212898 Fix codeberg-pages/pushing-output.md 2022-08-06 15:06:19 +02:00
Jeremy 74e7f20346 Fix codeberg-pages/examples/docs-as-code.md 2022-08-06 15:06:19 +02:00
Jeremy df6195e156 Fix codeberg-pages/troubleshooting.md 2022-08-06 15:06:19 +02:00
Jeremy ffc5878fb4 Fix codeberg-pages/index.md 2022-08-06 15:06:19 +02:00
Loïc Dachary 7b5313609b improve the wording in the contribute page (#253)
* `build-deploy-gitea` is not legacy in the sense that it still is in
  use
* replace "it" with `build-deploy-gitea` for clarity.

Signed-off-by: Loïc Dachary <loic@dachary.org>

Co-authored-by: Loïc Dachary <loic@dachary.org>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/253
Co-authored-by: Loïc Dachary <dachary@noreply.codeberg.org>
Co-committed-by: Loïc Dachary <dachary@noreply.codeberg.org>
2022-08-05 22:20:27 +02:00
Loïc Dachary cff34e1a03 fix broken link to the default branch (#254)
Co-authored-by: Loïc Dachary <loic@dachary.org>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/254
Co-authored-by: Loïc Dachary <dachary@noreply.codeberg.org>
Co-committed-by: Loïc Dachary <dachary@noreply.codeberg.org>
2022-08-03 12:24:47 +02:00
René W 3b3aa2f5b3 Merge pull request 'Fix mistakes in documentation (sections up to Markdown)' (#249) from jtbx/Documentation:main into main
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/249
2022-07-26 21:46:39 +02:00
Jeremy f85f9e601a Fix markdown/* 2022-07-26 21:46:39 +02:00
Jeremy 6841251d1a Fix git/* 2022-07-26 21:46:39 +02:00
Jeremy 0483a1ff6d Fix contribution_invitation.njk 2022-07-26 21:46:39 +02:00
Jeremy 8b7b5ffcf8 Fix collaborating/resolve-conflicts.md 2022-07-26 21:46:39 +02:00
Jeremy 3fb270ad28 Fix collaborating/repo-permissions.md 2022-07-26 21:46:39 +02:00
Jeremy bc300e5caa Fix collaborating/create-organization.md 2022-07-26 21:46:39 +02:00
Jeremy fbd05b0037 Fix collaborating/invite-collaborators.md 2022-07-26 21:46:39 +02:00
Jeremy db5724f0b9 Fix collaborating/pull-requests-and-git-flow.md 2022-07-26 21:46:39 +02:00
Jeremy 274558d54f Fix collaborating/citable-code.md 2022-07-26 21:46:39 +02:00
Jeremy 1ffa52cdb3 Fix contact.md 2022-07-26 21:46:39 +02:00
Jeremy 8b4e0f9317 Fix home.md 2022-07-26 21:46:39 +02:00
Jeremy d1e4479d76 Fix collaborating/index.md 2022-07-26 21:46:39 +02:00
Jeremy 47cac91c20 Fix getting-started/faq.md 2022-07-26 21:46:39 +02:00
Jeremy 74cf963ee5 Fix getting-started/licensing.md 2022-07-26 21:46:39 +02:00
Jeremy fd4f7d0567 Fix getting-started/email-settings.md 2022-07-26 21:46:39 +02:00
Jeremy d6e691468e Fix getting-started/wiki.md 2022-07-26 21:46:39 +02:00
Jeremy 641b525087 Fix getting-started/issue-tracking-basics.md 2022-07-26 21:46:39 +02:00
Jeremy adb83d680d Fix getting-started/first-repository.md 2022-07-26 21:46:39 +02:00
Jeremy b13f0c6c81 Fix getting-started/install-git.md 2022-07-26 21:46:39 +02:00
Jeremy 830a8b8680 Fix getting-started/first-steps.md 2022-07-26 21:46:39 +02:00
Jeremy ba0725129c Fix getting-started/what-is-codeberg.md 2022-07-26 21:46:39 +02:00
vanous 9bb3136a20 Improving Codeberg: add section about reporting bugs 2022-07-23 13:58:05 +02:00
René W b276cfcca9 Update 'README.md' 2022-07-21 16:47:59 +02:00
6543 69eeb5ba54 Add CI section (#237)
close https://codeberg.org/Codeberg-CI/feedback/issues/44

Co-authored-by: 6543 <6543@obermui.de>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/237
Co-authored-by: 6543 <6543@noreply.codeberg.org>
Co-committed-by: 6543 <6543@noreply.codeberg.org>
2022-07-17 23:48:10 +02:00
Flavio Poletti c7bded99df Add examples for Custom Domains
With inclusion of changes after feedback from Gusted
2022-07-17 06:03:38 +02:00
n 1ace475965 Switch Font Awesome to use SVG icons and update to v6 (#243)
This PR switches the Font Awesome icons to use SVG instead of a font, and updates it to v6.

~~Depends on Codeberg-Infrastructure/codeberg-fonts#13 getting deployed.~~ Now deployed.

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/243
Co-authored-by: n <n@noreply.codeberg.org>
Co-committed-by: n <n@noreply.codeberg.org>
2022-07-09 12:52:21 +02:00
Mark E. Fuller 967b0cd7bd fix broken link to FAQ (#246)
Current link implementation (on https://docs.codeberg.org/improving-codeberg/#donate-to-codeberg) leads to https://docs.codeberg.org/improving-codeberg/content/improving-documentation/docs-contributor-faq.md, not the correct https://docs.codeberg.org/improving-documentation/docs-contributor-faq/

Co-authored-by: Mark E. Fuller <fuller@fedoraproject.org>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/246
Co-authored-by: Mark E. Fuller <fuller@noreply.codeberg.org>
Co-committed-by: Mark E. Fuller <fuller@noreply.codeberg.org>
2022-07-09 12:51:10 +02:00
Gary Wang fb110be468 Add description for branch name replacing rule
Related to https://codeberg.org/Codeberg/pages-server/pulls/102
2022-07-09 10:38:02 +08:00
Jan Klippel 6503ebfd33 changes after review 2022-06-16 21:20:38 +02:00
Jan Klippel a99d6f424e Format notes and caveats
Format notes and caveats according to style guide
2022-06-16 21:20:38 +02:00
Jan Klippel 2460e87199 Changes after review. 2022-06-16 21:20:38 +02:00
Jan Klippel 1726ed1620 LFS-documentation
Initial version of an article on LFS

Fixes: #133
2022-06-16 21:20:38 +02:00
puppe 9ed1af425c Fix minor factual error: Codeberg *is* a corporation
There is a minor factual error in “What is Codeberg?”. The third paragraph states that Codeberg is not a corporation. Well actually …, Codeberg as a “eingetragener Verein” (German for “registered association” or “incorporated association”) very much *is* a corporation. And so, that part of the sentence has either to be removed or at least has to be qualified in some way. This commit does the latter.
2022-06-15 10:25:52 +02:00
Jan Klippel 5a1fdc201e
Article on conflict resolution
Initial version of an article on conflict resolution

Fixes: #14
2022-05-28 16:30:19 +02:00
Jan Klippel 8b5ab8067e Actually show Markdown syntax
Actually display the Markdown syntax to use when writing a note or a warning
2022-05-22 11:30:03 +02:00
Jan Klippel 9aeb95c4e7 Add bullet point on names
Fixes: #232
2022-05-21 22:23:59 +02:00
Jan Klippel 2e087e8c0c
Fix: typo in docker run command 2022-05-21 12:34:47 +02:00
fnetX 3f80cb2d48 Update contact page 2022-05-18 18:49:52 +02:00
fnetX 3f6c3779ad pages compatibility for deployment 2022-05-18 18:42:20 +02:00
ka2in a829d17b10 Style Guide (#223)
Co-authored-by: Faycal Alami-Hassani <ka2in@protonmail.com>
Co-authored-by: ka2in <ka2in@protonmail.com>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/223
Co-authored-by: ka2in <ka2in@noreply.codeberg.org>
Co-committed-by: ka2in <ka2in@noreply.codeberg.org>
2022-05-17 19:03:19 +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
mutluyuz 9e3acf9f44 Tags need to be pushed to the remote target (#228)
Add a note that tags need to be pushed to the remote target.

Please let me know, if you have any suggestions to improve the wording and this paragraph.

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/228
Co-authored-by: mutluyuz <mutluyuz@noreply.codeberg.org>
Co-committed-by: mutluyuz <mutluyuz@noreply.codeberg.org>
2022-05-10 08:09:38 +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
n 3b3309a90e Minor fixes 2022-04-17 14:28:59 +09:00
ka2in aef207d02a Improve email settings article (#215)
Edit and review of the article about email settings

Co-authored-by: Faycal Alami-Hassani <ka2in@protonmail.com>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/215
Co-authored-by: ka2in <ka2in@noreply.codeberg.org>
Co-committed-by: ka2in <ka2in@noreply.codeberg.org>
2022-04-17 06:03:43 +02:00
fnetx f7af41421b
Update deployment script for new location 2022-04-15 16:53:08 +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
Jan Klippel 29cae330d0 Add Dockerfile to serve documentation
Use a container to preview the documentation for those of us who cannot or do not want to install npm/nodejs on their machines.

- Add a Dockefile to create a docker image containing nodejs and the software needed to serve the documentation
- Extend README.md with the option to use the Dockerfile to preview the documentation
2022-04-14 12:34:21 +02:00
Jan Klippel ca68a77a76
add documentation of .gitignore
Add documentation of .gitignore to reduce clutter in Codeberg.

Fixes #117
2022-04-14 12:32:37 +02:00
n b46c8321dd Improve CI article 2022-04-10 21:02:40 +09:00
jklippel fa47455b9e document eMail notifications from codeberg (#213)
- Document how to change the eMail settings
- Document which situations automatically lead to being subscribed and
receiving mails

Improves on #153

Co-authored-by: Jan Klippel <c0d3b3rg@kl1pp3l.de>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/213
Co-authored-by: jklippel <jklippel@noreply.codeberg.org>
Co-committed-by: jklippel <jklippel@noreply.codeberg.org>
2022-04-09 13:01:28 +02:00
jklippel 7679e34b9e Start documentation on Continuous Integration / Woodpecker (#214)
- Initial section introducing CI
- Section on woodpecker on codeberg with a link to the request-access repository which already has good documentation on the current status of the Codeberg-CI

Related to #168

Co-authored-by: Jan Klippel <c0d3b3rg@kl1pp3l.de>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/214
Co-authored-by: jklippel <jklippel@noreply.codeberg.org>
Co-committed-by: jklippel <jklippel@noreply.codeberg.org>
2022-04-09 12:23:22 +02:00
jklippel 429c0ee52e Improvements on the FAQ (#211)
as proposed by infinitelight in https://codeberg.org/Codeberg/Documentation/issues/185

I put the proposed changes into a PR to continue handling #185

Co-authored-by: Jan Klippel <c0d3b3rg@kl1pp3l.de>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/211
Co-authored-by: jklippel <jklippel@noreply.codeberg.org>
Co-committed-by: jklippel <jklippel@noreply.codeberg.org>
2022-04-09 00:00:33 +02:00
Jan Klippel 84927fd532 add link to bylaws
Link to the bylaws from the documentation.

Improves on #191
2022-04-08 23:52:47 +02:00
René Schaar eec4dd6085 Resolve conversations from #181 (#208)
Only did some minor changes (most of them are formatting) and resolving all conversations from #181

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/208
Co-authored-by: René Schaar <rene@schaar.priv.at>
Co-committed-by: René Schaar <rene@schaar.priv.at>
2022-03-13 20:05:39 +01:00
Arnout Engelen db9f81fb39 Update FAQ to quote new Terms of Service (#207)
Co-authored-by: Arnout Engelen <arnout@bzzt.net>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/207
Co-authored-by: Arnout Engelen <raboof@noreply.codeberg.org>
Co-committed-by: Arnout Engelen <raboof@noreply.codeberg.org>
2022-03-13 11:46:08 +01:00
tok 5e8f81b174 #174: more extensive article on licensing. (#181)
Text is according to the discussion on the issue #174.

Co-authored-by: Thomas Kramer <code@tkramer.ch>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/181
Co-authored-by: tok <tok@noreply.codeberg.org>
Co-committed-by: tok <tok@noreply.codeberg.org>
2022-03-07 16:22:01 +01:00
n 70f94b2ee0 Gender-neutral language 2022-03-07 02:53:13 +09:00
n cd12cbf78c Fix broken link 2022-03-06 00:33:49 +09:00
Gusted 6b53d9cf23 Revisit GPG & SSH documentation (#206)
- Update the wording of gpg-key.md(ssh-key.md's wording is already nicely done). To be more fluent and have a better explanation.
- Add a section to verify the GPG & SSH key.
- Add step for git to sign new commits by-default.
- Resolves #177

Co-authored-by: Gusted <williamzijl7@hotmail.com>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/206
Co-authored-by: Gusted <gusted@noreply.codeberg.org>
Co-committed-by: Gusted <gusted@noreply.codeberg.org>
2022-03-04 22:17:26 +01:00
Gusted de72273544
Apply code suggestions 2022-03-04 00:20:58 +01:00
Gusted a53a187ee3
Rework the permissions article
- Rework the permission article, by splitting it into 2 new category's.
The current information would be within the Collaborators section, as
that hasn't changed. The new section is mostly concerned for the new
permissions system that is used for teams. It covers all the permissions
and values that can be selected.
- Resolves #204
2022-03-04 00:04:59 +01:00
René Schaar fd44b5335f Add project overview table to the contributing code site (#203)
Fixes: #201
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/203
Co-authored-by: René Schaar <rene@schaar.priv.at>
Co-committed-by: René Schaar <rene@schaar.priv.at>
2022-02-26 10:46:22 +01:00
ka2in 93975e5d93 Docs-as-Code with Sphinx and Codeberg Pages (#198)
How to implement [Docs-as-Code](https://docs-as-co.de/) with the help of Sphinx and Codeberg Pages.

Co-authored-by: Faycal Alami-Hassani <ka2in@protonmail.com>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/198
Co-authored-by: ka2in <ka2in@noreply.codeberg.org>
Co-committed-by: ka2in <ka2in@noreply.codeberg.org>
2022-02-14 22:15:05 +01:00
Otto Richter 0e30fb4fe8 Fix internal link 2022-02-13 21:02:00 +01:00
Lucas Hinderberger dd2d720c41 Upgrading to Eleventy v1.0.0, Updating Dependencies 2022-01-30 21:30:50 +01:00
fnetx 619aa91f52
Alignment in footer 2022-01-27 15:30:23 +01:00
lukaskluge 155db25dd0 reduce line width of content (#184)
Reduces line width in main text area to increase readability

fixes #183

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/184
Co-authored-by: lukaskluge <lukaskluge@noreply.codeberg.org>
Co-committed-by: lukaskluge <lukaskluge@noreply.codeberg.org>
2022-01-27 14:55:58 +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
René W f1552640e8 add info about failed migrations (#187)
This is a question that is raised repeatedly in the community tracker or matrix.

Co-authored-by: René W <rwa@clttr.info>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/187
Co-authored-by: René W. <rwa@clttr.info>
Co-committed-by: René W. <rwa@clttr.info>
2021-12-28 21:19:25 +01:00
n 17cc1bfc96 Close open quote 2021-12-24 23:18:35 +09:00
n ec5228bbf5 Some HTML template fixes 2021-12-23 18:18:20 +09:00
fnetx 707619f2a6
Apply suggestions as per momar 2021-12-02 17:02:54 +01:00
fnetx 9a355bb8c9
Modify Codeberg Pages article for Pages v2 2021-12-01 23:18:11 +01:00
René W b585d2f989 Merge pull request 'add faq about automatic mirrors' (#180) from faq-mirror into main
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/180
2021-11-26 18:54:27 +01:00
René Wagner c06926aa0a
rephrase first sentence 2021-11-25 18:35:38 +01:00
René Wagner 94c068a557
uppercase I in heading 2021-11-23 21:02:05 +01:00
René Wagner 3260bc265d
add faq about automatic mirrors 2021-11-22 17:15:14 +01:00
n 982842a9a9 Update packages and dependencies 2021-11-21 20:57:27 +09:00
n f77fc97525 Add margin-top to lists 2021-11-21 20:49:52 +09:00
n f4a400d555 Minor tweaks and updates to the Matrix integration article 2021-11-21 20:34:27 +09:00
n 3e9d9b87a8 Reorder articles in the security section 2021-11-21 20:13:59 +09:00
reynir 70db4885ed Add "(ssh fingerprints)" to title (#179)
Makes it easier to find the ssh fingerprints from the title alone.

Co-authored-by: Reynir Björnsson <reynir@reynir.dk>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/179
Co-authored-by: reynir <reynir@noreply.codeberg.org>
Co-committed-by: reynir <reynir@noreply.codeberg.org>
2021-11-20 14:01:24 +01:00
fnetx 5dfe62bb8b
deployment script defaults to prod 2021-11-17 00:01:14 +01:00
Johannes Stefan cdb301cc29 * Extending “Can I host private (non-licensed) repositories?”-question
* Adding link to netcup GmbH
* Adding link to liberapay donation page
2021-11-04 22:42:55 +01:00
René W 74e4a182b3 Merge pull request 'Adds a separate page on licensing on Codeberg' (#173) from michielappelman/Documentation:licensing into main
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/173
2021-10-19 19:41:23 +02:00
Michiel Appelman 724fb04ad7 Move license handling back to FAQ 2021-10-19 09:43:57 +02:00
Michiel Appelman 7359aa4c2b Sort CC licenses in the same order as code licenses 2021-10-15 10:53:07 +02:00
Michiel Appelman 02d12744c6 Add specific implications of unrestricted licenses 2021-10-15 09:41:48 +02:00
Michiel Appelman 81fda8059c Changes Unlicense to 0BSD and removes some PD wording 2021-10-14 15:42:48 +02:00
mike 608da3f36d Merge branch 'main' into licensing 2021-10-14 12:01:26 +02:00
Michiel Appelman e9544af6df Adds a separate page on licensing on Codeberg
Looking of course for feedback on this, as I am not an expert on this at
all. This does capture some of the questions I had when starting to look
into licensing.
2021-10-14 11:58:42 +02:00
n 33c06996fe Merge pull request 'added Matrix space' (#172) from Patryk/Documentation:main into main
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/172
2021-10-14 11:43:48 +02:00
Patryk db0fea45a2 added Matrix space 2021-10-14 11:18:25 +02:00
mike da549f6a23 Fixes a single internal link to the Tag article (#169)
Co-authored-by: Michiel Appelman <michiel@appelman.se>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/169
Co-authored-by: mike <michielappelman@noreply.codeberg.org>
Co-committed-by: mike <michielappelman@noreply.codeberg.org>
2021-09-24 15:57:18 +02:00
n 5692bc9bce Fix redirect and change parent for FAQ 2021-08-29 16:34:08 +09:00
Otto Richter 779f959db8 Update FAQ (#166)
Co-authored-by: fnetX <git@fralix.ovh>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/166
Co-authored-by: Otto Richter <fnetx@noreply.codeberg.org>
Co-committed-by: Otto Richter <fnetx@noreply.codeberg.org>
2021-08-29 09:27:33 +02:00
n 04ccf15750 Remove branch from Git repo URLs
This makes the URLs redirect to the default branch of the repo
2021-08-26 22:53:10 +09:00
MohammadSaleh Kamyab ff261b380c fix the commit history and docs source adress 2021-08-24 08:59:51 +02:00
fnetX 11310c0476 Add mission to WhatIsCodeberg page
copied "Mission" section from https://blog.codeberg.org/codebergorg-launched.html
2021-08-24 02:56:31 +02:00
fnetX 53549c7b55 Add dedicated abuse section 2021-08-24 02:56:31 +02:00
n 288d5834af Another minor wording change 2021-08-20 17:27:58 +09:00
n b1a71be11a Minor wording change. 2021-08-20 17:10:24 +09:00
Gerhard Beck aaf58c97c4 Move Instructions on Creating a Release (#163)
Moving "releases in Codeberg" as discussed in https://codeberg.org/Codeberg/Documentation/issues/151

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/163
Co-authored-by: Gerhard Beck <gerhard.beck@elkb.de>
Co-committed-by: Gerhard Beck <gerhard.beck@elkb.de>
2021-08-20 10:09:04 +02:00
n 9a211dc2d2 Add metadata for CC license 2021-08-20 00:40:47 +09:00
n 6839d4119c Improve SSH key article (#161)
This PR improves the SSH key article, removes the part where email is used as a label (newcomers might think this is mandatory and leak their email) and changes the public key type to a more secure ed25519.

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/161
Co-authored-by: n <n@noreply.codeberg.org>
Co-committed-by: n <n@noreply.codeberg.org>
2021-08-16 01:12:47 +02:00
René W edae9a08e8 wiki-sidebar (#160)
refers to Codeberg/Community#508

Co-authored-by: René Wagner <rwa@clttr.info>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/160
Co-authored-by: René W. <rwa@noreply.codeberg.org>
Co-committed-by: René W. <rwa@noreply.codeberg.org>
2021-08-14 13:32:31 +02:00
n 8b2fced63f Update package versions 2021-08-12 18:41:56 +09:00
n 4fcfcfdc8d Fix wide margins in code blocks 2021-08-12 18:30:07 +09: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
Otto Richter b4537c4ae4 Tweaks to welcome users and help getting started (#158)
In Codeberg/Design #39 the idea was thrown around to put some links
under a new dropdown and prominently link to the docs instead.
This rewrites the docs index page and adds some more information on how
to get started, as well as adds some other tweaks to **communication
methods** and gives a new explanation of **what Codeberg is**.

Co-authored-by: fnetX <git@fralix.ovh>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/158
Co-authored-by: Otto Richter <fnetx@noreply.codeberg.org>
Co-committed-by: Otto Richter <fnetx@noreply.codeberg.org>
2021-07-31 12:04:05 +02:00
n e350d2b447 Bump dependency versions 2021-07-27 16:17:05 +09:00
n 03a5886fad Point navbar docs link to / 2021-07-27 16:14:09 +09:00
n 65ddf24687 Fix 'naming conventions' title 2021-07-27 02:24:16 +09:00
n d503814095 Add halfmoon class to all content titles 2021-07-27 02:08:30 +09:00
n 190be05ba4 Update style for ul for consistency 2021-07-27 01:49:04 +09:00
n f47d29ebc2 Update home.md sidebar message 2021-07-27 01:47:00 +09:00
n 2f9c5bbbf1 Remove dark mode toggle because it doesn't persist 2021-07-26 21:25:47 +09:00
n 681a5f6d2a Only load sidebar scroll script when necessary 2021-07-26 21:25:47 +09:00
n ae684fbad4 Migrate to Codeberg Design Kit (#132) (#149)
TODO:
- [x] Hide navbar items on small screens
- [x] Fix `<blockquote>` rendering
- [x] Fix `<code>` rendering
- [ ] LibreJS Compatibility

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/149
Co-authored-by: n <n@noreply.codeberg.org>
Co-committed-by: n <n@noreply.codeberg.org>
2021-07-26 12:07:23 +02:00
n 1c7e459bd0 Make 'GPG key' article key unique 2021-07-22 22:32:00 +09:00
n 217668e3b1 Merge pull request 'Added docs on e-mail preferences and changed structure of "Configuring Git"' (#156) from iyqdg/Documentation:master into master
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/156
2021-07-20 12:48:15 +02:00
Ajay Raghavan 9501efb4d1 Changed structure of 'Configuring Git' 2021-07-20 15:57:35 +05:30
Ajay Raghavan 341cb8d745 Added docs on e-mail preferences 2021-07-20 15:56:41 +05:30
n 2686c4725e Merge pull request 'Fixing section order collisions' (#154) from lhinderberger/codeberg-documentation:section-order into master
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/154
2021-07-11 16:04:00 +02:00
Lucas Hinderberger 1557f2b3d8 Fixing section order collisions 2021-07-11 15:01:01 +02:00
René W 740cb20b58 Merge pull request 'expand description of built-in wiki' (#147) from wiki into master
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/147
2021-07-03 21:46:04 +02:00
René Wagner 4f8a7f7b84
fix typo build-in -> built-in 2021-06-27 16:39:25 +02:00
n 0ab2b71ad7 Remove .git from folder name 2021-06-24 13:01:37 +02:00
René Wagner ed179df4ef
use "repository" instead of "project"
split shell example for cloning and adding an image
2021-06-23 20:39:32 +02:00
René Wagner 1029d9c370
set correct 'key' for page 2021-06-22 19:14:44 +02:00
René Wagner e8e3e0a0b7
adjust paragraphs to reflect feedback 2021-06-20 11:01:44 +02:00
René Wagner 07c7a69f69
add redirect from 'add-images-to-wiki' 2021-06-20 10:49:12 +02:00
n 92f28dd628 Merge branch 'master' into wiki 2021-06-20 10:30:01 +02:00
René Wagner 75c9cd1d13
make the warning about secrest more visible 2021-06-20 09:27:05 +02:00
René Wagner 837a168192
move wiki to "getting started" section
reformat some paragraphs
2021-06-20 09:19:42 +02:00
René Wagner 8bfc18cf17
fix typo 2021-06-20 08:56:08 +02:00
René Wagner 68563215a4
complete usage of web & git cli for wiki updates
add screenshot of page management functions in web view
2021-06-16 19:49:58 +02:00
Otto Richter ed1ebc8b0d Merge pull request 'Unify SSH and HTTP clone & commit articles (#129)' (#143) from issue-129 into master
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/143
2021-06-16 19:25:16 +02:00
René W a717ed6fe7 Merge branch 'master' into issue-129 2021-06-16 19:11:10 +02:00
n 40611df5ec bash --> shell 2021-06-16 21:16:59 +09:00
n 79463b300e Add redirect mechanism 2021-06-16 21:04:45 +09:00
René W 1ed1368487 Merge pull request 'Fix typos' (#146) from qwerty287/Documentation:gpg-typo into master
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/146
2021-06-15 20:33:20 +02:00
qwerty287 0c4d6e0e09 Fix typos 2021-06-15 17:16:38 +02:00
René Wagner 6b69ffc846
extend documentation of internal wiki 2021-06-15 13:55:20 +02:00
n bf46e692f8 Fix typo 2021-06-15 19:43:23 +09:00
n 5ea6b723e8 Unify SSH and HTTP clone & commit articles (#129) 2021-06-15 19:21:47 +09:00
n 6460768b39 Bump ws to 7.4.6 and remove node-fetch 2021-06-14 19:28:50 +09:00
n dd7f953e1d Fix typo 2021-06-14 19:26:51 +09:00
n d33e360dbc Expand repo migration guide (#142)
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/142
Co-authored-by: n <n@noreply.codeberg.org>
Co-committed-by: n <n@noreply.codeberg.org>
2021-06-14 12:22:36 +02:00
fnetx 054c6bfd33
Shorten migrating-repos article name 2021-06-12 12:54:17 +02:00
n0542344 1f71f669f4 how to migrate repositories from one gitea-instance to another (#139)
This pull/merge request contains some documentation on how to migrate a repo you own to another `gitea`-instance.

Co-authored-by: x0ff <x0ff@0x0f00ff>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/139
Co-authored-by: n0542344 <n0542344@noreply.codeberg.org>
Co-committed-by: n0542344 <n0542344@noreply.codeberg.org>
2021-06-12 12:30:04 +02:00
n 4a01d7ca23 Update logo license 2021-06-10 10:22:31 +02:00
William Davis acd7bd1ace
Document GPG key usage (#127)
Cpaitalize Git, Linux, and change protocol to standard
    Moved attribution to file, resovled comments
    Added recommended bits and time
    Syntax error
    Did some TODOs
    Finished last section
    Finished Adding your GPG key to Codeberg
    Please fix the error
    Fix link
    Added info about some parts being derived from github's docs
    Finished Generating a GPG key
    Finished the Generating a GPG key section
    updated gpg-key.md
    Created the gpg key page

Co-authored-by: William Davis <unbeatable-101@noreply.codeberg.org>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/127
2021-06-07 22:06:55 +02:00
n bc8f4b16a3 Merge pull request 'Change OSX to macOS in ssh-key.md' (#138) from unbeatable-101/Documentation:macos into master
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/138
2021-06-07 09:16:49 +02:00
William Davis 686bfc5978
OSX --> macOS 2021-06-06 17:51:02 -04:00
fnetx fa7a04afa7
Make all Git and Codeberg mentions uppercase 2021-05-29 15:09:43 +02:00
Otto Richter 7df2b4c8eb Merge pull request 'short explanation why to use SSH' (#130) from rwa/Documentation:explain_ssh into master
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/130
2021-05-29 14:59:55 +02:00
René W 0a26d11e4d Merge branch 'master' into explain_ssh 2021-05-29 14:47:08 +02:00
n 2aab93f738 Merge pull request 'Update process for approving PRs' (#131) from issue-80 into master
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/131
2021-05-29 13:47:55 +02:00
René Wagner ef00090cd4
more cosmetic changes to ssh-key.md 2021-05-29 12:36:34 +02:00
René Wagner 09659373e7
ssh usage: cosmetic changes 2021-05-29 10:14:36 +02:00
n 6c4088fe69 Update process for approving PRs (#80) 2021-05-29 15:42:46 +09:00
René Wagner d545fd3dbc
adjust wording on hint to ssh key setup 2021-05-28 20:14:37 +02:00
René Wagner e26265cf78
short explanation why to use SSH 2021-05-28 19:53:31 +02:00
n b82d39de3e JohnDoe --> Knut 2021-05-28 08:56:16 +09:00
fnetx 9c2bc355db
Correct links to web & ssh clone articles 2021-05-27 23:31:19 +02:00
René Wagner 54a921b0cd
add description for private key passphrase 2021-05-27 21:40:03 +02:00
René Wagner b155792237
cleanup git via ssh 2021-05-27 21:38:11 +02:00
n 027d5faa17 Make SSH clone/commit article a draft 2021-05-22 23:10:14 +09:00
191 changed files with 9020 additions and 8707 deletions

142
.cspell.json Normal file
View file

@ -0,0 +1,142 @@
{
"version": "0.2",
"language": "en",
"dictionaries": [
// language
"en_us",
// code
"go",
"node",
// package names
"npm"
],
"words": [
"codeberg",
"editview",
"forgejo",
"gitea",
"keycloak",
"knut",
"nord",
"orga",
"pageview",
"styleguide",
"tydata",
"webauthn",
"weblate",
"webp",
"xclip",
"endfor",
"pagefind",
"mray",
"keypair",
"gpgsign",
"signinkey",
"srcset",
"endadmonition",
"TOTP",
"Setext",
"Marlroy",
"preformatting",
"endfor",
"Goldmark",
"Homeserver",
"subpage",
"PKCE",
"block",
"keyid",
"pubring",
"signingkey",
"Browsersync",
"endraw",
"callouts",
"libwebp",
"cwebp",
"Kesi",
"IBAN",
"SEPA",
"fileorpathname",
"oneline",
"eins",
"zwei",
"Commitvia",
"knuts",
"Hostable",
"disroot",
"hostable",
"LICENCE",
"browsable",
"homebrewed",
"libera",
"jumpstart",
"Figshare",
"Zenodo",
"gettext",
"colormix",
"frida",
"reponame",
"yourdomain",
"myproject",
"branchname",
"venv",
"mydocs",
"Hassani",
"Alami",
"Fayçal",
"toctree",
"Malroy",
"Wrzx",
"pacman",
"xbps",
"GENODEF",
"netcup",
"YOURCODEBERGUSERNAME",
"respository",
"mynewfile",
"docstrings",
"autodoc",
"quickstart",
"virtualenv",
"dind",
"Packagist",
"Feishu",
"Gogs",
"noreferrer",
"tabindex",
"CERTDIR",
"nbsp",
"lycheeverse",
"mstruebing",
"davidanson",
"pipelinecomponents",
"corepack"
],
"ignorePaths": [
"**/node_modules/**/*",
"*.webp",
"*.png",
".git/**/*",
".gitignore",
"pnpm-lock.yaml",
"package.json",
"*.svg",
"*.css",
"*.js",
"*.njk",
".cspell.json"
],
// Exclude imports, because they are also strings.
"ignoreRegExpList": [
// ignore mulltiline imports
"import\\s*\\((.|[\r\n])*?\\)",
// ignore single line imports
"import\\s*.*\".*?\"",
// ignore go generate directive
"//\\s*go:generate.*",
// ignore nolint directive
"//\\s*nolint:.*",
// ignore docker image names
"\\s*docker\\.io/.*"
],
"enableFiletypes": ["dockercompose"]
}

3
.ecrc Normal file
View file

@ -0,0 +1,3 @@
{
"Exclude": ["LICENSE", ".git*"]
}

17
.editorconfig Normal file
View file

@ -0,0 +1,17 @@
root = true
[*]
indent_style = space
indent_size = 2
tab_width = 2
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true
[*.md]
trim_trailing_whitespace = false
indent_size = 1
[Makefile]
indent_style = tab

View file

@ -1,18 +1,85 @@
const navigationPlugin = require("@11ty/eleventy-navigation")
const syntaxHighlightingPlugin = require("@11ty/eleventy-plugin-syntaxhighlight")
const navigationPlugin = require('@11ty/eleventy-navigation');
const syntaxHighlightingPlugin = require('@11ty/eleventy-plugin-syntaxhighlight');
const markdownIt = require('markdown-it');
const tableOfContentsPlugin = require('@uncenter/eleventy-plugin-toc');
const markdownItClass = require('@toycode/markdown-it-class');
const markdownItAnchor = require('markdown-it-anchor');
const library = require('@fortawesome/fontawesome-svg-core').library;
const icon = require('@fortawesome/fontawesome-svg-core').icon;
const fas = require('@fortawesome/free-solid-svg-icons').fas;
const { execSync } = require('child_process');
module.exports = function(eleventyConfig) {
eleventyConfig.addPlugin(navigationPlugin)
eleventyConfig.addPlugin(syntaxHighlightingPlugin)
module.exports = function (eleventyConfig) {
eleventyConfig.addPlugin(navigationPlugin);
eleventyConfig.addPlugin(syntaxHighlightingPlugin);
eleventyConfig.addPassthroughCopy("assets")
eleventyConfig.addPassthroughCopy("fonts")
eleventyConfig.addPassthroughCopy('assets');
eleventyConfig.addPassthroughCopy('fonts');
eleventyConfig.addShortcode("fas_icon", function(name) { return `<span class="fas fa-${name}"></span>` })
// Font Awesome Icons
library.add(fas);
eleventyConfig.addShortcode('fas_icon', function (args) {
var fas_svg = icon({ prefix: 'fas', iconName: args });
return `${fas_svg.html}`;
});
const mapping = {
h2: 'content-title',
h3: 'content-title',
h4: 'content-title',
h5: 'content-title',
h6: 'content-title',
table: 'table',
blockquote: 'alert',
};
const mdOptions = { linkify: false, html: true };
const mdAnchorOpts = {
permalink: markdownItAnchor.permalink.headerLink(),
permalinkClass: 'ml-5',
permalinkSymbol: '#',
level: [1, 2, 3, 4],
};
eleventyConfig.setLibrary(
'md',
markdownIt(mdOptions).use(markdownItClass, mapping).use(markdownItAnchor, mdAnchorOpts),
);
eleventyConfig.addPairedShortcode('admonition', function (content, type, title) {
let titleStr = '';
if (title) {
titleStr = title;
} else if (type) {
titleStr = type.substring(0, 1).toUpperCase() + type.substring(1).toLowerCase();
} else {
titleStr = 'Info';
}
return `<div class="admonition${type ? ` ${type.toLowerCase()}` : ''}">
<div class="admonition-title">
<span class="admonition-icon${type ? ` ${type.toLowerCase()}` : ''}"></span>
${titleStr}
</div>
<div class="admonition-content">${content}</div>
</div>`;
});
eleventyConfig.addPlugin(tableOfContentsPlugin, {
tags: ['h2', 'h3'],
wrapper: function (toc) {
toc = toc.replaceAll('<a', "<a class='sidebar-link'");
return `${toc}`;
},
});
eleventyConfig.on('eleventy.after', () => {
execSync(`npx pagefind`, { encoding: 'utf-8' });
});
return {
dir: {
input: "content"
}
}
}
input: 'content',
},
};
};

1
.gitignore vendored
View file

@ -1,3 +1,4 @@
node_modules/
_site/
pages.git/
.idea/

8
.lycheeignore Normal file
View file

@ -0,0 +1,8 @@
http://127.0.0.1:**
https://pages.codeberg.org/user.name/
https://user.name.codeberg.page/
https://repo.sitory.username.codeberg.page/
file://** */
https://codeberg.org/username/repo.git
https://username.codeberg.page/**
https://openclipart.org/**

141
.markdownlint.yaml Normal file
View file

@ -0,0 +1,141 @@
# markdownlint YAML configuration
# https://github.com/DavidAnson/markdownlint/blob/main/schema/.markdownlint.yaml
# Default state for all rules
default: true
# Path to configuration file to extend
extends: null
# MD003/heading-style/header-style - Heading style
MD003:
# Heading style
style: 'atx'
# MD004/ul-style - Unordered list style
MD004:
style: 'dash'
# MD007/ul-indent - Unordered list indentation
MD007:
# Spaces for indent
indent: 2
# Whether to indent the first level of the list
start_indented: false
# MD009/no-trailing-spaces - Trailing spaces
MD009:
# Spaces for line break
br_spaces: 2
# Allow spaces for empty lines in list items
list_item_empty_lines: false
# Include unnecessary breaks
strict: false
# MD010/no-hard-tabs - Hard tabs
MD010:
# Include code blocks
code_blocks: true
# MD012/no-multiple-blanks - Multiple consecutive blank lines
MD012:
# Consecutive blank lines
maximum: 1
# MD013/line-length - Line length
MD013:
# Number of characters
line_length: 500
# Number of characters for headings
heading_line_length: 100
# Number of characters for code blocks
code_block_line_length: 80
# Include code blocks
code_blocks: false
# Include tables
tables: false
# Include headings
headings: true
# Include headings
headers: true
# Strict length checking
strict: false
# Stern length checking
stern: false
# MD022/blanks-around-headings/blanks-around-headers - Headings should be surrounded by blank lines
MD022:
# Blank lines above heading
lines_above: 1
# Blank lines below heading
lines_below: 1
# MD024/no-duplicate-heading/no-duplicate-header - Multiple headings with the same content
MD024:
# Only check sibling headings
allow_different_nesting: true
# MD025/single-title/single-h1 - Multiple top-level headings in the same document
MD025:
# Heading level
level: 1
# RegExp for matching title in front matter
front_matter_title: "^\\s*title\\s*[:=]"
# MD026/no-trailing-punctuation - Trailing punctuation in heading
MD026:
# Punctuation characters
punctuation: '.,;:!。,;:!'
# MD029/ol-prefix - Ordered list item prefix
MD029:
# List style
style: 'one_or_ordered'
# MD030/list-marker-space - Spaces after list markers
MD030:
# Spaces for single-line unordered list items
ul_single: 1
# Spaces for single-line ordered list items
ol_single: 1
# Spaces for multi-line unordered list items
ul_multi: 1
# Spaces for multi-line ordered list items
ol_multi: 1
# MD033/no-inline-html - Inline HTML
MD033: false
# MD035/hr-style - Horizontal rule style
MD035:
# Horizontal rule style
style: '---'
# MD036/no-emphasis-as-heading/no-emphasis-as-header - Emphasis used instead of a heading
MD036:
# Punctuation characters
punctuation: '.,;:!?。,;:!?'
# MD041/first-line-heading/first-line-h1 - First line in a file should be a top-level heading
MD041:
# Heading level
level: 1
# RegExp for matching title in front matter
front_matter_title: "^\\s*title\\s*[:=]"
# MD044/proper-names - Proper names should have the correct capitalization
MD044:
# List of proper names
# names:
# Include code blocks
code_blocks: false
# MD046/code-block-style - Code block style
MD046:
# Block style
style: 'fenced'
# MD048/code-fence-style - Code fence style
MD048:
# Code fence style
style: 'backtick'

1
.prettierignore Normal file
View file

@ -0,0 +1 @@
pnpm-lock.yaml

8
.prettierrc.json Normal file
View file

@ -0,0 +1,8 @@
{
"semi": true,
"trailingComma": "all",
"singleQuote": true,
"printWidth": 120,
"tabWidth": 2,
"endOfLine": "lf"
}

14
.woodpecker/build.yaml Normal file
View file

@ -0,0 +1,14 @@
when:
- event: [pull_request]
- event: push
branch:
- ${CI_REPO_DEFAULT_BRANCH}
steps:
build:
image: codeberg.org/woodpecker-plugins/node-pm:1.3.0
settings:
run: build
with: pnpm
frozen_lockfile: true
ignore_node_modules: true

View file

@ -0,0 +1,29 @@
when:
- event: [pull_request, pull_request_closed]
steps:
build:
image: codeberg.org/woodpecker-plugins/node-pm
settings:
run: build
with: pnpm
frozen_lockfile: true
ignore_node_modules: true
deploy-preview:
image: docker.io/woodpeckerci/plugin-surge-preview:1.3.1
settings:
path: '_site/'
forge_type: gitea
forge_url: https://codeberg.org
surge_token:
from_secret: surge_token
forge_repo_token:
from_secret: surge_forge_token
failure: ignore
when:
event: [pull_request, pull_request_closed]
path:
- content/**
- assets/**
- .eleventy.js

44
.woodpecker/lint.yaml Normal file
View file

@ -0,0 +1,44 @@
when:
- event: [pull_request]
- event: push
branch:
- ${CI_REPO_DEFAULT_BRANCH}
steps:
lint-markdown:
image: davidanson/markdownlint-cli2:v0.13.0
commands:
- 'markdownlint-cli2 *.{md,markdown}'
when:
path: '*.{md,markdown}'
editor-config:
image: mstruebing/editorconfig-checker:v3.0.1
depends_on: []
prettier:
image: docker.io/woodpeckerci/plugin-prettier:0.1.0
depends_on: []
settings:
version: 3.2.5
links:
image: lycheeverse/lychee:0.14.3
depends_on: []
commands:
- lychee -v -t 40 .
lint-yaml:
image: pipelinecomponents/yamllint:0.31.2
depends_on: []
commands:
- yamllint --strict .
when:
path: '*.{yml,yaml}'
spellcheck:
image: docker.io/node:22-alpine
depends_on: []
commands:
- corepack enable
- pnpx cspell lint --no-progress --gitignore '{**,.*}/{*,.*}'

21
.yamllint.yaml Normal file
View file

@ -0,0 +1,21 @@
ignore: |
pnpm-lock.yaml
node_modules/
rules:
comments:
require-starting-space: false
ignore-shebangs: true
min-spaces-from-content: 1
braces:
min-spaces-inside: 1
max-spaces-inside: 1
document-start:
present: false
indentation:
spaces: 2
indent-sequences: true
line-length:
max: 256
new-lines:
type: unix

View file

@ -1,13 +0,0 @@
# The Codeberg Documentation Contributors
In alphabetic order (by last name / username):
- Martijn de Boer (@sexybiggetje)
- Christian Buhtz (@buhtz)
- Ivan Calandra (@ivan-paleo)
- Ben Cotterell (@benc)
- Lucas Hinderberger (@lhinderberger)
- Henning Jacobs (@hjacobs)
- @mray (for the Codeberg Logo)
- @n
- Holger Waechtler (@hw)

16
Dockerfile Normal file
View file

@ -0,0 +1,16 @@
FROM node:12.22.12-stretch-slim
RUN apt-get update && apt-get -y upgrade
RUN apt-get install -y git curl
RUN curl -fsSL https://get.pnpm.io/install.sh | sh -
RUN mkdir /opt/documentation && chown node: /opt/documentation
USER node
WORKDIR /opt/documentation
RUN pnpm install
CMD [ "pnpm", "run", "serve"]

View file

@ -1,13 +1,19 @@
This website by [The Codeberg Documentation Contributors](CONTRIBUTORS.md)
is licensed under [CC-BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/deed.en).
<!-- markdownlint-disable MD041 -->
This website is licensed under [CC-BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/deed.en).
Due to the wiki-like nature of this website, pages usually have multiple authors and are changed
frequently. Changes to the original versions of the works as well as their individual authors can be
looked up in [the website's commit history](https://codeberg.org/Codeberg/Documentation/commits/branch/master).
looked up in [the website's commit history](https://codeberg.org/Codeberg/Documentation/commits/branch/main).
The Codeberg logos in this website are by mray,
licensed under [CC-BY 4.0](https://creativecommons.org/licenses/by/4.0/deed.en).
The Codeberg logos in this website are by @mray,
licensed under [CC0 1.0](http://creativecommons.org/publicdomain/zero/1.0/).
The fonts in this website are documented on the [Codeberg Design repo](https://codeberg.org/Codeberg/Design#font-inter).
The icons in this website are by [Font Awesome](https://github.com/FortAwesome/Font-Awesome),
licensed under [multiple licenses](https://fontawesome.com/license/free).
Codeberg and the Codeberg Logo are trademarks of Codeberg e.V.
"Knut the Polar Bear" has been derived from https://openclipart.org/detail/193243/polar-bear-remix, under CC0 1.0
"Knut the Polar Bear" has been derived from [https://openclipart.org/detail/193243/polar-bear-remix](https://openclipart.org/detail/193243/polar-bear-remix), under CC0 1.0

View file

@ -1,28 +1,30 @@
# Codeberg Documentation
This repository contains the documentation for Codeberg, with some code to build it into
This repository contains the [documentation for Codeberg](https://docs.codeberg.org/), with some code to build it into
a static website.
Please have a look into it and consider to help writing the Documentation. This is still very much work-in-progress, the more useful material we collect, the better we can later present it! All contributions are very welcome!
For an introduction on contributing to Codeberg Documentation, please have a look
at [the Contributor FAQ](https://docs.codeberg.org/improving-codeberg/docs-contributor-faq)
at [the section on improving the documentation](https://docs.codeberg.org/improving-documentation/).
## Usage
### Local Development
If you want to work on the documentation, for example by writing your own articles,
the easiest way to do so is to fork the documentation repository and develop locally.
First, run
```npm install```
`pnpm install`
to install all dependencies (they will be installed only for this project, not globally).
You only have to do this once.
Then run
```npm run serve```
`pnpm run serve`
to start a development web server that by default is listening at `http://localhost:8080`.
@ -32,30 +34,72 @@ should automatically reload all changed pages using the amazing Browsersync.
When you're done, commit your changes to your fork and write a pull request for
Codeberg/Documentation. We're happy about every contribution!
### Local development using the Dockerfile
If you do not have nodejs installed or do not want to run the development web server directly on your host,
you can also use a docker container.
You must have a container-engine installed (docker, podman, etc.)
First build the container image:
```shell
docker build -t Codeberg/Documentation-server .
```
You do not have to rebuild the image every time. Once you build the image you can always start the development
webserver using the container engine:
```shell
docker run --rm -v $PWD:/opt/documentation Codeberg/Documentation-server:latest
```
Use the "External" URL the container outputs on startup to access your documentation.
Changes to files in the documentation are reflected in the browser as the server regularly updates the generated files.
Use `Ctrl-C` to exit / end the container.
The parameters are:
`--rm` removes the container after it's use
`-v` mounts the current (documentation repository root) folder to `/opt/documentation` in the container.
`Codeberg/Documentation-server:latest` refers to the container image built in the first step (using `docker build`).
### Build & Deployment
Like for local development, before building and deploying you first have to install
the dependencies (once):
```npm install```
`pnpm install`
To build the entire website to the `_site` directory run
```npm run build```
`pnpm run build`
Instead, to directly publish the page to Codeberg pages, you can also run
```npm run deploy```
`pnpm run deploy`
which includes a call to `npm run build`.
which includes a call to `pnpm run build`.
### Technical Information
This website uses [Eleventy](https://www.11ty.dev/), a static site generator.
It's supplied as a dev-dependency in `package.json` and its dependencies are locked
with `package-lock.json` to try to ensure reproducible builds.
It also uses [PageFind](https://pagefind.app/), a static search library.
Deployment previews are generated for every PR using [Surge.sh](https://surge.sh/) through the corresponding [Woodpecker plugin](https://woodpecker-ci.org/plugins/Surge%20preview%20plugin).
A spellchecker is used to check for spelling errors in the documentation.
To add exceptions to the spellchecker, add them to the `.cspell.json` file.
## License and Contributors
This website (excluding bundled fonts) is licensed under CC BY-SA 4.0. See the [LICENSE](LICENSE.md) file for details.
The contributors are listed in `CONTRIBUTORS.md`.
Please refer to the [commit log](https://codeberg.org/Codeberg/Documentation/commits/branch/main) for an exhaustive list of contributors to Codeberg Documentation.

View file

@ -1,151 +1,269 @@
html, body { width: 100%; height: 100%; margin: 0; padding: 0; background-color: white; color: black; }
body { display: flex; flex-direction: column; font-family: "Inter", sans-serif; font-size: 13pt; font-weight: 300; }
:link { color: #0000EE; }
:visited { color: #551A8B; }
:link:active, :visited:active { color: #FF0000; }
:root {
--admonition-background-color--info: rgba(68, 138, 255, 0.2);
--admonition-background-color--note: rgba(0, 184, 212, 0.2);
--admonition-background-color--warning: rgba(255, 145, 0, 0.2);
--admonition-background-color--tip: rgba(0, 191, 165, 0.2);
--admonition-background-color--question: rgba(100, 221, 23, 0.2);
header { height: 60px; margin-top: 30px; margin-bottom: 60px; }
header > .container { display: flex; align-items: center; }
#header-action-buttons { text-align: right; }
#header-logo { height: 100%; padding: 10px; padding-left: 0; box-sizing: border-box; }
#header-logo img { height: 100%; }
#header-logo-container { display: flex; align-items: center; height: 100%; }
#header-logo a { text-decoration: none; }
#logo-heading { color: #2185d0; font-weight: 700; font-size: 28pt; margin-left: 10px; }
#contents-button { display: none; }
--admonition-border-color--info: rgb(68, 138, 255);
--admonition-border-color--note: rgb(0, 184, 212);
--admonition-border-color--warning: rgb(255, 145, 0);
--admonition-border-color--tip: rgb(0, 191, 165);
--admonition-border-color--question: rgb(100, 221, 23);
main { flex: 1; }
main > .container { display: flex; }
--admonition-icon--info: url('data:image/svg+xml;charset=utf-8,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" width="24" height="24"><path d="M13 7.5a1 1 0 1 1-2 0 1 1 0 0 1 2 0Zm-3 3.75a.75.75 0 0 1 .75-.75h1.5a.75.75 0 0 1 .75.75v4.25h.75a.75.75 0 0 1 0 1.5h-3a.75.75 0 0 1 0-1.5h.75V12h-.75a.75.75 0 0 1-.75-.75Z"></path><path d="M12 1c6.075 0 11 4.925 11 11s-4.925 11-11 11S1 18.075 1 12 5.925 1 12 1ZM2.5 12a9.5 9.5 0 0 0 9.5 9.5 9.5 9.5 0 0 0 9.5-9.5A9.5 9.5 0 0 0 12 2.5 9.5 9.5 0 0 0 2.5 12Z"></path></svg>');
--admonition-icon--note: url('data:image/svg+xml;charset=utf-8,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" width="24" height="24"><path d="M17.263 2.177a1.75 1.75 0 0 1 2.474 0l2.586 2.586a1.75 1.75 0 0 1 0 2.474L19.53 10.03l-.012.013L8.69 20.378a1.753 1.753 0 0 1-.699.409l-5.523 1.68a.748.748 0 0 1-.747-.188.748.748 0 0 1-.188-.747l1.673-5.5a1.75 1.75 0 0 1 .466-.756L14.476 4.963ZM4.708 16.361a.26.26 0 0 0-.067.108l-1.264 4.154 4.177-1.271a.253.253 0 0 0 .1-.059l10.273-9.806-2.94-2.939-10.279 9.813ZM19 8.44l2.263-2.262a.25.25 0 0 0 0-.354l-2.586-2.586a.25.25 0 0 0-.354 0L16.061 5.5Z"></path></svg>');
--admonition-icon--warning: url('data:image/svg+xml;charset=utf-8,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" width="24" height="24"><path d="M13 17.5a1 1 0 1 1-2 0 1 1 0 0 1 2 0Zm-.25-8.25a.75.75 0 0 0-1.5 0v4.5a.75.75 0 0 0 1.5 0v-4.5Z"></path><path d="M9.836 3.244c.963-1.665 3.365-1.665 4.328 0l8.967 15.504c.963 1.667-.24 3.752-2.165 3.752H3.034c-1.926 0-3.128-2.085-2.165-3.752Zm3.03.751a1.002 1.002 0 0 0-1.732 0L2.168 19.499A1.002 1.002 0 0 0 3.034 21h17.932a1.002 1.002 0 0 0 .866-1.5L12.866 3.994Z"></path></svg>');
--admonition-icon--tip: url('data:image/svg+xml;charset=utf-8,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" width="24" height="24"><path d="M12.596 2.043c1.075.076 2.059.281 2.743.956.698.688.92 1.696.92 2.941 0 .432-.057.955-.117 1.438-.026.2-.051.392-.076.572l-.056.429h2.05c.752 0 1.446.108 2.036.404.612.306 1.062.787 1.355 1.431.551 1.214.542 3.008.223 5.394l-.051.39c-.134 1.01-.248 1.872-.396 2.58-.166.795-.394 1.496-.816 2.05-.89 1.168-2.395 1.372-4.583 1.372-2.331 0-4.08-.418-5.544-.824l-.602-.17c-1.023-.29-1.852-.526-2.69-.586A1.75 1.75 0 0 1 5.25 22h-1.5A1.75 1.75 0 0 1 2 20.25V9.75C2 8.784 2.784 8 3.75 8h1.5a1.75 1.75 0 0 1 1.746 1.633 1.85 1.85 0 0 0 .523-.131c.961-.415 2.774-1.534 2.774-4.2V4.249c0-1.22 1.002-2.298 2.303-2.206ZM7 18.918c1.059.064 2.079.355 3.118.652l.568.16c1.406.39 3.006.77 5.142.77 2.277 0 3.004-.274 3.39-.781.216-.283.388-.718.54-1.448.136-.65.242-1.45.379-2.477l.05-.384c.32-2.4.253-3.795-.102-4.575-.16-.352-.375-.568-.66-.711-.305-.153-.74-.245-1.365-.245h-2.37c-.681 0-1.293-.57-1.211-1.328.026-.243.065-.537.105-.834l.07-.527c.06-.482.105-.921.105-1.25 0-1.125-.213-1.617-.473-1.873-.275-.27-.774-.455-1.795-.528-.351-.024-.698.274-.698.71v1.053c0 3.55-2.488 5.063-3.68 5.577-.372.16-.754.232-1.113.26ZM3.75 20.5h1.5a.25.25 0 0 0 .25-.25V9.75a.25.25 0 0 0-.25-.25h-1.5a.25.25 0 0 0-.25.25v10.5c0 .138.112.25.25.25Z"></path></svg>');
--admonition-icon--question: url('data:image/svg+xml;charset=utf-8,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" width="24" height="24"><path d="M10.97 8.265a1.45 1.45 0 0 0-.487.57.75.75 0 0 1-1.341-.67c.2-.402.513-.826.997-1.148C10.627 6.69 11.244 6.5 12 6.5c.658 0 1.369.195 1.934.619a2.45 2.45 0 0 1 1.004 2.006c0 1.033-.513 1.72-1.027 2.215-.19.183-.399.358-.579.508l-.147.123a4.329 4.329 0 0 0-.435.409v1.37a.75.75 0 1 1-1.5 0v-1.473c0-.237.067-.504.247-.736.22-.28.486-.517.718-.714l.183-.153.001-.001c.172-.143.324-.27.47-.412.368-.355.569-.676.569-1.136a.953.953 0 0 0-.404-.806C12.766 8.118 12.384 8 12 8c-.494 0-.814.121-1.03.265ZM13 17a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z"></path><path d="M12 1c6.075 0 11 4.925 11 11s-4.925 11-11 11S1 18.075 1 12 5.925 1 12 1ZM2.5 12a9.5 9.5 0 0 0 9.5 9.5 9.5 9.5 0 0 0 9.5-9.5A9.5 9.5 0 0 0 12 2.5 9.5 9.5 0 0 0 2.5 12Z"></path></svg>');
#sidebar { display: flex; flex-direction: column; padding: 50px 10px; background: #2185d0; color: white; font-weight: 500; box-sizing: border-box; }
#sidebar nav { width: 350px; box-sizing: border-box; flex: 1; }
#sidebar nav .fas { width: 30px; text-align: center; }
#sidebar nav a { text-decoration: none; color: white; }
#sidebar nav ul { list-style-type: none; padding: 0; margin: 0; }
#sidebar .nav-section a { display: block; padding: 7px 10px; margin: 0 -10px 5px; background: #4595d3; font-size: 12pt; }
#sidebar .nav-section:hover a, #sidebar .nav-section.active a { background: #27628f; margin-left: -15px; padding-left: 15px; padding-right: 15px; margin-right: -15px; }
#sidebar .nav-second-level a { font-size: 11pt; }
#sidebar .nav-second-level ul { margin-left: 15px; padding: 7px 0; }
#sidebar .nav-second-level li { margin-bottom: 10px; }
#sidebar .nav-second-level a:hover, #sidebar .nav-second-level a.active { text-decoration: underline; }
#sidebar .sidebar-close-button { display: none; position: relative; text-align: right; top: -35px; }
#sidebar .sidebar-close-button a:hover { color: red; }
#sidebar .section-collapse-button { margin-left: 0 !important; padding-left: 5px !important; }
#sidebar .section-collapse-button:hover { color: #cfffff; }
#sidebar .section-link { margin-right: 0 !important; padding-right: 5px !important; }
#sidebar-overlay { display: none; opacity: 0; position: fixed; width: 100%; height: 100%; z-index: 999; background: #000a; }
.sidebar-overlay-in { opacity: 1; }
article { padding: 50px 0; width: 800px; }
article :first-child { margin-top: 0; }
article h1 { font-size: 34pt; }
article h2 { font-size: 26pt; }
article h3 { font-size: 20pt; }
article h4 { font-size: 16pt; }
article h5 { font-size: 14pt; }
article h6 { font-size: 12pt; }
article blockquote, article img, article pre { box-sizing: border-box; }
article blockquote, article pre { background: #eee; padding: 30px; margin: 0; border-left: 5px solid #2185d0; overflow: auto; }
article blockquote p:last-of-type { margin-bottom: 0; }
article blockquote blockquote { background: #ddd; }
article code { background: #eee; border-radius: 5px; padding: 1px 3px; }
article pre code { background: none; border-radius: none; padding: 0; }
article img { border: 5px solid #eee; max-width: 100%; }
article p { hyphens: auto; max-width: 100%; }
article table { border-collapse: collapse; }
article td, th { padding: 15px; }
article th { background: #ddd; }
article tr:nth-of-type(even) { background: #eee; }
article hr { width: 80%; border: 1px solid #eee; }
.contribution-invitation hr { margin-top: 70px; margin-bottom: 30px; }
footer { background: #f5f5f5; text-align: center; font-size: 8pt; padding: 15px; margin-top: 60px; }
#mobile-action-buttons { text-align: center; display: none; }
#mobile-contents-button { display: none; }
#mobile-contents-button a { color: #2185D0; font-size: 35px; }
.action-buttons { flex: 1; }
.action-buttons a { text-decoration: none; color: black; margin-left: 10px; }
.action-buttons a:hover { text-decoration: underline; }
.collapsible { overflow-y: hidden; transition: max-height 500ms; }
.container { max-width: 1300px; margin: auto; height: 100%; }
.flex-spacer { flex: 99; }
.narrow-only { display: none; }
@media screen and (max-width: 1400px) {
.wide-only { display: none; }
.narrow-only { display: initial; }
#header-logo { margin-left: 0; }
#sidebar { display: block; position: fixed; overflow-y: auto; left: 0; top: 0; height: 100%; transform: translateX(-400px); z-index: 9999; }
#sidebar .sidebar-close-button { display: block; }
#sidebar nav { width: 300px; }
#sidebar .nav-section a { font-size: 11pt; }
#sidebar-overlay.sidebar-overlay-in { display: block; }
article { margin-left: 0; margin-right: 0; padding-top: 0; width: 100%; }
.container { max-width: 780px; padding: 0 50px; }
#contents-button { display: inline-block; background: #eee; border-radius: 5px; padding: 5px; width: 20px; height: 20px; text-align: center; }
#contents-button:hover { background: #ccc; }
--admonition-icon-dimension: 20px;
}
@media screen and (max-width: 750px) {
#header-action-buttons { display: none; }
#mobile-action-buttons { display: block; }
#mobile-contents-button { display: block; }
.container { padding: 0 20px; }
article p { text-align: left; }
header { margin-top: 15px; margin-bottom: 30px; height: 50px; }
#header-logo { flex: 1; }
#logo-heading { font-size: 22pt; }
#mobile-contents-button a { font-size: 30px; }
article h1 { font-size: 28pt; }
article h2 { font-size: 22pt; }
article h3 { font-size: 18pt; }
.content :not(img, pre) {
max-width: 80ch;
}
.content img {
border: 5px solid rgba(0, 0, 0, 0.2);
max-width: 100%;
}
.content blockquote {
margin: 0;
}
.content-title {
margin-top: 20px !important;
}
@keyframes slideSidebar {
from { transform: translateX(-300px); }
to { transform: translateX(0); }
.content pre {
border-left: 5px solid #2185d0;
}
.dark-mode .content pre {
border-left: 5px solid #355379;
}
@keyframes fadeOverlay {
from { opacity: 0; }
to { opacity: 1; }
.content ol {
list-style: decimal outside;
}
.content ul {
list-style: outside;
}
.content ol,
.content ul {
margin-top: 10px;
padding-left: 2em;
}
@media (prefers-color-scheme: dark) {
#logo-heading { color: #94cddc; }
html, body { background-color: #373B49; color: #9ba8bb; }
footer { background: #0b0b0b; color: #bbb; }
footer a { color: #36aaff; }
footer a:visited { color: #86afcc; }
.action-buttons a { color: #9cd9e8; }
:link { color: #449ddc; }
:visited { color: #5d8499; }
:link:active, :visited:active { color: #828f55; }
code, pre { color: #9eaa96 !important; }
article h1 { color: #c6cfee; text-decoration: underline; }
article h2, article h3, article h4, article h5 { color: #c6cfee; }
article code { background: #2e3440; color: #9eaa96; }
article hr { border: 1px solid #91bbdb; }
article blockquote, article pre { background: #21242d; border-left: 5px solid #355379; color: #7f8a95; }
#sidebar { background: #2c303c; color: #879cb3; }
#sidebar nav a { color: #8aa9b9; }
#sidebar .nav-section a { background: #304862; font-size: 12pt; }
#sidebar .nav-section:hover a, #sidebar .nav-section.active a { background: #20374f; }
.codeberg-design .card,
.codeberg-design hr {
margin-left: 0;
}
a.header-anchor,
a.header-anchor:visited {
color: var(--lm-base-text-color) !important;
text-decoration: none;
}
.dark-mode a.header-anchor,
.dark-mode a.header-anchor:visited {
color: var(--dm-base-text-color) !important;
text-decoration: none;
}
a.header-anchor:hover {
text-decoration: underline;
}
code span .content {
margin: 0 !important;
}
/* Apply code style to generic code */
pre:not([class*='language-']) {
background: #2e3440;
color: #f8f8f2;
padding: 1em;
margin: 0.5em 0;
overflow: auto;
border-radius: 0.3em;
}
/* Override sidebar link style */
.codeberg-design .sidebar-title a {
color: var(--sidebar-title-text-color);
}
.codeberg-design .sidebar-title .dark-mode a {
color: var(--dm-sidebar-title-text-color);
}
/* Apply halfmoon style to inline code */
code:not(pre > code) {
font-size: var(--code-font-size);
line-height: var(--code-line-height);
padding: var(--code-padding);
margin: var(--code-margin);
color: var(--lm-code-text-color);
background-color: var(--lm-code-bg-color);
border: var(--code-border-width) var(--lm-code-border-color);
border-radius: var(--code-border-radius);
}
.dark-mode code:not(pre > code) {
color: var(--dm-code-text-color);
background-color: var(--dm-code-bg-color);
border-color: var(--dm-code-border-color);
}
/* Custom Admonition boxes */
.admonition {
background-color: var(--admonition-background-color--info);
border: 0.2rem solid var(--admonition-border-color--info);
border-radius: 0.3rem;
border-left-width: 0.5rem;
padding: 1em 1.5em;
}
.admonition-title {
font-weight: bold;
font-size: 1.2em;
}
.admonition-icon::before {
content: '';
background-color: var(--admonition-border-color--info);
mask-position: center;
mask-repeat: no-repeat;
mask-size: contain;
mask-image: var(--admonition-icon--info);
-webkit-mask-position: center;
-webkit-mask-repeat: no-repeat;
-webkit-mask-size: contain;
-webkit-mask-image: var(--admonition-icon--info);
display: inline-block;
margin-right: 0.4em;
vertical-align: bottom;
height: 1.5em;
width: 1.5em;
}
.admonition.note {
background-color: var(--admonition-background-color--note);
border-color: var(--admonition-border-color--note);
}
.admonition-icon.note::before {
background-color: var(--admonition-border-color--note);
mask-image: var(--admonition-icon--note);
-webkit-mask-image: var(--admonition-icon--note);
}
.admonition.warning {
background-color: var(--admonition-background-color--warning);
border-color: var(--admonition-border-color--warning);
}
.admonition-icon.warning::before {
background-color: var(--admonition-border-color--warning);
mask-image: var(--admonition-icon--warning);
-webkit-mask-image: var(--admonition-icon--warning);
}
.admonition.tip {
background-color: var(--admonition-background-color--tip);
border-color: var(--admonition-border-color--tip);
}
.admonition-icon.tip::before {
background-color: var(--admonition-border-color--tip);
mask-image: var(--admonition-icon--tip);
-webkit-mask-image: var(--admonition-icon--tip);
}
.admonition.question {
background-color: var(--admonition-background-color--question);
border-color: var(--admonition-border-color--question);
}
.admonition-icon.question::before {
background-color: var(--admonition-border-color--question);
mask-image: var(--admonition-icon--question);
-webkit-mask-image: var(--admonition-icon--question);
}
.admonition-content > *:last-child {
margin-bottom: 0;
}
#search-results {
overflow: hidden;
word-wrap: anywhere;
white-space: break-spaces;
--pagefind-ui-background: var(--dm-sidebar-bg-color);
--pagefind-ui-primary: var(--dm-sidebar-link-text-color);
--pagefind-ui-border: var(--dm-sidebar-divider-bg-color);
}
#search-results li {
margin-bottom: 0;
gap: 0;
padding: 10px 0px;
}
.pagefind-modular-list-thumb {
display: none;
}
#search-input::placeholder {
--lm-input-placeholder-text-color: rgba(0, 0, 0, 0.8);
--dm-input-placeholder-text-color: rgba(255, 255, 255, 0.8);
}
#toc {
padding: 5px;
}
#toc ol {
padding: 5px;
margin: 0;
}
#toc li {
list-style-type: none;
margin-bottom: 0;
}
#toc a {
display: block;
height: auto;
}
#toc-side {
margin-top: 50px;
}
#toc-side span {
font-weight: 500;
font-size: 1.5rem;
margin-bottom: 1rem;
}
#toc-side ol:first-child {
border-left: 1px solid rgba(0, 0, 0, 0.15);
}
.dark-mode #toc-side ol:first-child {
border-left: 1px solid rgba(255, 255, 255, 0.15);
}
#toc-side a {
padding-left: 10px;
}

View file

@ -56,7 +56,6 @@
* SOFTWARE.
*/
/**
* Nord Theme Originally by Arctic Ice Studio
* https://nordtheme.com
@ -64,59 +63,59 @@
* Ported for PrismJS by Zane Hitchcoxc (@zwhitchcox) and Gabriel Ramos (@gabrieluizramos)
*/
code[class*="language-"],
pre[class*="language-"] {
color: #f8f8f2;
background: none;
font-family: "Fira Code", Consolas, Monaco, 'Andale Mono', 'Ubuntu Mono', monospace;
text-align: left;
white-space: pre;
word-spacing: normal;
word-break: normal;
word-wrap: normal;
line-height: 1.5;
-moz-tab-size: 4;
-o-tab-size: 4;
tab-size: 4;
-webkit-hyphens: none;
-moz-hyphens: none;
-ms-hyphens: none;
hyphens: none;
code[class*='language-'],
pre[class*='language-'] {
color: #f8f8f2;
background: none;
font-family: 'Fira Code', Consolas, Monaco, 'Andale Mono', 'Ubuntu Mono', monospace;
text-align: left;
white-space: pre;
word-spacing: normal;
word-break: normal;
word-wrap: normal;
line-height: 1.5;
-moz-tab-size: 4;
-o-tab-size: 4;
tab-size: 4;
-webkit-hyphens: none;
-moz-hyphens: none;
-ms-hyphens: none;
hyphens: none;
}
/* Code blocks */
pre[class*="language-"] {
padding: 1em;
margin: .5em 0;
overflow: auto;
border-radius: 0.3em;
pre[class*='language-'] {
padding: 1em;
margin: 0.5em 0;
overflow: auto;
border-radius: 0.3em;
}
:not(pre) > code[class*="language-"],
pre[class*="language-"] {
background: #2E3440;
:not(pre) > code[class*='language-'],
pre[class*='language-'] {
background: #2e3440;
}
/* Inline code */
:not(pre) > code[class*="language-"] {
padding: .1em;
border-radius: .3em;
white-space: normal;
:not(pre) > code[class*='language-'] {
padding: 0.1em;
border-radius: 0.3em;
white-space: normal;
}
.token.comment,
.token.prolog,
.token.doctype,
.token.cdata {
color: #636f88;
color: #636f88;
}
.token.punctuation {
color: #81A1C1;
color: #81a1c1;
}
.namespace {
opacity: .7;
opacity: 0.7;
}
.token.property,
@ -124,15 +123,15 @@ pre[class*="language-"] {
.token.constant,
.token.symbol,
.token.deleted {
color: #81A1C1;
color: #81a1c1;
}
.token.number {
color: #B48EAD;
color: #b48ead;
}
.token.boolean {
color: #81A1C1;
color: #81a1c1;
}
.token.selector,
@ -141,7 +140,7 @@ pre[class*="language-"] {
.token.char,
.token.builtin,
.token.inserted {
color: #A3BE8C;
color: #a3be8c;
}
.token.operator,
@ -150,34 +149,34 @@ pre[class*="language-"] {
.language-css .token.string,
.style .token.string,
.token.variable {
color: #81A1C1;
color: #81a1c1;
}
.token.atrule,
.token.attr-value,
.token.function,
.token.class-name {
color: #88C0D0;
color: #88c0d0;
}
.token.keyword {
color: #81A1C1;
color: #81a1c1;
}
.token.regex,
.token.important {
color: #EBCB8B;
color: #ebcb8b;
}
.token.important,
.token.bold {
font-weight: bold;
font-weight: bold;
}
.token.italic {
font-style: italic;
font-style: italic;
}
.token.entity {
cursor: help;
cursor: help;
}

Binary file not shown.

After

Width:  |  Height:  |  Size: 50 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 20 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 19 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 26 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 7.7 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 38 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 13 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 16 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 8.6 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 42 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 88 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 224 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 402 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 310 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1,020 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 93 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 291 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 288 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 893 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 23 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 17 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 27 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 19 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 36 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 21 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 77 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 47 KiB

View file

Before

Width:  |  Height:  |  Size: 35 KiB

After

Width:  |  Height:  |  Size: 35 KiB

View file

Before

Width:  |  Height:  |  Size: 66 KiB

After

Width:  |  Height:  |  Size: 66 KiB

View file

Before

Width:  |  Height:  |  Size: 48 KiB

After

Width:  |  Height:  |  Size: 48 KiB

View file

Before

Width:  |  Height:  |  Size: 57 KiB

After

Width:  |  Height:  |  Size: 57 KiB

View file

Before

Width:  |  Height:  |  Size: 74 KiB

After

Width:  |  Height:  |  Size: 74 KiB

View file

Before

Width:  |  Height:  |  Size: 46 KiB

After

Width:  |  Height:  |  Size: 46 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 25 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 50 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 71 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 129 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 19 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 8.1 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 17 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 31 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 54 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 17 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 88 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 28 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 38 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 13 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 64 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 21 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 21 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 8.4 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 95 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 30 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 52 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 15 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 56 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 18 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 53 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 31 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 463 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 52 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 52 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 27 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 318 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 46 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 312 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 27 KiB

View file

@ -1 +0,0 @@
Codeberg and the Codeberg Logo are trademarks of Codeberg e.V.

View file

@ -1,123 +0,0 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<svg
xmlns:dc="http://purl.org/dc/elements/1.1/"
xmlns:cc="http://creativecommons.org/ns#"
xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
xmlns:svg="http://www.w3.org/2000/svg"
xmlns="http://www.w3.org/2000/svg"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
inkscape:version="0.92.5 (2060ec1f9f, 2020-04-08)"
sodipodi:docname="codeberg-favicon.svg"
id="svg1468"
version="1.1"
viewBox="0 0 4.2150375 4.2150376"
height="15.93085"
width="15.930851">
<defs
id="defs1462">
<linearGradient
gradientUnits="userSpaceOnUse"
y2="-6966.9307"
x2="42575.336"
y1="-7078.7891"
x1="42519.285"
id="linearGradient6918"
xlink:href="#linearGradient6924" />
<linearGradient
id="linearGradient6924">
<stop
id="stop6920"
offset="0"
style="stop-color:#2185d0;stop-opacity:0" />
<stop
style="stop-color:#2185d0;stop-opacity:0.48923996"
offset="0.49517274"
id="stop6926" />
<stop
id="stop6922"
offset="1"
style="stop-color:#2185d0;stop-opacity:0.63279623" />
</linearGradient>
</defs>
<sodipodi:namedview
showguides="true"
inkscape:snap-page="true"
inkscape:snap-global="true"
units="px"
fit-margin-bottom="0.64969"
fit-margin-right="0"
fit-margin-left="0"
fit-margin-top="0"
showgrid="false"
inkscape:document-rotation="0"
inkscape:current-layer="layer1"
inkscape:document-units="px"
inkscape:cy="14.621"
inkscape:cx="-3.0265425"
inkscape:zoom="32"
inkscape:pageshadow="2"
inkscape:pageopacity="0.0"
borderopacity="1.0"
bordercolor="#666666"
pagecolor="#ffffff"
id="base"
inkscape:snap-bbox="true"
inkscape:bbox-paths="true"
inkscape:bbox-nodes="true"
inkscape:snap-bbox-edge-midpoints="true"
inkscape:snap-bbox-midpoints="true"
inkscape:window-width="3200"
inkscape:window-height="1672"
inkscape:window-x="0"
inkscape:window-y="54"
inkscape:window-maximized="1">
<inkscape:grid
id="grid2067"
type="xygrid"
originx="-0.0091209171"
originy="0.11900229" />
</sodipodi:namedview>
<metadata
id="metadata1465">
<rdf:RDF>
<cc:Work
rdf:about="">
<dc:format>image/svg+xml</dc:format>
<dc:type
rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
<dc:title></dc:title>
</cc:Work>
</rdf:RDF>
</metadata>
<g
transform="translate(-44.876583,-76.12794)"
id="layer1"
inkscape:groupmode="layer"
inkscape:label="Layer 1">
<ellipse
style="fill:#ffffff;fill-opacity:0.98991939;stroke-width:0.26458332"
id="path4524"
cx="46.9841"
cy="78.235458"
rx="2.1075189"
ry="2.1075187" />
<g
transform="matrix(0.09136496,0,0,0.09136496,-980.82243,248.23174)"
id="g6933">
<path
id="path6733"
style="opacity:0.5;vector-effect:none;fill:url(#linearGradient6918);fill-opacity:1;stroke:none;stroke-width:3.67845988;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:2;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1;paint-order:stroke markers fill"
d="m 42519.285,-7078.7891 a 0.76086879,0.56791688 0 0 0 -0.738,0.6739 l 33.586,125.8886 a 87.182358,87.182358 0 0 0 39.381,-33.7636 l -71.565,-92.5196 a 0.76086879,0.56791688 0 0 0 -0.664,-0.2793 z"
transform="scale(0.26458333)"
inkscape:connector-curvature="0" />
<path
transform="scale(0.26458333)"
id="circle6810"
style="opacity:1;fill:#2185d0;fill-opacity:1;stroke:none;stroke-width:2.01452994px;stroke-opacity:1;paint-order:stroke markers fill"
d="m 42517.32,-7119.4805 a 87.182358,87.182358 0 0 0 -86.855,87.1817 87.182358,87.182358 0 0 0 13.312,46.3047 l 72.688,-93.9727 a 1.3609979,1.0158567 0 0 1 2.359,0 l 72.692,93.9766 a 87.182358,87.182358 0 0 0 13.314,-46.3086 87.182358,87.182358 0 0 0 -87.182,-87.1817 87.182358,87.182358 0 0 0 -0.328,0 z"
inkscape:connector-curvature="0" />
</g>
</g>
</svg>

Before

Width:  |  Height:  |  Size: 4.3 KiB

View file

@ -1,100 +0,0 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<svg
xmlns:dc="http://purl.org/dc/elements/1.1/"
xmlns:cc="http://creativecommons.org/ns#"
xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
xmlns:svg="http://www.w3.org/2000/svg"
xmlns="http://www.w3.org/2000/svg"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
inkscape:version="0.92.5 (2060ec1f9f, 2020-04-08)"
sodipodi:docname="codeberg-dark.svg"
id="svg9965"
version="1.1"
viewBox="0 0 55.621185 55.621193"
width="55.621185"
height="55.621193">
<metadata
id="metadata9971">
<rdf:RDF>
<cc:Work
rdf:about="">
<dc:format>image/svg+xml</dc:format>
<dc:type
rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
<dc:title></dc:title>
</cc:Work>
</rdf:RDF>
</metadata>
<defs
id="defs9969">
<linearGradient
xlink:href="#linearGradient6924"
id="linearGradient6918"
x1="42519.285"
y1="-7078.7891"
x2="42575.336"
y2="-6966.9307"
gradientUnits="userSpaceOnUse" />
<linearGradient
id="linearGradient6924">
<stop
style="stop-color:#ffffff;stop-opacity:0"
offset="0"
id="stop6920" />
<stop
id="stop6926"
offset="0.49517274"
style="stop-color:#ffffff;stop-opacity:0.5" />
<stop
style="stop-color:#fdfeff;stop-opacity:1"
offset="1"
id="stop6922" />
</linearGradient>
</defs>
<sodipodi:namedview
inkscape:current-layer="svg9965"
inkscape:cy="72.714836"
inkscape:cx="44.928006"
inkscape:zoom="7.2407734"
showgrid="false"
id="namedview9967"
inkscape:window-height="1672"
inkscape:window-width="3200"
inkscape:pageshadow="2"
inkscape:pageopacity="0"
guidetolerance="10"
gridtolerance="10"
objecttolerance="10"
borderopacity="1"
bordercolor="#666666"
pagecolor="#ffffff"
fit-margin-bottom="2.26835"
fit-margin-top="0"
fit-margin-left="0"
fit-margin-right="0"
inkscape:window-x="0"
inkscape:window-y="54"
inkscape:window-maximized="1" />
<!-- outline -->
<!-- small shadow -->
<!-- mountain in foreground -->
<!-- text -->
<g
transform="matrix(1.2056422,0,0,1.2056422,-13535.014,2271.0633)"
id="g6933">
<path
transform="scale(0.26458333)"
d="m 42519.285,-7078.7891 a 0.76086879,0.56791688 0 0 0 -0.738,0.6739 l 33.586,125.8886 a 87.182358,87.182358 0 0 0 39.381,-33.7636 l -71.565,-92.5196 a 0.76086879,0.56791688 0 0 0 -0.664,-0.2793 z"
style="opacity:0.5;vector-effect:none;fill:url(#linearGradient6918);fill-opacity:1;stroke:none;stroke-width:3.67845988;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:2;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1;paint-order:stroke markers fill"
id="path6733"
inkscape:connector-curvature="0" />
<path
transform="scale(0.26458333)"
d="m 42517.32,-7119.4805 a 87.182358,87.182358 0 0 0 -86.855,87.1817 87.182358,87.182358 0 0 0 13.312,46.3047 l 72.688,-93.9727 a 1.3609979,1.0158567 0 0 1 2.359,0 l 72.692,93.9766 a 87.182358,87.182358 0 0 0 13.314,-46.3086 87.182358,87.182358 0 0 0 -87.182,-87.1817 87.182358,87.182358 0 0 0 -0.328,0 z"
style="opacity:1;fill:#ffffff;fill-opacity:1;stroke:none;stroke-width:2.01452994px;stroke-opacity:1;paint-order:stroke markers fill"
id="circle6810"
inkscape:connector-curvature="0" />
</g>
</svg>

Before

Width:  |  Height:  |  Size: 3.6 KiB

View file

@ -1,100 +0,0 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<svg
xmlns:dc="http://purl.org/dc/elements/1.1/"
xmlns:cc="http://creativecommons.org/ns#"
xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
xmlns:svg="http://www.w3.org/2000/svg"
xmlns="http://www.w3.org/2000/svg"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
inkscape:version="1.0 (4035a4fb49, 2020-05-01)"
sodipodi:docname="codeberg.svg"
id="svg10"
version="1.1"
viewBox="0 0 100 58">
<metadata
id="metadata16">
<rdf:RDF>
<cc:Work
rdf:about="">
<dc:format>image/svg+xml</dc:format>
<dc:type
rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
</cc:Work>
</rdf:RDF>
</metadata>
<defs
id="defs14">
<linearGradient
xlink:href="#linearGradient6924"
id="linearGradient6918"
x1="42519.285"
y1="-7078.7891"
x2="42575.336"
y2="-6966.9307"
gradientUnits="userSpaceOnUse" />
<linearGradient
id="linearGradient6924">
<stop
style="stop-color:#ffffff;stop-opacity:0"
offset="0"
id="stop6920" />
<stop
id="stop6926"
offset="0.49517274"
style="stop-color:#71c2ff;stop-opacity:1" />
<stop
style="stop-color:#39aaff;stop-opacity:1"
offset="1"
id="stop6922" />
</linearGradient>
</defs>
<sodipodi:namedview
inkscape:current-layer="svg10"
inkscape:cy="17.573059"
inkscape:cx="45.102208"
inkscape:zoom="6.6465517"
showgrid="false"
id="namedview12"
inkscape:window-height="480"
inkscape:window-width="640"
inkscape:pageshadow="2"
inkscape:pageopacity="0"
guidetolerance="10"
gridtolerance="10"
objecttolerance="10"
borderopacity="1"
bordercolor="#666666"
pagecolor="#ffffff" />
<!-- outline -->
<!-- small shadow -->
<!-- mountain in foreground -->
<!-- text -->
<g
transform="matrix(0.49902103,0,0,0.49902103,16.383035,-5.830387)"
id="layer1">
<g
transform="matrix(1.4006354,0,0,1.4006354,-15690.065,2662.0533)"
id="g6939">
<path
transform="scale(0.26458333)"
d="m 42405.785,-6929.3027 c -6.178,0 -11.002,2.0754 -14.474,6.2246 -3.518,4.1491 -5.278,9.6275 -5.278,16.4375 0,5.2313 1.286,9.7874 3.856,13.666 3.563,5.4118 8.974,8.1172 16.236,8.1172 5.049,0 9.447,-1.872 13.191,-5.6153 l -3.451,-5.3437 c -3.336,2.1198 -6.221,3.1797 -8.658,3.1797 -3.699,0 -6.653,-1.4205 -8.863,-4.2617 -2.074,-2.7062 -3.112,-5.9541 -3.112,-9.7422 0,-4.2845 0.88,-7.7572 2.639,-10.418 2.031,-3.1118 4.894,-4.668 8.59,-4.668 2.661,0 5.615,1.1725 8.863,3.5176 l 3.451,-5.6133 c -4.331,-3.653 -8.661,-5.4804 -12.99,-5.4804 z m 122.604,0 -8.522,4.8027 v 38.8301 h 6.901 l 0.677,-3.043 c 2.074,2.5706 5.004,3.8555 8.791,3.8555 3.835,0 7.061,-1.1512 9.676,-3.4512 3.336,-3.0216 5.004,-7.4634 5.004,-13.3262 0,-4.5551 -1.126,-8.208 -3.379,-10.959 -2.572,-3.1118 -6.136,-4.6679 -10.689,-4.6679 -1.626,0 -3.114,0.3158 -4.467,0.9472 -1.714,0.8116 -3.045,1.9396 -3.992,3.3829 z m -45.871,0.1347 -8.528,4.7364 v 9.8086 c -2.119,-1.7137 -4.734,-2.5704 -7.845,-2.5704 -3.609,0 -6.698,1.1958 -9.268,3.586 -3.427,3.202 -5.141,7.7561 -5.141,13.664 0,4.1943 1.061,7.6225 3.18,10.2832 2.525,3.2021 6.198,4.8028 11.023,4.8028 1.716,0 3.386,-0.3837 5.008,-1.1504 1.623,-0.7665 2.797,-1.7356 3.52,-2.9082 l 1.217,3.2461 h 6.834 z m -47.993,11.9746 c -4.422,0 -8.008,1.3973 -10.757,4.1934 -3.024,3.0667 -4.536,7.0803 -4.536,12.041 0,4.3747 1.353,8.0741 4.059,11.0957 3.024,3.3373 6.77,5.0059 11.234,5.0059 3.833,0 7.192,-1.3082 10.077,-3.9238 3.474,-3.1119 5.21,-7.1717 5.21,-12.1778 0,-4.2842 -1.171,-7.9141 -3.517,-10.8906 -2.797,-3.5628 -6.72,-5.3438 -11.77,-5.3438 z m 67.071,0 c -4.374,0 -7.982,1.4438 -10.825,4.3301 -3.157,3.1569 -4.736,7.1472 -4.736,11.9727 0,4.9159 1.399,8.7722 4.195,11.5683 2.933,2.9765 7.016,4.4649 12.247,4.4649 4.87,0 8.929,-1.4438 12.177,-4.3301 l -2.166,-4.5313 c -3.202,1.8039 -6.269,2.7051 -9.199,2.7051 -2.076,0 -3.88,-0.6764 -5.412,-2.0293 -1.494,-1.3981 -2.33,-3.1345 -2.506,-5.209 h 21.109 v -3.1113 c 0,-4.4649 -1.173,-8.0965 -3.519,-10.8926 -2.706,-3.2922 -6.495,-4.9375 -11.365,-4.9375 z m 67.666,0 c -4.374,0 -7.982,1.4438 -10.824,4.3301 -3.158,3.1569 -4.737,7.1472 -4.737,11.9727 0,4.9159 1.399,8.7722 4.195,11.5683 2.931,2.9765 7.013,4.4649 12.247,4.4649 4.87,0 8.928,-1.4438 12.173,-4.3301 l -2.162,-4.5313 c -3.202,1.8039 -6.27,2.7051 -9.203,2.7051 -2.074,0 -3.877,-0.6764 -5.412,-2.0293 -1.492,-1.3981 -2.326,-3.1345 -2.502,-5.209 h 21.108 v -3.1113 c 0,-4.4649 -1.172,-8.0965 -3.518,-10.8926 -2.706,-3.2922 -6.495,-4.9375 -11.365,-4.9375 z m 33.017,0 c -1.353,0 -2.684,0.3604 -3.992,1.0821 -1.265,0.6763 -2.121,1.4884 -2.572,2.4355 l -0.811,-2.7051 h -7.24 v 30.711 h 8.391 v -22.0528 c 0.72,-1.5785 1.848,-2.3671 3.383,-2.3671 1.668,0 3.245,0.8564 4.734,2.5703 l 7.17,-3.9239 c -1.986,-3.8334 -5.006,-5.75 -9.063,-5.75 z m 22.016,0 c -3.563,0 -6.654,1.1958 -9.272,3.586 -3.426,3.202 -5.14,7.7561 -5.14,13.664 0,4.1492 1.06,7.5774 3.179,10.2832 2.482,3.2021 5.979,4.8028 10.489,4.8028 3.696,0 6.559,-1.5116 8.59,-4.5332 0,6.7648 -2.435,10.1484 -7.305,10.1484 -3.429,0 -6.519,-0.9029 -9.268,-2.707 l -2.166,4.3301 c 3.563,3.2471 7.78,4.8711 12.651,4.8711 4.689,0 8.297,-1.3758 10.824,-4.127 2.57,-2.7961 3.855,-6.7883 3.855,-11.9746 v -27.5313 h -6.562 l -0.676,3.3145 c 0,-0.451 -0.653,-1.1273 -1.961,-2.0293 -1.985,-1.3979 -4.398,-2.0977 -7.238,-2.0977 z m -122.768,6.0215 c 4.06,0 6.203,2.2094 6.43,6.6289 h -13.059 c 0.497,-4.4195 2.706,-6.6289 6.629,-6.6289 z m 67.666,0 c 4.057,0 6.199,2.2094 6.426,6.6289 h -13.055 c 0.497,-4.4195 2.706,-6.6289 6.629,-6.6289 z m -134.668,0.066 c 4.375,0 6.561,3.3819 6.561,10.1465 0,6.4943 -2.186,9.7422 -6.561,9.7422 -4.376,0 -6.566,-3.2479 -6.566,-9.7422 0,-6.7646 2.19,-10.1465 6.566,-10.1465 z m 33.446,0 c 1.489,0 2.774,0.4963 3.857,1.4883 1.126,0.9472 1.847,2.1642 2.162,3.6524 v 8.5918 c -0.224,1.6685 -1.035,3.1568 -2.433,4.4648 -1.399,1.2626 -2.909,1.8945 -4.532,1.8945 -4.374,0 -6.562,-3.3603 -6.562,-10.0801 0,-3.0667 0.678,-5.5008 2.031,-7.3046 1.353,-1.8039 3.179,-2.7071 5.477,-2.7071 z m 158.15,0 c 1.444,0 2.75,0.5196 3.922,1.5567 1.222,0.9922 1.921,2.186 2.098,3.584 v 7.7812 c 0,1.9392 -0.677,3.629 -2.03,5.0723 -1.353,1.3979 -2.953,2.0976 -4.802,2.0976 -4.42,0 -6.631,-3.3603 -6.631,-10.0801 0,-3.0667 0.678,-5.5008 2.031,-7.3046 1.353,-1.8039 3.157,-2.7071 5.412,-2.7071 z m -90.898,0.068 c 2.073,0 3.697,0.9012 4.871,2.7051 1.171,1.8038 1.758,4.2612 1.758,7.373 0,3.1569 -0.631,5.6393 -1.893,7.4434 -1.262,1.8038 -2.976,2.7051 -5.141,2.7051 -1.67,0 -3.138,-0.5641 -4.4,-1.6915 -1.227,-1.1275 -1.903,-2.5248 -2.029,-4.1933 v -7.375 c 0,-1.9392 0.655,-3.5844 1.963,-4.9375 1.353,-1.3528 2.976,-2.0293 4.871,-2.0293 z"
style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:17.8986px;line-height:1.25;font-family:Tajawal;-inkscape-font-specification:'Tajawal Bold';font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-variant-east-asian:normal;letter-spacing:-0.284861px;word-spacing:0px;fill:#2185d0;fill-opacity:1;stroke:none;stroke-width:1.69121"
id="path6736" />
<g
id="g6933">
<path
id="path6733"
style="font-variation-settings:normal;opacity:0.5;vector-effect:none;fill:url(#linearGradient6918);fill-opacity:1;stroke:none;stroke-width:3.67846;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:2;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1;paint-order:stroke markers fill;stop-color:#000000;stop-opacity:1"
d="m 42519.285,-7078.7891 a 0.76086879,0.56791688 0 0 0 -0.738,0.6739 l 33.586,125.8886 a 87.182358,87.182358 0 0 0 39.381,-33.7636 l -71.565,-92.5196 a 0.76086879,0.56791688 0 0 0 -0.664,-0.2793 z"
transform="scale(0.26458333)" />
<path
id="circle6810"
style="opacity:1;fill:#2185d0;fill-opacity:1;stroke:none;stroke-width:2.01453px;stroke-opacity:1;paint-order:stroke markers fill;stop-color:#000000"
d="m 42517.32,-7119.4805 a 87.182358,87.182358 0 0 0 -86.855,87.1817 87.182358,87.182358 0 0 0 13.312,46.3047 l 72.688,-93.9727 a 1.3609979,1.0158567 0 0 1 2.359,0 l 72.692,93.9766 a 87.182358,87.182358 0 0 0 13.314,-46.3086 87.182358,87.182358 0 0 0 -87.182,-87.1817 87.182358,87.182358 0 0 0 -0.328,0 z"
transform="scale(0.26458333)" />
</g>
</g>
</g>
</svg>

Before

Width:  |  Height:  |  Size: 8.5 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.8 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 25 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 11 KiB

View file

@ -1,22 +0,0 @@
function onCollapseButtonClick(button) {
let icon = button.querySelector(".fas")
let collapseId = button.dataset["collapseId"]
let collapseElement = document.getElementById(collapseId)
if (collapseElement.style.maxHeight == "0px") {
icon.classList.remove("fa-plus-square")
icon.classList.add("fa-minus-square")
collapseElement.style.maxHeight = collapseElement.scrollHeight + "px"
} else {
console.log(collapseElement.style.maxHeight)
if (collapseElement.style.maxHeight === "") { // This is a workaround to fix animation when no initial maxHeight has been set
collapseElement.style.maxHeight = collapseElement.scrollHeight + "px"
void collapseElement.offsetWidth // Needed to trigger render
}
icon.classList.add("fa-plus-square")
icon.classList.remove("fa-minus-square")
collapseElement.style.maxHeight = "0px"
}
}

View file

@ -1,43 +0,0 @@
function getSidebar() {
return document.querySelector("#sidebar")
}
function getSidebarOverlay() {
return document.querySelector("#sidebar-overlay")
}
function hideSidebar() {
resetSidebarAnimation()
getSidebar().style.animation = "slideSidebar 0.5s ease-in-out reverse backwards"
}
function showSidebar() {
resetSidebarAnimation()
const sidebar = getSidebar()
sidebar.classList.add("sidebar-in")
sidebar.style.animation = "slideSidebar 0.5s ease-in-out normal forwards"
const overlay = getSidebarOverlay()
overlay.classList.add("sidebar-overlay-in")
overlay.style.animation = "fadeOverlay 0.5s ease-in-out normal forwards"
}
function resetSidebarAnimation() {
const sidebar = getSidebar()
sidebar.classList.remove("sidebar-in")
sidebar.style.animation = "none"
void sidebar.offsetWidth // Needed to restart animation
const overlay = getSidebarOverlay()
overlay.classList.remove("sidebar-overlay-in")
overlay.style.animation = "none"
void overlay.offsetWidth // Needed to restart animation
}
function toggleSidebar() {
if (getSidebar().classList.contains("sidebar-in"))
hideSidebar()
else
showSidebar()
}

3
content/_data/env.js Normal file
View file

@ -0,0 +1,3 @@
module.exports = {
environment: process.env.ELEVENTY_ENV,
};

View file

@ -1,4 +1,4 @@
{
"commitHistoryMaster": "https://codeberg.org/Codeberg/Documentation/commits/branch/master",
"docsSourcesMaster": "https://codeberg.org/codeberg/documentation/src/branch/master"
"commitHistoryMaster": "https://codeberg.org/Codeberg/Documentation/commits",
"docsSourcesMaster": "https://codeberg.org/Codeberg/Documentation/src"
}

View file

@ -1,19 +1,16 @@
<div class="contribution-invitation">
<hr>
<blockquote>
<div class="card" data-pagefind-ignore="all">
<p>Hey there! 👋 Thank you for reading this article!</p>
<p>
Is there something missing or do you have an idea on how to improve the documentation?
Is there something missing, or do you have an idea on how to improve the documentation?
Do you want to write your own article?
</p>
<p>
You're invited to contribute to the Codeberg Documentation at <a href="https://codeberg.org/Codeberg/Documentation">its source code repository</a>,
for example by <a href="/collaborating/pull-requests-and-git-flow">Adding a pull request</a>
for example, by <a href="/collaborating/pull-requests-and-git-flow">adding a pull request</a>
or joining in on the discussion in <a href="https://codeberg.org/Codeberg/Documentation/issues">the issue tracker</a>.
</p>
<p>
For an introduction on contributing to Codeberg Documentation, please have a look
at <a href="https://docs.codeberg.org/improving-codeberg/docs-contributor-faq">the Contributor FAQ</a>.
</p>
</blockquote>
</div>

View file

@ -1,120 +1,210 @@
<!DOCTYPE html>
<html lang="en">
<html lang="en" class="codeberg-design">
<head>
<title>{% if eleventyNavigation.title %}{{ eleventyNavigation.title }} | {% endif %}Codeberg Documentation</title>
<meta charset="UTF-8">
{% if description %}<meta name="description" content="{{ description }}">{% endif %}
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta charset="UTF-8" />
{% if description %}
<meta name="description" content="{{ description }}" />
{% endif %}
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
{% if env.environment == "testing" %}
<meta name="robots" content="noindex" />
{% endif %}
<link rel="icon" type="image/svg+xml" href="/assets/images/logo/codeberg-favicon.svg" sizes="250x250">
<link rel="icon" href="https://design.codeberg.org/logo-kit/favicon.ico" type="image/x-icon" />
<link rel="icon" href="https://design.codeberg.org/logo-kit/favicon.svg" type="image/svg+xml" />
<link rel="apple-touch-icon" href="https://design.codeberg.org/logo-kit/apple-touch-icon.png" />
<link rel="preload" type="text/css" href="/assets/css/codeberg-docs.css">
<link rel="preload" href="https://fonts.codeberg.org/dist/inter/Inter Web/inter.css" as="style">
<link rel="preload" href="https://fonts.codeberg.org/dist/fontawesome5/css/solid.min.css" as="style">
<link rel="preload" href="https://fonts.codeberg.org/dist/fontawesome5/css/fontawesome.min.css" as="style">
<link rel="preload" type="text/css" href="/assets/css/codeberg-docs.css" as="style" />
<link rel="preload" type="text/css" href="https://design.codeberg.org/design-kit/codeberg.css" as="style" />
<link rel="preload" href="https://fonts.codeberg.org/dist/inter/Inter%20Web/inter.css" as="style" />
<link rel="preload" href="https://fonts.codeberg.org/dist/fontawesome6/css/svg-with-js.css" as="style" />
<link rel="stylesheet" type="text/css" href="/assets/css/codeberg-docs.css" async>
<link rel="stylesheet" type="text/css" href="/assets/css/prism-nord.css" async>
<!-- Details and License: https://codeberg.org/Codeberg/Design/src/design-kit -->
<link rel="stylesheet" href="https://design.codeberg.org/design-kit/codeberg.css" />
<script defer src="https://design.codeberg.org/design-kit/codeberg.js"></script>
<link rel="stylesheet" type="text/css" href="/assets/css/codeberg-docs.css" />
<!-- Syntax highlighting -->
<link rel="stylesheet" type="text/css" href="/assets/css/prism-nord.css" />
<!-- Details and License: https://fonts.codeberg.org/fonts/inter -->
<link rel="stylesheet" type="text/css" href="https://fonts.codeberg.org/dist/inter/Inter Web/inter.css" async>
<link rel="stylesheet" type="text/css" href="https://fonts.codeberg.org/dist/inter/Inter%20Web/inter.css" />
<!-- Details and License: https://fonts.codeberg.org/fonts/fontawesome5 -->
<link rel="stylesheet" type="text/css" href="https://fonts.codeberg.org/dist/fontawesome5/css/solid.min.css" async>
<link rel="stylesheet" type="text/css" href="https://fonts.codeberg.org/dist/fontawesome5/css/fontawesome.min.css" async>
<link rel="stylesheet" type="text/css" href="https://fonts.codeberg.org/dist/fontawesome6/css/svg-with-js.css" />
<script type="text/javascript" src="/assets/js/collapse.js"></script>
<script type="text/javascript" src="/assets/js/sidebar.js"></script>
<link href="/pagefind/pagefind-modular-ui.css" rel="stylesheet" />
<script src="/pagefind/pagefind-modular-ui.js"></script>
<script>
window.addEventListener('DOMContentLoaded', (event) => {
const instance = new PagefindModularUI.Instance();
instance.add(
new PagefindModularUI.Input({
containerElement: '#search-input',
}),
);
instance.add(
new PagefindModularUI.ResultList({
containerElement: '#search-results',
}),
);
document.addEventListener(
'keydown',
(event) => {
if (event.key == '/') {
event.preventDefault();
document.getElementById('search-input').focus();
}
},
false,
);
});
</script>
{% if page.url != '/' %}
<script>
// @license magnet:?xt=urn:btih:90dc5c0be029de84e523b9b3922520e79e0e6f08&dn=cc0.txt CC0
document.addEventListener('DOMContentLoaded', function () {
document.getElementsByClassName('active')[0].scrollIntoView({ block: 'center' });
});
// @license-end
</script>
{% endif %}
</head>
<body>
<div id="sidebar-overlay" onclick="javascript:hideSidebar()"></div>
<header>
<div class="container">
<div id="header-logo">
<a href="/">
<div id="header-logo-container">
<img src="/assets/images/logo/codeberg-favicon.svg" alt="Codeberg">
<div id="logo-heading">Documentation</div>
<body data-set-preferred-mode-onload="true">
{% include 'license.njk' %}
<div class="with-navbar with-sidebar with-transitions page-wrapper" data-sidebar-type="overlayed-sm-and-down">
<div class="sidebar-overlay" onclick="halfmoon.toggleSidebar()"></div>
<nav class="navbar">
<div class="navbar-content">
<button class="btn btn-primary" type="button" onclick="halfmoon.toggleSidebar()">
{% fas_icon "bars" %}
<span class="sr-only">Toggle sidebar</span>
</button>
</div>
<!-- Navbar brand -->
<a href="/" class="navbar-brand" title="Codeberg Docs">
<img src="https://design.codeberg.org/logo-kit/icon_inverted.svg" height="22" width="22" alt="Codeberg" />
Docs
</a>
<!-- Navbar nav -->
<ul class="d-md-flex ml-auto d-none navbar-nav">
<li class="nav-item">
<a
href="{{ urls.commitHistoryMaster }}/{{ page.inputPath }}"
class="nav-link"
target="_blank"
rel="noreferrer"
>
{% fas_icon "history" %} &nbsp; View History
</a>
</li>
<li class="nav-item">
<a
href="{{ urls.docsSourcesMaster }}/{{ page.inputPath }}"
class="nav-link"
target="_blank"
rel="noreferrer"
>
{% fas_icon "code" %} &nbsp; View Source
</a>
</li>
{#
<li class="nav-item">
<a href="javascript:;" onclick="document.body.classList.toggle('dark-mode')" class="nav-link">
{% fas_icon "moon" %} &nbsp; Toggle Dark Mode
</a>
</li>
#}
</ul>
<!-- Navbar content (dropdown menu) -->
<div class="ml-auto d-md-none navbar-content">
<div class="with-arrow dropdown">
<button class="btn" data-toggle="dropdown" type="button" id="navbar-dropdown-toggle-btn-1">
Menu {% fas_icon "angle-down" %}
</button>
<div class="dropdown-menu-right w-200 dropdown-menu" aria-labelledby="navbar-dropdown-toggle-btn-1">
<a
href="{{ urls.commitHistoryMaster }}/{{ page.inputPath }}"
class="dropdown-item"
target="_blank"
rel="noreferrer"
>
{% fas_icon "history" %} &nbsp; View History
</a>
<a
href="{{ urls.docsSourcesMaster }}/{{ page.inputPath }}"
class="dropdown-item"
target="_blank"
rel="noreferrer"
>
{% fas_icon "code" %} &nbsp; View Source
</a>
{#
<a href="javascript:;" onclick="document.body.classList.toggle('dark-mode')" class="dropdown-item">
{% fas_icon "moon" %} &nbsp; Toggle Dark Mode
</a>
#}
<div class="mt-5 dropdown-divider"></div>
</div>
</div>
</div>
</nav>
<div class="sidebar">
<div class="sidebar-menu">
<!-- Sidebar content with the search box -->
<div class="sidebar-content">
<input type="text" class="form-control" placeholder="Filter Docs" id="search-input" />
<div class="mt-10 font-size-12">Press <kbd>/</kbd> to focus</div>
<div id="search-results"></div>
</div>
{% for entry in collections.all | eleventyNavigation %} {% set active = entry.url == page.url or entry.key ==
eleventyNavigation.parent %} {% if (not entry.draft) or active %}
<h5 class="sidebar-title {% if active %} active{% endif %}">
<a href="{{ entry.url }}" id="{{ entry.key }}"
>{% fas_icon entry.icon | default("caret-right") %} {{ entry.title }}</a
>
</h5>
<div class="sidebar-divider"></div>
{% if entry.children.length > 0 %} {% for child in entry.children %} {% set child_active = child.url ==
page.url %} {% if child_active or not child.draft %}
<a href="{{ child.url }}" class="sidebar-link{% if child_active %} active{% endif %}" id="{{ child.key }}">
<span class="name">{{ child.title }}</span>
</a>
{% endif %} {% endfor %} {% endif %} {% endif %}
<br />
{%- endfor %}
</div>
<div class="action-buttons" id="header-action-buttons">
<!--<a href="#">{% fas_icon "globe-europe" %} English</a>-->
<a href="{{ urls.commitHistoryMaster }}/{{ page.inputPath }}" target="_blank">{% fas_icon "history" %} View History</a>
<a href="{{ urls.docsSourcesMaster }}/{{ page.inputPath }}" target="_blank">{% fas_icon "code" %} View Source</a>
<a href="#" id="contents-button" onclick="toggleSidebar()">{% fas_icon "bars" %}</a>
</div>
<div id="mobile-contents-button"><a href="#" onclick="toggleSidebar()">{% fas_icon "bars" %}</a></div>
</div>
</header>
<main>
<div class="container">
<div id="sidebar">
<nav>
<div class="sidebar-close-button"><a href="javascript:void(0)" onclick="hideSidebar()">{% fas_icon "times-circle" %}</a></div>
<ul>
{% for entry in collections.all | eleventyNavigation %}
{% set active = entry.url == page.url or entry.key == eleventyNavigation.parent %}
{% if (not entry.draft) or active %}
<li class="nav-section{% if active %} active{% endif %}" style="display: flex;">
<a class="section-link" href="{{ entry.url }}" style="flex: 1;">{% fas_icon entry.icon | default("caret-right") %} {{ entry.title }}</a>
{% if entry.children.length > 0 %}
<a class="section-collapse-button" data-collapse-id="nav-second-level-{{ entry.key }}" href="javascript:void(0)" onclick="onCollapseButtonClick(this)">
{% if active %}{% fas_icon "minus-square" %}{% else %}{% fas_icon "plus-square" %}{% endif %}
</a>
{% else %}
<a class="section-collapse-button"><!-- Intentionally left blank --></a>
{% endif %}
</li>
{% if entry.children.length > 0 %}
<li class="nav-second-level collapsible" id="nav-second-level-{{ entry.key }}"{% if not active %} style="max-height: 0px;"{% endif %}>
<ul>
{% for child in entry.children %}
{% set child_active = child.url == page.url %}
{% if child_active or not child.draft %}
<li><a href="{{ child.url }}"{% if child_active %} class="active"{% endif %}>{{ child.title }}</a></li>
{% endif %}
{% endfor %}
</ul>
</li>
{% endif %}
{% endif %}
{%- endfor %}
</ul>
</nav>
</div>
<div class="flex-spacer"></div>
<article>
{% if eleventyNavigation.title %}<h1>{{ eleventyNavigation.title }}</h1>{% endif %}
{% if eleventyNavigation.draft %}<strong>Please note that this article is still a draft and might not have any contents yet.</strong>{% endif %}
{{ content | safe }}
{% if page.url != '/' %}{% include 'contribution_invitation.njk' %}{% endif %}
</article>
</div>
<div class="action-buttons" id="mobile-action-buttons">
<!--<a href="#">{% fas_icon "globe-europe" %} English</a>-->
<a href="{{ urls.commitHistoryMaster }}/{{ page.inputPath }}" target="_blank">{% fas_icon "history" %} View History</a>
<a href="{{ urls.docsSourcesMaster }}/{{ page.inputPath }}" target="_blank">{% fas_icon "code" %} View Source</a>
<div class="content-wrapper">
<div class="container-fluid">
<div class="row">
<div class="col-xl-8 content" data-pagefind-body>
{% if eleventyNavigation.title %}
<h1 class="content-title font-size-24">{{ eleventyNavigation.title }}</h1>
{% endif %} {% if eleventyNavigation.draft %}
<strong data-pagefind-ignore="all"
>Please note that this article is still a draft and might not have any contents yet.</strong
>
{% endif %} {% include 'toc-collapse.njk' %}
{{ content | safe }}
<hr class="mb-20" />
{% if page.url != '/' %} {% include 'contribution_invitation.njk' %} {% endif %}
<div class="text-right font-size-16" data-pagefind-ignore="all">
<p>&copy; Codeberg Docs Contributors. See <a href="#modal-1" role="button">LICENSE</a></p>
</div>
</div>
{% include 'toc-side.njk' %}
</div>
</div>
</div>
</main>
<footer>
This Website by <a href="{{ urls.docsSourcesMaster }}/CONTRIBUTORS.md">The Codeberg Documentation Contributors</a> is licensed under <a href="https://creativecommons.org/licenses/by-sa/4.0/deed.en">CC-BY-SA 4.0</a>.
It bundles third-party font software licensed under a different license.
Please look at <a href="{{ urls.docsSourcesMaster }}/LICENSE.md">the LICENSE file</a> for details.<br>
Changes to the original versions of the article as well as its individual authors can be looked up in <a href="{{ urls.commitHistoryMaster }}/{{ page.inputPath }}" target="_blank">this article's commit history</a><br>
Codeberg and the Codeberg Logo are trademarks of Codeberg e.V.<br>
For Imprint, Privacy Policy and other legal notices, please refer to <a href="https://codeberg.org">https://codeberg.org</a>.
</footer>
</div>
</body>
</html>

Some files were not shown because too many files have changed in this diff Show more