Skip to content

Repository files navigation

travel.skill

Turn your travel materials into a personal, shareable travel website.

Walkthrough on a phone: home, daily plan, place map, flights, checklist

Bookings, screenshots, notes, links → one page you open on your phone during the trip and send to the people you travel with. Live examples: https://clarkchenkai.github.io/travel.skill/

  • The template is a dependency-free static site (plain HTML, CSS, JavaScript): Home, Map, Days, Transport, Checklist; three themes; mobile and desktop layouts; reads cached content offline after a successful first cache (online maps still require a network); prints as a paper roadbook; share cards for chat apps.
  • Five skills cover travel management, product production, AI design, template extension and verification. They provide the procedure a coding agent (Claude Code, Codex CLI, anything that reads AGENTS.md) follows to read your materials, find what is missing, fill one data file, preview, and check before you publish. It never invents facts.

No account, no database, no paid service. Node.js 20+ is the only requirement, and the examples run without any AI.

中文说明 →

The real Kumano roadbook

Watch the 45-second walkthrough · Open the full roadbook

The paper-inspired gallery puts the author’s custom trip first, with a real screen recording of the opening scene, map, daily plan and transport. The four fictional trips below demonstrate the lighter starter template.

Three ways to start

1. Use this template on GitHub (nothing to install). Click Use this template → create your repository → Settings → Pages → Source: GitHub Actions. The included workflow publishes a starter roadbook at https://<you>.github.io/<repo>/ after Pages is enabled and the workflow succeeds. Then edit trip/travel-data.json in the browser or locally; every push redeploys.

2. Run locally.

git clone https://github.com/clarkchenkai/travel.skill && cd travel.skill
npm run new -- europe-rail     # copy an example into trip/
npm run dev                    # http://localhost:4173/

3. With a coding agent. Put your materials in input/, open the repo in Claude Code or Codex, and paste:

Build my travel roadbook with the travel skill.
Materials are in input/. Destination: <where>. Dates: <when>. Travelers: <who>.
Read the materials, fill trip/travel-data.json, then run the gap report and ask me the open questions in one batch.
Do not invent times, prices or booking status.

Answer the gap list, look at the preview, ask for changes. When you are ready: npm run build && npm run check, then publish dist/ anywhere static (docs/PUBLISHING.md).

Download the full repository, Codex, Claude Code or generic-agent workspace, extract it and open its root. See AGENT-PACKS.md.

What it looks like

Four fictional examples ship with the repo. Nothing in them is booked; they exist to show the range.

japan-hiking · theme field-notes · zh-CN europe-rail · theme timetable · en family-island · theme tide · en
Kiso Valley example, desktop home Four cities by rail, desktop home Mallorca family example, desktop home
mobile days page mobile transport page mobile days page

Also included: business-trip, a five-day London trip with an agenda, currency-separated expenses and receipt tracking. Its independent page module demonstrates how to generate new functionality.

Five-day valley walk; an eight-day rail loop that crosses the end of European summer time; a one-week family trip with a rental car. Different moods, same data shape. All photos are AI-generated for the fictional trips (GPT Image 2 via Lovart); see each example's ASSETS.md and docs/VISUALS.md.

Generate a template and new functionality

Use npm run new -- --blank to start with unknown facts, npm run new -- --from <existing-trip> to reuse a trip, and npm run template -- --trip trip for an editable renderer. An agent can add pages, modules and language packs, then validate the build and real browser behavior. See EXTENDING.md.

What is in the box

skills/         canonical content for the five skills
.agents/skills/ Codex discovery; .claude/skills/ for Claude Code
skill/          compatibility entrypoint and historical references
evals/          behavior scenarios, review guide and execution evidence
template/       the site: index.html, styles.css, themes.css, app.js, core.mjs, i18n/
examples/       four fictional trips
scripts/        new · dev · validate · gaps · build · check · preview · template · bundle · site · shot · check:offline (Node only, no deps)
test/           node:test suites (npm test)
docs/           data reference, quick start, publishing, verification, visuals, demo recording
site/           the examples gallery page (built by npm run site, deployed by pages-demo.yml)
showcase/       the complete real Kumano Kodō 2026 roadbook this project grew out of (React + Three.js)
trip/           your trip (created by npm run new)
input/          your raw materials (git-ignored)

What is tested, and how far that goes

npm test covers time zones, linked rental handovers, data/privacy checks, dynamic templates, modules, downloadable workspaces and offline cache isolation. All four examples have browser checks at phone, tablet and desktop widths; the gallery has a real deployment record. An independent agent also generated a new page and language pack, followed by browser interaction checks. Full physical-phone touch acceptance and first-time traveler adoption remain open. See docs/VERIFICATION.md.

The stage-one goal of this project is simple: ten strangers finish their first roadbook without asking the author for help. If you try, tell us how it went with the "first roadbook" issue template — especially where you got stuck.

Privacy

dist/travel-data.json is public once you publish it. The validator and the release audit reject booking references, passport-like fields, tokens and local machine paths, but they cannot read your free text for you. Before publishing, read your own data file once. Original materials in input/ are never copied into the build.

Contributing

Themes, country/region adaptations, modules and test cases are the four contribution tracks. See CONTRIBUTING.md. Issue templates cover first-roadbook reports, bugs, theme proposals and country adaptations.

Origins and license

The template descends from a self-hosted roadbook built for one real trip: the complete site, data and design notes are in showcase/kumano-kodo, and a fictional-data cut of it was published earlier as kumano-roadbook-template. This repository rewrites it as a dependency-free, theme-neutral template, ports its motion layer, and adds the agent skill condensed from the working notes of that build.

MIT. See LICENSE. Example data is fictional; place names are public landmarks used only to show the map feature.

About

Turn your travel materials into a personal, shareable travel website. Agent skill + dependency-free template.

Topics

Resources

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages