Payment Pointers

This is the source code for the website hosted at paymentpointers.org. It is built with Starlight, a documentation framework based on Astro. The RFC for payment pointers can be found here.

Contributing

Please read the contribution guidelines before submitting contributions. All contributions must adhere to our code of conduct.

🚀 Project Structure

Inside this project, you'll see the following folders and files:

.
├── public/
├── src/
│   ├── components/
│   ├── content/
│   │   ├── docs/
│   │   └── config.ts
│   └── env.d.ts
├── astro.config.mjs
├── package.json
└── tsconfig.json

Starlight looks for .md or .mdx files in the src/content/docs/ directory. Each file is exposed as a route based on its file name.

Static assets, like favicons or images, can be placed in the public/ directory. When referencing these assets in your markdown, you do not have to include public/ in the file path, so an image would have a path like:

![A lovely description of your beautiful image](/img/YOUR_BEAUTIFUL_IMAGE.png)

Local development

We are using Bun in this repository, but you could theoretically use the package manager of your choice. To install Bun, run

curl -fsSL https://bun.sh/install | bash

🧞 Commands

All commands are run from the root of the project, from a terminal:

Command	Action
`bun install`	Installs dependencies
`bun run start`	Starts local dev server at `localhost:1102`
`bun run build`	Build your production site to `./dist/`
`bun run preview`	Preview your build locally, before deploying
`bun run astro ...`	Run CLI commands like `astro add`, `astro check`
`bun run astro -- --help`	Get help using the Astro CLI

You can substitute the bun commands with whatever package manager of your choice uses.

👀 Want to learn more?

Check out Starlight’s docs, read the Astro documentation, or jump into the Astro Discord server.

interledger / paymentpointers.org