The Codeberg Documentation website by The Codeberg Documentation Contributors is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.
It bundles third-party font software licensed under a different license. Please look at the LICENSE file for details.
Changes to the original versions of the article as well as its individual authors can be looked up in this article's commit history
Codeberg and the Codeberg Logo are trademarks of Codeberg e.V.
If you are using a static site generator (SSG) and are satisfied with the result of your project on your local development environment, you can push the files to your Codeberg Pages repository.
To begin with, we will have two separate repositories, both locally and on Codeberg:
A main repository for the source files, i.e. where the source files related to your main project will be located. We will refer to this repository as the source repository. This repository is the one associated with your mydocs folder.
A second repository for Codeberg pages that we will call the pages repository. This repository will only contain the files available in the html folder located under docs/build/html.
The pages repository must be public, as Codeberg Pages will directly fetch the files from the repository, just like an ordinary user would.
For the purpose of this guide, we have chosen to use two separate folders/repositories. However, you may want to have a different setup that involves creating a submodule instead of having folders and repositories in separate locations. With a submodule, your configuration may look like so:
├── sources --> This is a git repo
│ ├── build
│ │ └── html
│ │ └── pages --> This is a separate git repo
│ └── content
To copy the content of the html folder to your new pages folder, run the command:
(.venv) $ cp -R docs/build/html/ pages We will now initialize an empty repository inside the pages folder. To do this, type the command:
$ git initTo check the status of your project’s files, type the command:
$ git statusTo add all the files that are available in your directory to Git, run the command:
$ git add -ANow we will commit:
$ git commit -m "Example commit message"Repeat these steps in your source folder, then push your local commits to the remote repository with the command:
$ git push origin HEAD:your-remote-branch-nameReplace your-remote-branch-name with the name of your remote branch. It is recommended to initially push your commits to a branch other than the default branch. Once you have made sure everything went smoothly, you can then make a pull request to merge it into the default branch. To learn more about pull requests, read the article Pull requests and Git flow.
You should now be able to access your content by visiting https://{username}.codeberg.page. You can find more information in the Codeberg Pages section.
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