kgess-mirror/codeberg-Documentation
1
0
Fork 0
mirror of https://codeberg.org/Codeberg/Documentation.git synced 2026-01-16 23:10:42 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update content/codeberg-pages/index.md

Browse source
This commit is contained in:
fnetX 2025-12-02 20:52:58 +01:00 • committed by Catherine
parent 30a3327d53
commit 515e166a44
1 changed files with 3 additions and 17 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
content/codeberg-pages/index.md
View file

@ -14,19 +14,18 @@ The new documentation is work in progress, and we appreciate your feedback. Plea
{% endadmonition %}
Codeberg Pages allows you to easily publish static websites with a human-friendly address (`{username}.codeberg.page`)
via Git on Codeberg.
Codeberg Pages allows you to easily publish static websites with a human-friendly address (`{username}.codeberg.page`) or your custom domain on Codeberg.
Follow these simple steps below to get started, or check out the advanced usage below.
1. Create a **public** repository named 'pages' in your user account or organization.
2. Create static content, HTML, stylesheets, fonts or images. Name the homepage file `index.html`.
3. Push your content to the default branch of the new repository.
4. You should now be able to access your content by visiting `{username}.codeberg.page`.
4.
---
This project is developed "in-house" by Codeberg. You can find [the source code in our repository](https://codeberg.org/Codeberg/pages-server/).
Codeberg is using ["git-pages", which is developed on Codeberg](https://codeberg.org/git-pages/git-pages). It is free/libre open source software.
See also:
@ -55,19 +54,6 @@ See also:
{% endif %}
{%- endfor %}
## Advanced Usage: Canonical URLs
The Codeberg Pages server responds to four different URLs:
- `https://raw.codeberg.page/username/reponame/`: raw content, uses correct MIME types (HTML is forbidden though)
and is accessible with CORS.
- `https://username.codeberg.page`: user page, points the default branch of a user's or organization's `pages` repository
- `https://username.codeberg.page/reponame/`: repo page, points to the `pages` branch of the repository
- `https://example.org`: custom domain, points to a repo of choice as outlined below
In all cases, you can append a branch using an `@` (e.g. `https://username.codeberg.page/@develop/README.md`).
If the branch name contains a slash (`/`), they need to be replaced with a tilde (`~`) (e.g. the branch `docs/develop`
can be accessed via `https://username.codeberg.page/@docs~develop/README.md`).
## Advanced Usage: Custom error page for 404s