Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 15 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,18 +37,6 @@ Lingui is an easy yet powerful internationalization (i18n) framework for global

- **Compatible with react-intl** - Low-level React API is very similar to react-intl and the message format is the same. It's easy to migrate an existing project.

## Quickstart

1. [Introduction](https://lingui.dev/introduction)
2. [Installation and Setup](https://lingui.dev/installation)

### Tutorials

- [React](https://lingui.dev/tutorials/react)
- [React Server Components](https://lingui.dev/tutorials/react-rsc)
- [React Native](https://lingui.dev/tutorials/react-native)
- [JavaScript](https://lingui.dev/tutorials/javascript)

## Example

Short example how i18n looks with JSX:
Expand Down Expand Up @@ -87,6 +75,15 @@ If you are having issues, please let us know.
- If something doesn't work as documented, documentation is missing or if you just want to suggest a new feature, [create an issue][Issues].
- You can also [Ask Lingui JS Guru](https://gurubase.io/g/lingui-js), it is a Lingui JS focused AI to answer your questions.

## Docs for LLMs

For developers working with AI and language models, we provide specialized documentation files following the [llms.txt specification](https://llmstxt.org/):

- [llms.txt](https://lingui.dev/llms.txt) - Concise documentation optimized for LLM context windows
- [llms-full.txt](https://lingui.dev/llms-full.txt) - Comprehensive documentation including all referenced URLs

These files provide LLM-friendly content in a standardized format, helping language models understand and work with Lingui's documentation at inference time. The format is designed to be both human and LLM readable, with structured information that can be processed programmatically.

## Contribute

Contribution to open-source project is everything from spreading the word, writing documentation to implement features and fixing bugs.
Expand All @@ -104,6 +101,12 @@ This project exists thanks to [all the people][Contributors] who contribute. [[C

The project is licensed under the [MIT][License] license.

<div align="center">
<a href="https://crowdin.com/?utm_source=lingui.dev&utm_medium=referral&utm_campaign=lingui.dev" target="_blank">
<img width="350" src="website/static/partner.svg" alt="Crowdin logo">
</a>
</div>

[Documentation]: https://lingui.dev
[Examples]: https://github.com/lingui/js-lingui/tree/main/examples
[Badge-MainSuite-GithubCI]: https://github.com/lingui/js-lingui/workflows/main-suite/badge.svg
Expand Down
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,7 @@
"packages/*",
"test/*"
],
"homepage": "https://lingui.dev",
"repository": {
"type": "git",
"url": "git+https://github.com/lingui/js-lingui.git"
Expand Down
1 change: 1 addition & 0 deletions packages/babel-plugin-extract-messages/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@
"README.md",
"dist/"
],
"homepage": "https://lingui.dev",
"repository": {
"type": "git",
"url": "git+https://github.com/lingui/js-lingui.git",
Expand Down
1 change: 1 addition & 0 deletions packages/babel-plugin-lingui-macro/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,7 @@
"README.md",
"dist/"
],
"homepage": "https://lingui.dev",
"repository": {
"type": "git",
"url": "git+https://github.com/lingui/js-lingui.git",
Expand Down
1 change: 1 addition & 0 deletions packages/cli/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
"translation",
"multilingual"
],
"homepage": "https://lingui.dev",
"repository": {
"type": "git",
"url": "git+https://github.com/lingui/js-lingui.git",
Expand Down
1 change: 1 addition & 0 deletions packages/conf/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
"lingui",
"config"
],
"homepage": "https://lingui.dev",
"repository": {
"type": "git",
"url": "git+https://github.com/lingui/js-lingui.git",
Expand Down
1 change: 1 addition & 0 deletions packages/core/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
"build": "unbuild",
"stub": "unbuild --stub"
},
"homepage": "https://lingui.dev",
"repository": {
"type": "git",
"url": "git+https://github.com/lingui/js-lingui.git",
Expand Down
1 change: 1 addition & 0 deletions packages/detect-locale/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
"name": "Sergio Moreno",
"email": "sergiomorenoalbert@gmail.com"
},
"homepage": "https://lingui.dev",
"repository": {
"type": "git",
"url": "git+https://github.com/lingui/js-lingui.git",
Expand Down
1 change: 1 addition & 0 deletions packages/extractor-vue/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
"multilingual",
"lingui-extractor"
],
"homepage": "https://lingui.dev",
"repository": {
"type": "git",
"url": "git+https://github.com/lingui/js-lingui.git",
Expand Down
1 change: 1 addition & 0 deletions packages/format-csv/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
"build": "rimraf ./dist && unbuild",
"stub": "unbuild --stub"
},
"homepage": "https://lingui.dev",
"repository": {
"type": "git",
"url": "git+https://github.com/lingui/js-lingui.git",
Expand Down
1 change: 1 addition & 0 deletions packages/format-json/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
"build": "rimraf ./dist && unbuild",
"stub": "unbuild --stub"
},
"homepage": "https://lingui.dev",
"repository": {
"type": "git",
"url": "git+https://github.com/lingui/js-lingui.git",
Expand Down
1 change: 1 addition & 0 deletions packages/format-po-gettext/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@
"build": "rimraf ./dist && unbuild",
"stub": "unbuild --stub"
},
"homepage": "https://lingui.dev",
"repository": {
"type": "git",
"url": "git+https://github.com/lingui/js-lingui.git",
Expand Down
1 change: 1 addition & 0 deletions packages/format-po/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@
"build": "rimraf ./dist && unbuild",
"stub": "unbuild --stub"
},
"homepage": "https://lingui.dev",
"repository": {
"type": "git",
"url": "git+https://github.com/lingui/js-lingui.git",
Expand Down
1 change: 1 addition & 0 deletions packages/jest-mocks/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
"testing",
"mock"
],
"homepage": "https://lingui.dev",
"repository": {
"type": "git",
"url": "git+https://github.com/lingui/js-lingui.git",
Expand Down
1 change: 1 addition & 0 deletions packages/loader/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
"build": "rimraf ./dist && unbuild",
"stub": "unbuild --stub"
},
"homepage": "https://lingui.dev",
"repository": {
"type": "git",
"url": "git+https://github.com/lingui/js-lingui.git",
Expand Down
1 change: 1 addition & 0 deletions packages/macro/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
"translation",
"multilingual"
],
"homepage": "https://lingui.dev",
"repository": {
"type": "git",
"url": "git+https://github.com/lingui/js-lingui.git",
Expand Down
1 change: 1 addition & 0 deletions packages/message-utils/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@
"build": "rimraf ./dist && unbuild",
"stub": "unbuild --stub"
},
"homepage": "https://lingui.dev",
"repository": {
"type": "git",
"url": "git+https://github.com/lingui/js-lingui.git",
Expand Down
1 change: 1 addition & 0 deletions packages/metro-transformer/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@
"build": "rimraf ./dist && unbuild",
"stub": "unbuild --stub"
},
"homepage": "https://lingui.dev",
"repository": {
"type": "git",
"url": "git+https://github.com/lingui/js-lingui.git",
Expand Down
1 change: 1 addition & 0 deletions packages/react/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@
"build": "rimraf ./dist && unbuild",
"stub": "unbuild --stub"
},
"homepage": "https://lingui.dev",
"repository": {
"type": "git",
"url": "git+https://github.com/lingui/js-lingui.git",
Expand Down
1 change: 1 addition & 0 deletions packages/remote-loader/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
"build": "rimraf ./dist && unbuild",
"stub": "unbuild --stub"
},
"homepage": "https://lingui.dev",
"repository": {
"type": "git",
"url": "git+https://github.com/lingui/js-lingui.git",
Expand Down
1 change: 1 addition & 0 deletions packages/vite-plugin/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
"build": "rimraf ./dist && unbuild",
"stub": "unbuild --stub"
},
"homepage": "https://lingui.dev",
"repository": {
"type": "git",
"url": "git+https://github.com/lingui/js-lingui.git",
Expand Down
27 changes: 26 additions & 1 deletion website/docusaurus.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -144,6 +144,19 @@ const config: Config = {
},
],
},
{
title: "Docs for LLMs",
items: [
{
label: "llms.txt",
href: "https://lingui.dev/llms.txt",
},
{
label: "llms-full.txt",
href: "https://lingui.dev/llms-full.txt",
},
],
},
],
},
algolia: {
Expand Down Expand Up @@ -190,7 +203,19 @@ const config: Config = {
} satisfies Preset.Options,
],
],
plugins: ["docusaurus-plugin-sass"],
plugins: [
"docusaurus-plugin-sass",
[
"@signalwire/docusaurus-plugin-llms-txt",
{
content: {
enableLlmsFullTxt: true,
excludeRoutes: ["/", "/search", "/community", "/misc/*", "/releases/*"],
},
includeOrder: ["/installation", "/tutorials/**", "/guides/**", "/ref/**", "/examples/**"],
},
],
],
};

export default config;
4 changes: 3 additions & 1 deletion website/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
"swizzle": "docusaurus swizzle",
"clear": "docusaurus clear",
"serve": "docusaurus serve",
"lint": "eslint src *.js *.ts && remark . --ext md,mdx --quiet --frail --rc-path .remarkrc.mjs",
"lint": "eslint src *.js *.ts && remark . --ext md,mdx --quiet --frail --rc-path .remarkrc.mjs --ignore-path .gitignore",
"lintFix": "eslint --fix src *.js *.ts",
"checkFormat": "prettier --check .",
"fixFormat": "prettier --write ."
Expand All @@ -20,8 +20,10 @@
"@docusaurus/remark-plugin-npm2yarn": "3.6.3",
"@docusaurus/theme-mermaid": "3.6.3",
"@mdx-js/react": "3.1.0",
"@signalwire/docusaurus-plugin-llms-txt": "^1.2.2",
"clsx": "2.1.1",
"docusaurus-plugin-sass": "^0.2.6",
"prism-react-renderer": "^2.4.1",
"react": "19.0.0",
"react-dom": "19.0.0",
"sass": "^1.83.0"
Expand Down
1 change: 1 addition & 0 deletions website/static/partner.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Loading