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

Does this package support multiple languages? (in development) #69

Closed
DeBelserArne opened this issue Dec 20, 2018 · 16 comments
Closed

Does this package support multiple languages? (in development) #69

DeBelserArne opened this issue Dec 20, 2018 · 16 comments
Labels
enhancement New feature or request

Comments

@DeBelserArne
Copy link

Is your feature request related to a problem? Please describe.
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
It's more a question then a feature request, but I had to choose and I'm definitely not reporting a bug.

Describe the solution you'd like
A clear and concise description of what you want to happen.
I was wondering if it's possible to supply docs in multiple languages.

Additional context
Add any other context or screenshots about the feature request here.
I use this package for localization.
https://github.com/mcamara/laravel-localization
And this works with the following syntax
__('String to translate')

But I'm not sure if this will work in the .md files.

@saleem-hadad
Copy link
Owner

Hi @Afluxx , thanks for your concern, actually, there is a plan for implementing this feature hopefully in the next major version next month 👍
I'll leave this issue open.

@rayoplateado
Copy link

Hi! Any news on this?

@DeBelserArne
Copy link
Author

@saleem-hadad looking forward to this update!

@saleem-hadad
Copy link
Owner

I'm currently working with my team on a private project, once I finish I'll come back developing this for sure hopefully within two weeks will be ready @Afluxx @rayoplateado

@saleem-hadad
Copy link
Owner

also, I'm working on two things for this package:

  1. build-in search (almost done, need UI only)
  2. convert to Tailwind CSS

@ablishek
Copy link

ablishek commented Feb 1, 2019

This isn't directly related to the question, but in case some one else wants to know:

I am developing a SAAS application and as such, version's aren't that important (since there is only one version of the app on the server). So I updated the configuration file to show language tags instead of the versions...

'versions'      => [
    'default'   => 'en',
    'published' => [
        'es',
        'en'
    ]
], 

and on the folder structure did the same

  • docs
    -- en
    --- index.md
    --- overview.md
    -- es
    --- index.md
    --- vista.md

It works out pretty great, plus you get the language key on the url, so you can direct users based on their preferences.

Hope this helps!

@saleem-hadad
Copy link
Owner

Hello everyone
Now after I finished the internal search I'm planning to start working on this feature in parallel with RTL support. However, I have a concern about how do you suggest to implement it?
I'm thinking that the relationship between a version and its languages is one to many.
Something like:

'versions'       => [
    'default'    => '1.0',
    'published'  => [
        '1.0'    => [
            'en' => 'ltr',
            'ar' => 'rtl'
        ],
        '1.1'    => [
            'en' => 'ltr',
        ]
    ]
],

what do you think guys?

@saleem-hadad saleem-hadad added the enhancement New feature or request label Feb 10, 2019
@ablishek
Copy link

ablishek commented Feb 10, 2019 via email

@saleem-hadad
Copy link
Owner

Sounds simple now :D thank you @abhi-cognitivo

@saleem-hadad
Copy link
Owner

Obviously implementing this feature will break a lot of existing usages (I mean it gonna be a major update) since the docs folder's structure will be changed.
However, do you prefer the path to be /docs/1.1/en/page or /docs/en/1.1/page?

@ablishek
Copy link

@saleem-hadad , language should be before version, as people don't change languages but can and will change versions quite often.

But if you are going to do this, I would suggest applying both Version and Language as an optional feature, similar to what you do with Github Link or Search. Not every one will have multiple languages, and not every one will have multiple versions.

Currently I am using version as language and it works great: Here is a screenshot:

screen shot 2019-02-11 at 7 53 51 am

@AMAFsoft
Copy link

AMAFsoft commented Mar 5, 2019

Any news on this features??

@DeBelserArne
Copy link
Author

Hello there,

I was going through my old tickets and I came across this one. Was wondering how far this is coming along. I'm writing a SaaS application and I'm nearing completion so I'm probably going to write some documentation for it.

If this feature is still in development phase I might use @abhi-cognitivo 's idea to use versioning for translations.

Thanks in advance for an update!

@saleem-hadad saleem-hadad changed the title Does this package support multiple languages? Does this package support multiple languages? (in development - beta: 15/6/2016) May 21, 2019
@saleem-hadad saleem-hadad changed the title Does this package support multiple languages? (in development - beta: 15/6/2016) Does this package support multiple languages? (in development) Jul 21, 2019
@saleem-hadad
Copy link
Owner

will be added to the pro version as stated here

@hanifhefaz
Copy link

Hello @saleem-hadad

Are there any updates of implementing right to left?

@saleem-hadad
Copy link
Owner

Hello @saleem-hadad

Are there any updates of implementing right to left?

@hanifhefaz you can use this package for now
https://github.com/larecipe/rtl

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

6 participants