website/README.md
meenbeese 2d5bb1000d Documentation and adding website image
Signed-off-by: meenbeese <meenbeese@tutanota.com>

Update link for site image

Signed-off-by: meenbeese <meenbeese@tutanota.com>

Update website_main.png

Signed-off-by: meenbeese <meenbeese@tutanota.com>
2023-09-25 01:32:18 +02:00

1.2 KiB

Organic Maps Website

This static website is built with Zola and Cloudflare Pages.

Main Website

Development

Download zola (version 0.17.2) 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 when 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.

Deployment

Every PR deploys a preview version of the site at unique url.

Every merge into the master branch deploys changes into the production at https://organicmaps.app

Updating News

Run npm run news to automatically download news from our Telegram channel, then create a git commit and push it.

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.

Translations

Please help us with translating this web-site in your language. See TRANSLATIONS.md file for detailed instructions.