Skip to content

Latest commit

 

History

History
38 lines (34 loc) · 1.04 KB

trips_file_format.md

File metadata and controls

38 lines (34 loc) · 1.04 KB

Trips file format

The trips data should be provided in a TOML file with each trip represented by a [[trips]] section with the following structure:

[[trips]]
year = 2222 # year of the trip
description = "<description of the trip>" # optional
travel_companions = ["<name of travel companion 1>", "<name of travel companion 2>", "..."] # optional
[[trips.countries]]
name = "<name of visited country>"
[[trips.countries.cities]]
name = "<name of visited city in the country>"
[[trips.countries.cities]]
name = "<name of another visited city in the country>"

Within each trip, you can specify multiple visited countries and within each country, you can specify multiple visited cities.

Here's an example:

[[trips]]
year = 2222
description = "Summer vacation"
travel_companions = ["Bob"]
[[trips.countries]]
name = "Germany"
[[trips.countries.cities]]
name = "Hamburg"
[[trips.countries.cities]]
name = "Berlin"
[[trips.countries]]
name = "France"
[[trips.countries.cities]]
name = "Paris"
[[trips.countries.cities]]
name = "Lyon"