Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "tailwind-plus-icpay",
"version": "1.2.22",
"version": "1.2.23",
"private": true,
"packageManager": "pnpm@9.12.3",
"scripts": {
Expand Down
54 changes: 31 additions & 23 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,46 @@
# ICPay Docs
# icpay

The official documentation site for ICPay (Next.js + MDX).

- Live: https://docs.icpay.org
- Repos: SDK — https://github.com/icpay/icpay-sdk · Widgets — https://github.com/icpay/icpay-widget
icpay is a [Tailwind Plus](https://tailwindcss.com/plus) site template built using [Tailwind CSS](https://tailwindcss.com) and [Next.js](https://nextjs.org).

## Getting started

To get started with this template, first install the npm dependencies:

```bash
pnpm install
pnpm dev # runs Next.js on http://localhost:6204
npm install
```

Build & run:
Next, run the development server:

```bash
pnpm build
pnpm start # serves production build on port 6204
npm run dev
```

## Project structure
Finally, open [http://localhost:3000](http://localhost:3000) in your browser to view the website.

## Customizing

You can start editing this template by modifying the files in the `/src` folder. The site will auto-update as you edit these files.

## Global search

This template includes a global search that's powered by the [FlexSearch](https://github.com/nextapps-de/flexsearch) library. It's available by clicking the search input or by using the `⌘K` shortcut.

This feature requires no configuration, and works out of the box by automatically scanning your documentation pages to build its index. You can adjust the search parameters by editing the `/src/mdx/search.mjs` file.

- `src/app/*` — MDX/TSX routes (e.g. `sdk`, `widget`, `webhooks`, `x402`, `ledgers`)
- `src/app/widget/components/*` — per‑component docs (pay‑button, amount‑input, etc.)
- `src/components/*` — UI components for the docs site
- `src/styles/tailwind.css` — site styles
- `src/mdx/*` — MDX/remark/rehype pipeline and search config
## License

## Authoring content
This site template is a commercial product and is licensed under the [Tailwind Plus license](https://tailwindcss.com/plus/license).

- Pages are MDX (`page.mdx`) or TSX (`page.tsx`) under `src/app/...`
- Use fenced code blocks and the built-in `<Code>` component for code samples
- Navigation is derived from route structure; keep paths descriptive
## Learn more

## Contributing
To learn more about the technologies used in this site template, see the following resources:

- Use `pnpm lint` before submitting changes
- Open issues/PRs in this repo for docs changes
- [Tailwind CSS](https://tailwindcss.com/docs) - the official Tailwind CSS documentation
- [Next.js](https://nextjs.org/docs) - the official Next.js documentation
- [Headless UI](https://headlessui.dev) - the official Headless UI documentation
- [Framer Motion](https://www.framer.com/docs/) - the official Framer Motion documentation
- [MDX](https://mdxjs.com/) - the official MDX documentation
- [Algolia Autocomplete](https://www.algolia.com/doc/ui-libraries/autocomplete/introduction/what-is-autocomplete/) - the official Algolia Autocomplete documentation
- [FlexSearch](https://github.com/nextapps-de/flexsearch) - the official FlexSearch documentation
- [Zustand](https://docs.pmnd.rs/zustand/getting-started/introduction) - the official Zustand documentation