Skip to content

orienteerfeed/ofeed-docs

Repository files navigation

Shows a black logo in light color mode and a white one in dark color mode.

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.

List of events that used OFeed

Installation

pnpm install

Local Development

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

$ 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

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

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.

pnpm run serve

Deployment

Using SSH:

USE_SSH=true pnpm deploy

Not using SSH:

GIT_USER=<Your GitHub username> 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.

About

Official OFeed documentation

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Sponsor this project

Packages

No packages published

Contributors 2

  •  
  •