CoMaps Website

This static comaps.app website is built with Zola.

Translations

We need your help to translate this site to your language on Codeberg Translate.

Development

• Download the latest zola for your operating system and set up the necessary path variable.

• Run zola serve for a local preview or zola build to generate static site in the public folder.

• Run npm i && npm run format if you want to pretty-format the Markdown and SCSS files.

• Upgrade npm dependencies with npm run upgrade, make sure that you have installed npm-check-updates package.

Content changes in .md files

Only the English Markdown files should be edited directly. After changing text in a .md file, please run ./tools/i18n.sh as described in TRANSLATIONS.md to propagate the english changes to all other languages.

Creating redirects

There are two different types of redirects that can be created: 1. Website internal redirects (or aliases) if you want a page to be accessible under multiple slugs. 2. External redirects (if you want a link from comaps.app to redirect to an external site, like e.g. Codeberg).

Internal redirects / aliases

In the front-matter of the markdown index.md or _index.md file, specify one or multiple aliases, like so:

aliases:
 - relative/path
 - another/path

External redirects

For those you need to create a sub-folder that matches the redirect source you want. E.g. For creating a redirect that links comaps.app/latest to Codeberg, you need to create a content/latest/_index.md and the target into the front matter, e.g.

---
redirect_to: "https://codeberg.org/comaps/comaps/releases"
---

Deployment

The latest site is automatically deployed from main on the merging of a pull request. It's also possible to manually deploy in the Actions menu.

Contribution

Any good ideas and help with web site improvement are appreciated. And it's always better to discuss any improvement before implementing it to sync with our vision and plans.