35 lines
1.3 KiB
Markdown
35 lines
1.3 KiB
Markdown
# Organic Maps Website
|
|
|
|
This static website is built with [Zola](https://www.getzola.org/) and Cloudflare Pages.
|
|
|
|
|
|
|
|
## Development
|
|
|
|
Download the latest zola (version 0.17.2 at the time of writing) 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](https://t.me/OrganicMapsApp),
|
|
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](TRANSLATIONS.md) file for detailed instructions.
|