https://github.com/playform/localize
Localize 📔
https://github.com/playform/localize
Last synced: 3 months ago
JSON representation
Localize 📔
- Host: GitHub
- URL: https://github.com/playform/localize
- Owner: PlayForm
- License: cc0-1.0
- Created: 2023-08-10T12:41:25.000Z (over 2 years ago)
- Default Branch: Current
- Last Pushed: 2025-04-02T01:42:28.000Z (about 1 year ago)
- Last Synced: 2025-04-02T02:36:02.296Z (about 1 year ago)
- Homepage: https://GitHub.Com/PlayForm/Localize
- Size: 87.9 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# 📔 [Localize]
This **[`Astro integration`][astro-integration]** allows you to translate your
components using InLang.
## Installation 🚀
There are two ways to add integrations to your project. Let's try the most
convenient option first!
### `astro add` command
Astro includes a CLI tool for adding first party integrations: `astro add`. This
command will:
1. (Optionally) Install all necessary dependencies and peer dependencies
2. (Also optionally) Update your `astro.config.*` file to apply this integration
To install `Localize`, run the following from your project directory and follow
the prompts:
Using NPM:
```sh
npx astro add inlang-astro
```
Using Yarn:
```sh
yarn astro add inlang-astro
```
Using PNPM:
```sh
pnpx astro add inlang-astro
```
### Install dependencies manually
First, install the `Localize` integration like so:
```sh
npm install -D -E inlang-astro
```
Then, apply this integration to your `astro.config.*` file using the
`integrations` property:
**`astro.config.ts`**
```ts
import inlang from "inlang-astro";
export default { integrations: [inlang()] };
```
## Getting started
#### Set `Logger` to `0` if you do not want to see debug messages. Default is `2`.
**`astro.config.ts`**
```ts
import inlang from "inlang-astro";
export default {
integrations: [
inlang({
Logger: 0,
}),
],
};
```
[Localize]: https://NPMJS.Org/inlang-astro
[astro-integration]: https://docs.astro.build/en/guides/integrations-guide/
## Changelog
See [`CHANGELOG.md`](CHANGELOG.md) for a history of changes to this integration.