Skip to content
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

Support for Multilingual Documentation in dartdoc #3997

Open
naghinezhad opened this issue Feb 13, 2025 · 1 comment
Open

Support for Multilingual Documentation in dartdoc #3997

naghinezhad opened this issue Feb 13, 2025 · 1 comment
Labels
P3 A lower priority bug or feature request type-enhancement A request for a change that isn't a bug

Comments

@naghinezhad
Copy link

Feature Request: Multilingual Documentation Support

I would like to request a feature that enables multilingual support for documentation generated by dartdoc. Currently, dartdoc generates documentation in a single language, but many developers work on projects that require support for multiple languages.

Use Case:
For example, I have a Dart project where the primary documentation is in English, but I want to provide translations in Persian (Farsi) and other languages for a broader audience.

Suggested Implementation:

  1. Adding support for localization files (such as .arb, .json, or other formats) to store translated strings.
  2. Providing an option in dartdoc_options.yaml to specify available languages.
  3. Generating language-specific documentation in separate folders (e.g., docs/en/, docs/fa/).
  4. Including a language switcher in the generated HTML output.

This feature would greatly enhance the usability of dartdoc for international projects.
Would this be possible to implement? I appreciate any feedback on this idea!

@srawlins
Copy link
Member

This would be possible to implement, but would be a large effort.

@srawlins srawlins added P3 A lower priority bug or feature request type-enhancement A request for a change that isn't a bug labels Feb 13, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
P3 A lower priority bug or feature request type-enhancement A request for a change that isn't a bug
Projects
None yet
Development

No branches or pull requests

2 participants