--- theme: synthwave title: PathMX — A local-first framework for interactive websites description: Build fast, interactive websites from readable files. PathMX keeps people and agents working from the same source and grows through plugins. --- [@layout.default]: ./layouts/site.layout.md [@map Documentation types]: ./docs/docs.map.md [@previews]: ./examples/previews/preview.components.md [@styles]: ./home.css
# Build interactive web experiences using eXecutable markdown.

PathMX is a methodology and web framework built for humans and agents. Use markdown files with normal web technologies to build rich interactive experiences.

Get started See what it can do
## Start with a folder.
With [Bun 1.4+ installed](./docs/start/install.guide.md), run: ```sh bunx @pathmx/core@beta init my-site cd my-site bun run dev ``` Open [localhost:3000](http://localhost:3000), edit `paths/index.md`, and save. Your site updates as you work. [Follow the quickstart](./docs/start/first-site.guide.md) for the complete walkthrough.
Give your agent a starting point: ```text Read https://docs.pathmx.dev/docs/agents/index.md and help me build a PathMX site. ``` Add what you'd like to build. The guide helps your agent get started and find the right docs. [Explore the agent guide](./docs/agents/index.md)
---
## One framework, many kinds of experience. Use markdown files + HTML to build a documentation site, a browsable collection, an interactive lesson, or a full custom application.

Explore a collection

Turn a folder of typed, linked notes into a site people can browse.

Build a custom interface

Mix explanations with domain components, actions, and persistent state.

Guide an experience

Read, focus, and present the same material with the optional Player Plugin.
---
## Your source stays the source. PathMX is built with the [file-over-app](https://stephango.com/file-over-app) philosophy. Your content and UX are authored as plain text files and are readable, local, and authorable by humans and agents alike.
Explore the methodology PathMX for agents
### Local-first Markdown files in a folder are all you need to use PathMX. The server runs offline and stays that way until you want to publish. ### Fast and live Built for speed. By default we use Bun's extremely fast runtime and markdown parsing. Content changes are live and hot reloaded automatically. ### Plugin-based A small core powers robust features through plugins. The [plugin system](./docs/extend/plugins.guide.md) allows PathMX to extend to practically any domain.
---
## Shaped by real-world teaching and learning. PathMX began as a way to create diffrentiated and personalized curriculum in a normal classroom setting and has been deployed to several different unique, personalized learning experiences inside and outside acadamia. See [“Toward True Differentiated Instruction with PathMX and Curriculum as Code”](https://dl.acm.org/doi/10.5555/3820586.3820601) for a published study on the methodology in a real-world CS classroom.
Read the methodology Read the paper