m/cup
1
0
Fork 0
mirror of https://github.com/sergi0g/cup.git synced 2025-11-08 05:03:49 -05:00
Code Wiki Activity
Files
nightly
cup/docs
History
makonde-on-git 6ab06db5cb feat: allow usage without a daemon (#142)
2025-10-14 18:05:11 +03:00
..
public
V3
2025-02-28 20:43:49 +02:00
src
feat: allow usage without a daemon (#142)
2025-10-14 18:05:11 +03:00
.prettierignore
V3
2025-02-28 20:43:49 +02:00
.prettierrc
V3
2025-02-28 20:43:49 +02:00
bun.lock
refactor: remove node and use only bun (#101)
2025-04-26 13:13:30 +03:00
eslint.config.mjs
V3
2025-02-28 20:43:49 +02:00
next-env.d.ts
V3
2025-02-28 20:43:49 +02:00
next.config.ts
V3
2025-02-28 20:43:49 +02:00
package.json
refactor: remove node and use only bun (#101)
2025-04-26 13:13:30 +03:00
postcss.config.mjs
V3
2025-02-28 20:43:49 +02:00
README.md
V3
2025-02-28 20:43:49 +02:00
tsconfig.json
V3
2025-02-28 20:43:49 +02:00

README.md

Cup Documentation

Architecture

The docs are built with Nextra. We use Bun as a package manager and Node.js as a runtime (Next.js and Bun don't play well together at the moment). Docs pages are written in MDX and any custom components are written in TypeScript with TSX.

Development

Prerequisites:

  • A recent Node.js version (22 recommended)
  • Bun
git clone https://github.com/sergi0g/cup
cd cup/docs
bun install

You're ready to go!

Scripts

The available scripts are:

  • bun dev starts the development server. Note that making changes to MDX pages will probably require a full reload.
  • bun run build creates a static production build, ready to be deployed.
  • bun lint checks for errors in your code.
  • bun fmt formats your code with Prettier, so it becomes... prettier.

Contributing

Our documentation is always evolving, so, we constantly need to update this repository with new guides and configuration options. If you have any ideas of a guide or suggestions on how to improve them, feel free to open a pull request or create an issue. All contributions are welcome!

License

The documentation is licensed under the MIT License. TL;DR — You are free to use, copy, modify, merge, publish, distribute, sublicense, and sell copies of the software. However, the software is provided "as is," without warranty of any kind. You must include the original license in all copies or substantial portions of the software.