Repository files navigation

This is the source code for the website hosted atwebmonetization.org.

The website is the home of the proposed Web Monetization standard currently incubating at theWICG.

You can read thedocs, or read the proposedspecification.

The Web Monetization website is built withStarlight, a documentation framework based onAstro.

• Get Set Up
• Content
• Localization/Internationalization
• Reviews and Approvals

We useBun in this repository, but you could theoretically use the package manager of your choice.

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

cd webmonetizationbun install

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

You can substitute the bun commands with your chosen package manager's commands.

Please refer to theCONTRIBUTING.md.

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

⭐ We recommend using the.mdx extension whenever possible.

• Static image assets
• Components
• Edit existing doc
• Add a new doc
• Add a custom page

Static image assets should be placed in thepublic/img/docs directory. When referencing these assets in the Markdown, don't includepublic/ in the file path. For example:

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

⭐ Make your image accessible by including helpful alt text that describes the image.⭐ Ensure your file name is descriptive. A file name ofimg01.png isn't helpful.⭐ Use hyphens instead of underscores in file names to keep our naming conventions consistent.

Some of the commonly repeated patterns within the documentation pages are extracted into custom doc components that can be reused. Some components are shared across other Interledger-related documentation sites and others are specific to Web Monetization. Whether a component is shared determines its import path.

TheBrowserCompat andSpecification components are specific to Web Monetization.

• BrowserCompat generates a compatibility table based on the browser compatibility data passed into it. Additional information can be foundhere.
• Specification displays a link to the relevant section of the Web Monetization specification in a table. Additional information can be foundhere.

Documentation on how to import and use shared components is available onhttps://interledger.tech/. If you are using multiple shared components on the same page, you can import them like so:

import{CodeBlock,LinkOut}from'@interledger/docs-design-system'

Navigate to/src/content/docs and locate the page you want to edit. For example:

/src/content/docs/RELEVANT_FOLDER/doc-to-be-edited.mdx

---title:This Doc Needs To Be Edited---Edit me...

Refer to the Starlight documentation onauthoring content for more detailed guidance.

Create your Markdown file in in/src/content/docs/RELEVANT_FOLDER. For example, within/src/content/docs/RELEVANT_FOLDER/newly-created-doc.mdx.

⭐ We recommend using the.mdx extension whenever possible.

If you need help with authoring content, we suggest you refer to theStarlight documentation for more detailed guidance.

Be sure to add your new doc to the sidebar! The sidebar is configured inastro.config.mjs. Refer to the Starlight documentation onsidebar configuration for more information.

Astro is a content-focused web framework that integrates with a lot of existing framework libraries, making it relatively flexible for building customised sites.

Custom pages exist in the/src/pages directory, and out-of-the-box come with absolutely nothing. For the Web Monetization website, we have created custom layout components that form the frame of a basic HTML web page, and allow you to add content that would populate themain element of the page via a concept known asslots. A<slot /> allows you to specify where individual page content should be injected.

---importi18next,{ t, changeLanguage}from"i18next";importBasefrom'../layouts/Base.astro';---<Base>  /* Page content goes here */</Base>

Refer to the Astro documentation onpages for additional details.

Starlight supportsInternationalization (i18n) out-of-the-box. The Web Monetization site follows the root locale pattern documented athttps://starlight.astro.build/guides/i18n/#use-a-root-locale.

If you want to contribute documentation in a language that has not been configured, you must editastro.config.mjs to add the language to thelocales option. As of January 2024, Web Monetization is configured for English (en) and Español (es).

Translated content should be in its respective language folder within/src/content/docs/. English content is located within/src/content/docs. Content in Español is located withinsrc/content/docs/es. Create the language folder if it doesn't exist.

The file path should follow its corresponding source English path exactly. Once a new language is "activated", translated content should be accessible via the language select drop-down in the documentation site's header.

If an English source page does not have corresponding translations in the selected language, a note will appear at the top of the page informing the user that the page has not been translated yet.

After a translation is provided, it must be reviewed by an additional contributor to ensure it's free from typos and that the content is accurate and complete. We won't approve a localization PR that hasn't been reviewed. In some cases, it may take some time to find a reviewer.

After a PR is submitted, it will be reviewed by a member of the Web Incubator Community Group (WICG). Ensure you're able to receive GitHub notifications so you'll know when the PR is approved and can be merged or if updates are required before approval is given.

Our catchup calls are open to our community. We have them every other Thursday at 14:00 GMT, via Google Meet.

To join the video meeting, click this link:https://meet.google.com/fjy-vjef-ogjOtherwise, to join by phone, dial +49 30 300195060 and enter this PIN: 982 511 322 1488#To view more phone numbers, click this link:https://tel.meet/fjy-vjef-ogj?hs=5

Video call link:https://meet.google.com/fjy-vjef-ogj

Or dial: (DE) 49 30 300195060 and enter this PIN: 982 511 322 1488#

More phone numbers:https://tel.meet/fjy-vjef-ogj?hs=5

Add to Google Calendar