Skip to content

Repository files navigation

oleafly.com

The web home of Oleafly, the free, open-source, local-first LaTeX studio.

CI License: MIT Lighthouse desktop Lighthouse mobile Stars

oleafly.com

oleafly.com · Docs · Download the app


This repo is the website: the page you see at oleafly.com and the product docs at oleafly.com/docs. If you're looking for the app itself, that lives at Oleafly/Oleafly.

Built with Astro and Starlight. Everything is static. No server, no database, no third-party requests, and the only JavaScript that ships is for the animations.

Run it locally

You need Node 22+ and pnpm.

git clone https://github.com/Oleafly/oleafly-web.git
cd oleafly-web
pnpm install
pnpm dev

Open http://localhost:4321 and you're looking at the site. Edits reload live.

Supported languages

The site ships 18 locales. English is the default at the site root (no URL prefix). Every other language is a first-class path under /{locale}/… (for example https://oleafly.com/zh-cn/learn/). The header language switcher shows a flag + native name for each option.

Flag Locale Native name English name URL BCP-47
United States en English English / (default) en
China zh-cn 简体中文 Chinese (Simplified) /zh-cn/ zh-CN
Taiwan zh-tw 繁體中文 Chinese (Traditional) /zh-tw/ zh-TW
Japan ja 日本語 Japanese /ja/ ja
South Korea ko 한국어 Korean /ko/ ko
Spain es Español Spanish /es/ es
Brazil pt-br Português Portuguese (Brazil) /pt-br/ pt-BR
France fr Français French /fr/ fr
Germany de Deutsch German /de/ de
India hi हिन्दी Hindi /hi/ hi
Italy it Italiano Italian /it/ it
Netherlands nl Nederlands Dutch /nl/ nl
Poland pl Polski Polish /pl/ pl
Russia ru Русский Russian /ru/ ru
Ukraine uk Українська Ukrainian /uk/ uk
Turkey tr Türkçe Turkish /tr/ tr
Saudi Arabia ar العربية Arabic (RTL) /ar/ ar
Vietnam vi Tiếng Việt Vietnamese /vi/ vi

Examples:

Language is not forced by country (geo-IP). The URL always wins; the switcher can save a preference; on a first visit to / only, a banner may suggest a match from your browser languages. Shared deep links are never rewritten.

Contributing

Typo fixes and small improvements: open a pull request directly, no need to ask first.

Bigger changes (new sections, layout changes, new pages): open an issue first so we can talk it through. The page is deliberately tight and we say no to most additions, not because they're bad ideas but because a short page that loads fast is one of our primary goals.

Run pnpm build before you push. If the build passes locally it will pass in CI.

How deploys work

Every push to main deploys automatically. A GitHub Action builds the site and uploads it to Cloudflare Pages, usually live within a minute. Pull requests don't deploy, so you can't break production with one.

www.oleafly.com and docs.oleafly.com both redirect to the main domain (docs.oleafly.com/faq lands on oleafly.com/docs/faq).

License

MIT. The Oleafly app itself is AGPL-3.0, but this website's code is free to reuse however you like.

About

The web home of Oleafly, the free, open-source, local-first LaTeX studio for Mac, Windows, and Linux.

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages