https://github.com/crowdin/docs
Crowdin Knowledge Base and Dev Portal
https://github.com/crowdin/docs
crowdin docs hacktoberfest knowledge-base
Last synced: 5 months ago
JSON representation
Crowdin Knowledge Base and Dev Portal
- Host: GitHub
- URL: https://github.com/crowdin/docs
- Owner: crowdin
- License: cc-by-4.0
- Created: 2024-06-29T09:56:55.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-04-25T12:01:38.000Z (5 months ago)
- Last Synced: 2025-04-25T12:29:55.045Z (5 months ago)
- Topics: crowdin, docs, hacktoberfest, knowledge-base
- Language: MDX
- Homepage: https://support.crowdin.com
- Size: 98.9 MB
- Stars: 5
- Watchers: 4
- Forks: 51
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# Crowdin Docs
This repository contains the website code and Markdown articles for [Crowdin Docs](https://support.crowdin.com).
If you would like to contribute to the documentation, please read the [Contribution Guidelines](CONTRIBUTING.md).
## Getting Started
Clone the repository and install the dependencies:
```console
git clone git@github.com:crowdin/docs.git
cd docs
npm install
```
Run the development server:
```console
npm run dev
```
Open your browser and navigate to http://localhost:4321.
> **Note!**
> - Make sure you have Node.js v20 or higher installed on your machine.
> - This project uses the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification for commit messages and PR titles.
### Project Structure
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.
### Commands
All commands are run from the root of the project, from a terminal:
| Command | Action |
|:--------------------------|:-------------------------------------------------|
| `npm install` | Installs dependencies |
| `npm run dev` | Starts local dev server at `localhost:4321` |
| `npm run build` | Build your production site to `./dist/` |
| `npm run preview` | Preview your build locally, before deploying |
| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` |
| `npm run astro -- --help` | Get help using the Astro CLI |
## Learn More
This project is built with Astro and Starlight. Here are some resources to get you started:
- [Starlight’s docs](https://starlight.astro.build/)
- [Astro docs](https://docs.astro.build)
- [Tailwind CSS docs](https://tailwindcss.com/)
- [Astro Discord server](https://astro.build/chat)
[](https://starlight.astro.build)