Find a file
2026-02-17 07:06:05 +01:00
bikerouter update screenshot 2026-02-17 07:06:05 +01:00
.gitignore add and enable "privacy" plugin for local hosting of web fonts 2025-04-27 10:31:38 +02:00
README.md update README, add hint for Taskfile 2025-05-05 10:47:10 +02:00
requirements.txt add and enable "privacy" plugin for local hosting of web fonts 2025-04-27 10:31:38 +02:00
Taskfile.yml add setup task; update README 2025-04-27 10:18:47 +02:00

Bikerouter Documentation

Prerequisites

To utilize the specified task commands, ensure that Taskfile is installed and accessible in your system's PATH.

Alternatively, you can execute the commands manually. Refer to Taskfile.yml for detailed instructions.

Setup

  1. Clone repository
  2. Run setup task:
task setup

Writing Documentation

  1. Setup (see above)

  2. Create Git branch

  3. Open this directory in text editor

  4. Run development server:

    # English
    task serve
    
    # German
    task serve-de
    
  5. Live-preview documentation

  6. Commit, push and create Pull Request

  7. Thanks ❤️

Building

task build