This is a question that is raised repeatedly in the community tracker or matrix. Co-authored-by: René W <email@example.com> Reviewed-on: Codeberg/Documentation#187 Co-authored-by: René W. <firstname.lastname@example.org> Co-committed-by: René W. <email@example.com>
|1 year ago|
|assets||1 year ago|
|content||1 year ago|
|.eleventy.js||2 years ago|
|.gitignore||2 years ago|
|CONTRIBUTORS.md||2 years ago|
|LICENSE.md||2 years ago|
|README.md||2 years ago|
|deploy.sh||1 year ago|
|package-lock.json||1 year ago|
|package.json||1 year ago|
This repository contains the documentation for Codeberg, 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
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.
to install all dependencies (they will be installed only for this project, not globally). You only have to do this once.
npm run serve
to start a development web server that by default is listening at
Now you can simply change, add or remove files, save them and the development server 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!
Build & Deployment
Like for local development, before building and deploying you first have to install the dependencies (once):
To build the entire website to the
_site directory run
npm run build
Instead, to directly publish the page to Codeberg pages, you can also run
npm run deploy
which includes a call to
npm run build.
This website uses Eleventy, a static site generator.
It's supplied as a dev-dependency in
package.json and its dependencies are locked
package-lock.json to try to ensure reproducible builds.
License and Contributors
This website (excluding bundled fonts) is licensed under CC BY-SA 4.0. See the LICENSE file for details.
The contributors are listed in