Documentation/README.md

28 lines
888 B
Markdown
Raw Normal View History

2020-08-02 08:13:08 -07:00
# 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!
## Usage
This website uses [Eleventy](https://www.11ty.dev/) as its static site generator.
It's supplied as a dev-dependency in `package.json`.
Thus, install the dependencies by running
```npm install```
and then run
```npm run serve```
to have a look at the website or
```npm run build```
to build the website to `_site`.
## License and Contributors
This website (excluding bundled fonts) is licensed under CC BY-SA 4.0. See the [LICENSE](LICENSE.md) file for details.
The contributors are listed in `CONTRIBUTORS.md`.