This repository contains the website code and Markdown articles for Crowdin Docs.
If you would like to contribute to the documentation, please read the Contribution Guidelines.
This project uses Crowdin to manage translations.
Clone the repository and install the dependencies:
git clone git@github.com:crowdin/docs.git
cd docs
pnpm installRun the development server:
pnpm devOpen your browser and navigate to http://localhost:4321.
Note!
- Make sure you have Node.js v22 or higher installed on your machine.
- This project uses pnpm as the package manager. The required version is pinned via the
packageManagerfield inpackage.jsonand can be installed with Corepack (corepack enable).- This project uses the Conventional Commits specification for commit messages and PR titles.
Some important files and directories:
astro.config.mjs- Astro configuration file.src/content/docs- contains groups describing the documentation for each product.src/assets/screenshots- contains screenshots for the documentation.src/content/sidebrs- sidebar configuration for Crowdin KB, Crowdin Enterprise KB, Developer Portal.src/content/includes- reusable content blocks that can be included in the documentation.src/components- contains reusable Astro components for the documentation.src/pages- custom pages.public- static assets like favicons, images that do not need optimization, etc.
All commands are run from the root of the project, from a terminal:
| Command | Action |
|---|---|
pnpm install |
Installs dependencies |
pnpm dev |
Starts local dev server at localhost:4321 |
pnpm build |
Build your production site to ./dist/ |
pnpm preview |
Preview your build locally, before deploying |
pnpm astro ... |
Run CLI commands like astro add, astro check |
pnpm astro -- --help |
Get help using the Astro CLI |
This project is built with Astro and Starlight. Here are some resources to get you started:
