From 2b38a7b10cd1799e39ef34ec8f15d283d16d3968 Mon Sep 17 00:00:00 2001 From: Kristijan Date: Tue, 23 Dec 2025 12:30:52 +0100 Subject: [PATCH] Version 1.2.23 - 2025-12-23 12:30:52 --- package.json | 2 +- readme.md | 54 ++++++++++++++++++++++++++++++---------------------- 2 files changed, 32 insertions(+), 24 deletions(-) diff --git a/package.json b/package.json index e394608..d3988ba 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "tailwind-plus-icpay", - "version": "1.2.22", + "version": "1.2.23", "private": true, "packageManager": "pnpm@9.12.3", "scripts": { diff --git a/readme.md b/readme.md index a54ddf1..cb7e58d 100644 --- a/readme.md +++ b/readme.md @@ -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 `` 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