-
Notifications
You must be signed in to change notification settings - Fork 6
Refactor top of sidebar #289
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
morsssss
wants to merge
3
commits into
main
Choose a base branch
from
sidebar
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| --- | ||
| title: "Client libraries" | ||
| public: true | ||
| --- | ||
| ## Official client libraries | ||
|
|
||
| DeepL develops and supports client libraries for six popular languages: | ||
|
|
||
| <CardGroup cols={2}> | ||
| <Card title="DeepL C# Library" horizontal href="https://www.github.com/deeplcom/deepl-dotnet"> | ||
| deeplcom\deepl-dotnet | ||
| </Card> | ||
| <Card title="DeepL Java Library" horizontal href="https://www.github.com/deeplcom/deepl-java"> | ||
| deeplcom\deepl-java | ||
| </Card> | ||
| <Card title="DeepL JavaScript Library" horizontal href="https://www.github.com/deeplcom/deepl-node"> | ||
| deeplcom\deepl-node | ||
| </Card> | ||
| <Card title="DeepL PHP Library" horizontal href="https://www.github.com/deeplcom/deepl-php"> | ||
| deeplcom\deepl-php | ||
| </Card> | ||
| <Card title="DeepL Python Library" horizontal href="https://www.github.com/deeplcom/deepl-python"> | ||
| deeplcom\deepl-python | ||
| </Card> | ||
| <Card title="DeepL Ruby Library" horizontal href="https://www.github.com/deeplcom/deepl-rb"> | ||
| deeplcom\deepl-rb | ||
| </Card> | ||
| </CardGroup> | ||
|
|
||
| Features include: | ||
|
|
||
| * Out-of-the-box retries with exponential backoff for correct handling of 429 and 500 errors | ||
| * Persistent HTTP connection (keep-alive) enabled by default | ||
| * All document translation steps (upload, check status, and download) consolidated into a single convenience function | ||
|
|
||
| All officially supported client libraries are open-source under the MIT License. We welcome feedback in the form of issues and pull requests! | ||
|
|
||
| ## Command-line interface | ||
|
|
||
| For terminal-based workflows, scripting, and CI/CD pipelines, see the [DeepL CLI](/docs/getting-started/deepl-cli). | ||
|
|
||
| ## Community-created client libraries | ||
|
|
||
| The DeepL community [maintains client libraries](https://github.com/DeepLcom/awesome-deepl?tab=readme-ov-file#community-libraries--sdks) for other languages, including [Dart](https://github.com/komape/deepl_dart), [Go](https://github.com/candy12t/go-deepl), [Rust](https://github.com/Avimitin/deepl-rs), and [Kotlin](https://github.com/SimplyMika/DeeplKt). | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,45 +1,45 @@ | ||
| --- | ||
| title: "Client libraries" | ||
| description: "Using your favorite programming language with the DeepL API" | ||
| public: true | ||
| --- | ||
| ## Official client libraries | ||
|
|
||
| DeepL develops and supports client libraries for six popular languages: | ||
| ## Overview | ||
| You can use many popular programming languages to access the DeepL API. | ||
|
|
||
| DeepL enables this through six official client libraries which handle API requests and help parse responses so you can focus on building your application. For example, [the JavaScript library's `translateDocument()` function](https://github.com/DeepLcom/deepl-node?tab=readme-ov-file#translating-documents) handles the document translation workflow - uploading a document, polling for completion, and downloading the result. | ||
|
|
||
| The client libraries are hosted on [GitHub](https://github.com/DeepLcom). This documentation frequently includes code samples in the six programming languages DeepL supports and maintains. But for complete information, setup instructions, installation steps, and code samples, see these GitHub repositories: | ||
|
|
||
| <CardGroup cols={2}> | ||
| <Card title="DeepL .NET Library" horizontal href="https://www.github.com/deeplcom/deepl-dotnet"> | ||
| <Card title="DeepL C# Library" horizontal href="https://www.github.com/deeplcom/deepl-dotnet"> | ||
| deeplcom\deepl-dotnet | ||
| </Card> | ||
| <Card title="DeepL PHP Library" horizontal href="https://www.github.com/deeplcom/deepl-php"> | ||
| deeplcom\deepl-php | ||
| <Card title="DeepL Java Library" horizontal href="https://www.github.com/deeplcom/deepl-java"> | ||
| deeplcom\deepl-java | ||
| </Card> | ||
| <Card title="DeepL Node Library" horizontal href="https://www.github.com/deeplcom/deepl-node"> | ||
| <Card title="DeepL JavaScript Library" horizontal href="https://www.github.com/deeplcom/deepl-node"> | ||
| deeplcom\deepl-node | ||
| </Card> | ||
| <Card title="DeepL PHP Library" horizontal href="https://www.github.com/deeplcom/deepl-php"> | ||
| deeplcom\deepl-php | ||
| </Card> | ||
| <Card title="DeepL Python Library" horizontal href="https://www.github.com/deeplcom/deepl-python"> | ||
| deeplcom\deepl-python | ||
| </Card> | ||
| <Card title="DeepL Ruby Library" horizontal href="https://www.github.com/deeplcom/deepl-rb"> | ||
| deeplcom\deepl-rb | ||
| </Card> | ||
| <Card title="DeepL Java Library" horizontal href="https://www.github.com/deeplcom/deepl-java"> | ||
| deeplcom\deepl-java | ||
| </Card> | ||
| </CardGroup> | ||
|
|
||
| Features include: | ||
|
|
||
| * Out-of-the-box retries with exponential backoff for correct handling of 429 and 500 errors | ||
| * Persistent HTTP connection (keep-alive) enabled by default | ||
| * All document translation steps (upload, check status, and download) consolidated into a single convenience function | ||
|
|
||
| All officially supported client libraries are open-source under the MIT License. We welcome feedback in the form of issues and pull requests! | ||
|
|
||
| ## Command-line interface | ||
|
|
||
| For terminal-based workflows, scripting, and CI/CD pipelines, see the [DeepL CLI](/docs/getting-started/deepl-cli). | ||
|
|
||
| ## Community-created client libraries | ||
|
|
||
| The DeepL community [maintains client libraries](https://github.com/DeepLcom/awesome-deepl?tab=readme-ov-file#community-libraries--sdks) for other languages, including [Dart](https://github.com/komape/deepl_dart), [Go](https://github.com/candy12t/go-deepl), [Rust](https://github.com/Avimitin/deepl-rs), and [Kotlin](https://github.com/SimplyMika/DeeplKt). | ||
|
|
||
| ## Next steps | ||
| Now that you've found your client library, here are a few ways to keep learning about the DeepL API: | ||
|
|
||
| * try sample requests [in our playground](https://developers.deepl.com/api-reference/translate/request-translation?playground=open) | ||
| * [DeepL 101](/docs/learning-how-tos/examples-and-guides/first-things-to-try-with-the-deepl-api) - a quick guide to text and document translation | ||
| * [Translation: a beginner's guide](/docs/learning-how-tos/examples-and-guides/translation-beginners-guide) - a detailed guide to fundamental translation features |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This new page is
public: truebut has nodescription, and itstitleis identical todocs/getting-started/client-libraries.mdx. In the sidebar this will likely show two indistinguishable “Client libraries” entries; consider adding adescriptionand a disambiguatingsidebarTitle/title (e.g., “Client libraries (reference)”).There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
good point Copilot...