Cloudsmith Docs

The documentation of Cloudsmith.

Getting Started

If you are first getting started, please read the following guide:

• Getting Started

Then refer to the following guides on how to manage the content of the website:

• Writing markdown
• Using snippets
• Editing menus
• OopenAPI Schemas

Getting started

Make sure you’re running Node version 22.11.0 (LTS). Then install the dependencies.

npm i

Next run the desired task

# Starts app and components in dev mode
npm run dev

# Build the app
npm run build

# Build the app
npm run start

# Linting everything
npm run lint

# Linting JS
npm run lint:js

# Linting CSS
npm run lint:css

# Linting CSS and fixing
npm run lint:css:fix

# Download API schemas. Used in development mode to minimize the amount of requests to the API
npm run schema

Note

Only development mode is using Turbopack atm. This will change in the future when Turbopack supports build process. Be aware that Turbopack is the successor of Webpack meaning it's not 1:1 compatible.

Tooling

• Turbopack

Framework

• React 19

App

• Next.js 15 using App Router

General tooling

• Typescript
• ESLint
• Stylelint
• Prettier

License

The Cloudsmith product documentation in the src/content folder and subfolders are licensed under a CC-BY license.

All other code in this repository is licensed under the MIT license.