Press / to focus
Codeberg Documentation

Getting Started with Codeberg
What is Codeberg? Your First Steps on Codeberg Install Git Your First Repository The Basics of Issue Tracking Integrated Wiki Email Settings Licensing on Codeberg Frequently Asked Questions
Collaborating with Others
Citable Code Pull requests and Git flow Invite Collaborators Create and Manage an Organization Repository Permissions Resolve Conflicts
Working with Git Repositories
Using .gitignore Configuring Git Clone & Commit via CLI Clone & Commit via Web Merge multiple commits into one Tags and Releases Working with large files
Writing in Markdown
Introduction to Markdown Using Links Topics Preformatted Text Using Images Using Lists Tables in Markdown Markdown FAQ
Security
Setting up two-factor authentication Adding an SSH key to your account Verifying you're connected to Codeberg using SSH fingerprints Adding a GPG key to your account
Codeberg Pages
Using Custom Domains Troubleshooting Example: Docs as Code with Sphinx Pushing output from SSGs into Codeberg Pages Redirects
Advanced Usage
Using Webhooks Generating an Access Token Migrating Repositories
Working with Codeberg's CI
Using Forgejo Actions (Self-hosted)
Integrations with Other Services
Integrating with Keycloak Integrating with Matrix Integrating with Read the Docs
Codeberg Translate
Getting started Manual Component configuration Introduction to Weblate
Improving Codeberg
Contributing Code
Improving the Documentation
Style Guide How to create a new article? Can I preview my article? How to make screenshots for Codeberg Documentation? Documentation Contributor FAQ
Contact

Codeberg Pages

Codeberg Pages allows you to easily publish static websites with a human-friendly address ({username}.codeberg.page) via Git 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.

This project is developed "in-house" by Codeberg. You can find the source code here.

See also:

Find out more in this section:
Using Custom Domains
Troubleshooting
Example: Docs as Code with Sphinx
Pushing output from SSGs into Codeberg Pages
Redirects

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).

Do you have questions, feedback or have you found a bug?

The source code for Codeberg Pages is maintained over at the Pages Server repository; feel free to head there to provide some feedback, suggestions, bug reports or even patches. If you need general community support or have questions, Codeberg/Community is a better place to ask, as more people will be watching there to help you out! We really appreciate your contribution.

Installing Pages for your own Forgejo instance

Codeberg Pages works with any Forgejo host out there. So if you are running your own Forgejo, you can absolutely run it yourself and help with the development. Check out the Pages Server repository for more information.

Hey there! 👋 Thank you for reading this article!

Is there something missing, or do you have an idea on how to improve the documentation? Do you want to write your own article?

You're invited to contribute to the Codeberg Documentation at its source code repository, for example, by adding a pull request or joining in on the discussion in the issue tracker.

For an introduction on contributing to Codeberg Documentation, please have a look at the Contributor FAQ.

© Codeberg Docs Contributors. See LICENSE