acd7bd1ace
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
|
||
|---|---|---|
| assets | ||
| content | ||
| .eleventy.js | ||
| .gitignore | ||
| CONTRIBUTORS.md | ||
| deploy.sh | ||
| LICENSE.md | ||
| package-lock.json | ||
| package.json | ||
| README.md | ||
Codeberg Documentation
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
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
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
to start a development web server that by default is listening at http://localhost:8080.
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):
npm install
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.
Technical Information
This website uses Eleventy, 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.
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 CONTRIBUTORS.md.