Doc-X problem

User avatar
abdulhalim
Master Bludit
Posts: 77
Joined: Thu Mar 10, 2016 6:25 pm

Tue Mar 26, 2019 10:00 am

Hello guys,

I am writing the Bludit documentation in Persian.
I use Doc-x theme for the documentation just as the https://docs.bludit.com
how can I show categories on the sidebar, also the search box?
another problem is the titles are not linked and clickable. :cry:

https://bit.ly/2COA4BV

regards,
Abdulhalim
User avatar
Edi
Site Admin
Posts: 1471
Joined: Sun Aug 09, 2015 5:01 pm
Location: Zurich
Contact:

Tue Mar 26, 2019 7:45 pm

Why not add Persian to the official documentation?
Planet Bludit, Tipps, Snippets und nützliche Links. - Newsletter, Informationen zu Bludit (auf Deutsch).
User avatar
abdulhalim
Master Bludit
Posts: 77
Joined: Thu Mar 10, 2016 6:25 pm

Tue Mar 26, 2019 8:02 pm

Edi wrote:
Tue Mar 26, 2019 7:45 pm
Why not add Persian to the official documentation?
Because I have to use RTL theme with some tweaks.
anyway it's OK to me.
and how can I solve the problem? :D
User avatar
Edi
Site Admin
Posts: 1471
Joined: Sun Aug 09, 2015 5:01 pm
Location: Zurich
Contact:

Tue Mar 26, 2019 8:24 pm

abdulhalim wrote:
Tue Mar 26, 2019 10:00 am
how can I show categories on the sidebar, also the search box?
You have to enable the use of plugins in the sidebar by adding the following:

Code: Select all

<?php Theme::plugins('siteSidebar') ?>
Or using the function getPlugin():

https://docs.bludit.com/en/dev-snippets/plugins
another problem is the titles are not linked and clickable. :cry:
It's not the intention of the theme to link titles. ;)

But you can modify the code: You have only to add the permalinks of the parent pages.
Planet Bludit, Tipps, Snippets und nützliche Links. - Newsletter, Informationen zu Bludit (auf Deutsch).
User avatar
abdulhalim
Master Bludit
Posts: 77
Joined: Thu Mar 10, 2016 6:25 pm

Tue Mar 26, 2019 8:26 pm

I checked out the Github documentation repository, All files are in MD / Markdown format, in some folder.
Let me finish the documents, I will convert them to the Markdown and then pass to you.
I can manually do something with the sidebar, I mean use HTML links instead of php auto creation. :lol:
User avatar
abdulhalim
Master Bludit
Posts: 77
Joined: Thu Mar 10, 2016 6:25 pm

Thu Mar 28, 2019 3:41 pm

Edi wrote:
Tue Mar 26, 2019 7:45 pm
Why not add Persian to the official documentation?
Hey, I forked the English docs and update some sections, what is the next step? :D
User avatar
Edi
Site Admin
Posts: 1471
Joined: Sun Aug 09, 2015 5:01 pm
Location: Zurich
Contact:

Thu Mar 28, 2019 6:16 pm

abdulhalim wrote:
Thu Mar 28, 2019 3:41 pm
Hey, I forked the English docs and update some sections, what is the next step? :D
You can add the Iranian translations and make a push request.

But I think Diego has to add Iranian as an additional documentation first.
Planet Bludit, Tipps, Snippets und nützliche Links. - Newsletter, Informationen zu Bludit (auf Deutsch).
User avatar
abdulhalim
Master Bludit
Posts: 77
Joined: Thu Mar 10, 2016 6:25 pm

Thu Mar 28, 2019 6:54 pm

There is no rush, I can wait. there are lots of pages remain to translate
User avatar
diego
Site Admin
Posts: 688
Joined: Sat May 16, 2015 2:53 pm
Contact:

Fri Mar 29, 2019 10:03 am

Hi,
I really don't want to translate all the documentation because is hard to maintain, for example if I change some snippets code or improve the endpoints in the API you need to do it as well.

For me the documentation need to be partial translated, for example only translate the parent pages.
- GETTING STARTED
- CONTENT
- SECURITY
- HOW TO (add different how to's for the users in the same language)

Anyway, if you want to keep updated all the pages is ok for me, to add to the current installation is not going to be possible because of the RTL writing, you need to keep in your webserver and change the theme for that.

The search bar is maintenant by Algolia is a service who scan you site and generate the content table.
User avatar
abdulhalim
Master Bludit
Posts: 77
Joined: Thu Mar 10, 2016 6:25 pm

Fri Mar 29, 2019 1:22 pm

diego wrote:
Fri Mar 29, 2019 10:03 am
Hi,
I really don't want to translate all the documentation because is hard to maintain, for example if I change some snippets code or improve the endpoints in the API you need to do it as well.

For me the documentation need to be partial translated, for example only translate the parent pages.
- GETTING STARTED
- CONTENT
- SECURITY
- HOW TO (add different how to's for the users in the same language)

Anyway, if you want to keep updated all the pages is ok for me, to add to the current installation is not going to be possible because of the RTL writing, you need to keep in your webserver and change the theme for that.

The search bar is maintenant by Algolia is a service who scan you site and generate the content table.
Hello,

Thank you, It's OK then, I put it on my server, and for other things, I link to the main docs.
I appreciate if you add "فارسی" the index of Bludit docs and link back to Persian (http://docs.bludit.ir/) docs.

Regards,
Abdulhalim
Post Reply