search

Redocly / redoc

📘 OpenAPI/Swagger-generated API Reference Documentation
https://redocly.github.io/redoc/
MIT License
23.59k stars 2.3k forks source link

Make redoc RTL support #1002

Open raha1923 opened 5 years ago

raha1923 commented 5 years ago

Issue type: feature

Redoc is one of the best opensource API-docs that I have found. We(baninab.co) need an api-doc in one of our projects. What we need is an api-doc that supports RTL and has a console to test API's, so I decided to talk to @RomanHotsiy and find know how do you think about make this tool RTL support? We are ready to start to develop redoc to make it RTL support and publish it, but I wanted to ask you to know do you have any plan to RTL support of redoc?

raha1923 commented 5 years ago

There are a lot of projects that need good api-doc that can support RTL in my country and even in Asia. So I think it's a good idea to add RTL support to this tool to make it more useful in some countries that don't have LTR languages.

Could this issue marked as feature or even add a milestone to this project and assign this issue to that milestone?

RomanHotsiy commented 5 years ago

It may be a good addition.

nanov commented 5 years ago

This is actually a great idea, and not awfully hard to implement.

I may take a shot when I have a day to spend on it.

raha1923 commented 5 years ago

I'm so glad because of that you have accepted it as a feature @RomanHotsiy, thank you.

RTL supporting is not mirroring the content, it needs more actions and implementations than just mirroring the content, because of typography attributes and HTML structure and lots of this type of issue (GOOD REFERENCE).

The mentioned reference I think is really necessary to read for anyone who likes and wants to help.

nanov commented 5 years ago

Would you like to help? ;)

As a person who grew up ( 15 years ) in a RTL country I do know the complexity of the task, any help would be appreciated.

raha1923 commented 5 years ago

yes I do, I will help you to improve this product and add RTL support feature.

raha1923 commented 5 years ago

I'm going to work on a rtl version of redoc and just because I'm redoc contributor so I have to work on it on my forked version of redoc, you can find it in https://github.com/raha1923/redoc.

I'll be happy if you help me :)

raha1923 commented 5 years ago

I think it's a good idea to set direction in theme (default value: LTR) and let users change the theme direction using the theme configuration. In this case, we can easily detect what type of language users are using on his page (as the main language), and we can set the proper custom style rules.

raha1923 commented 5 years ago

hi there. I need to add a CSS file to the project to write general RTL rules there and import the CSS file into the project. what is the best way to do this? @RomanHotsiy @nanov

raha1923 commented 4 years ago

@RomanHotsiy hi roman, I thought you have forgotten this issue and the related pull-request so I just decided to mention you and ask about the progress on this issue and the pull request. please let me know if there is a problem.

RomanHotsiy commented 4 years ago

Hey @raha1923. I do remember about this but it's big PR which requires careful review. I am a bit busy last months so sorry for the delay.

I will try to get back to it mid Feb.

raha1923 commented 4 years ago

@RomanHotsiy good to hear from you, thank you for your attention.

Another thing roman, our company needs an API-console on Redoc, so we have to keep developing on redoc and try to implement a proper API-console on redoc. It would be so great if you help me to find the proper way to implement it on redoc. I'll add an issue about implementing API-console in the Redoc project.

raha1923 commented 4 years ago

Well I've checked #53 and found out there is no need to add a new issue, I can use it and put additional info on it.

saeidmh83 commented 4 years ago

@RomanHotsiy hi roman, please review @raha1923 Pull-request and add this feature as soon as possible. thanks a lot