https://github.com/orienteerfeed/ofeed-docs
Official OFeed documentation
https://github.com/orienteerfeed/ofeed-docs
docs documentation
Last synced: 4 months ago
JSON representation
Official OFeed documentation
- Host: GitHub
- URL: https://github.com/orienteerfeed/ofeed-docs
- Owner: orienteerfeed
- Created: 2024-10-23T20:53:35.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2026-02-05T10:27:29.000Z (5 months ago)
- Last Synced: 2026-02-05T21:58:57.816Z (5 months ago)
- Topics: docs, documentation
- Language: TypeScript
- Homepage: https://docs.orienteerfeed.com/
- Size: 8.15 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yaml
Awesome Lists containing this project
README
# About
Official documentation for the `OFeed` platform, which includes an introduction to basic concepts and tutorials of the main features.
# Join our Discord server
Become part of our community by clicking the link! We're excited to have you with us. Feel free to ask for help or share your experiences.
[](https://discord.gg/QMvnurgKzU)
# List of events that used OFeed
- 18.10.2025 [Oblastní žebříček (KAM)](https://orienteerfeed.com/events/cmg4t3f0i0007my3m5hh50wl2) - MRB + OChecklist integration
- 11.10.2025 [Východočeský pohár (CHC)](https://orienteerfeed.com/events/cmgkvtqvt000rmy3mh3j4mjer) - MRB + OChecklist integration
- 29.06.2025 [Veteraniáda ČR na krátké trati (SHK)](https://orienteerfeed.com/events/cmcg4c97z0001qz3k2mvgg20t) - just MRB
- 28.06.2025 [Veteraniáda ČR na klasické trati, oblastní žebříček (SHK)](https://orienteerfeed.com/events/cmcg25zom000fqz3ow8sfy0o5) - just MRB
- 18.05.2025 [Oblastní žebříček (KAM)](https://orienteerfeed.com/events/cmanymbnb0007qq3e8zg7lny0) - MRB + OChecklist integration
- 18.05.2025 [Grant Thornton Mistrovství ČR sprintových štafet (KAM)](https://orienteerfeed.com/events/cmanykesl0004qq3eqbouls6q) - just MRB
- 17.05.2025 [Grant Thornton Mistrovství ČR ve sprintu (KAM)](https://orienteerfeed.com/events/cmanygkd60001qq3e5y5hqndm) - MRB + OChecklist integration
## Installation
```bash
pnpm install
```
## Local Development
```bash
pnpm start
```
This command starts a local development server and opens up a browser window in **default language** without other translations. Most changes are reflected live without having to restart the server.
### Locale
```bash
$ pnpm start -- --locale cs
```
Run another language, e.g. `cs`
**Warning**
Each locale is a **distinct standalone single-page application**: it is not possible to start the Docusaurus sites in **all locales** at the same time.
#### Extract strings for translation
```bash
pnpm run write-translations -- --locale cs
```
Scans the site for translatable strings (e.g., in docs, blog, UI labels). Writes them into JSON files under the i18n//docusaurus-plugin-content-docs/current.json and similar paths.
## Build
```bash
pnpm build
```
This command generates static content into the `build` directory and can be served using any static contents hosting service.
### Testing your Build Locally
It is important to test your build locally before deploying it for production.
```bash
pnpm run serve
```
## Deployment
Using SSH:
```bash
USE_SSH=true pnpm deploy
```
Not using SSH:
```bash
GIT_USER= pnpm deploy
```
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.