sinaahmadi / just-the-docs-rtl

Jekyll theme for documention for right-to-left languages

Just the Docs for Right-to-Left Scripts

A modern, highly customizable, and responsive Jekyll theme for documentation with built-in search.
Easily hosted on GitHub Pages with few dependencies.

See the original one and the forked one with right-to-left support in practice

Additional features

You can find out more about this awesome template in the original repository. Here, I would like to highlight the two important features which are added to the original template for making the current one:

• Supporting languages using right-to-left scripts like Arabic, Hebrew, Sorani Kurdish and Persian. For this purpose, https://github.com/DediData/Bootstrap-RTL is used.
• In the original template, the logo should be quite small. In this one, you can put your logo right above the items in the navigation bar giving you a bigger space. The name of the logo file can be modified at /_includes/nav.html. If you would like to change it, do so at _sass/base.scss.

Usage

View the documentation for usage information.

Development

To set up your environment to develop this theme, run bundle install.

Your theme is set up just like a normal Jekyll site! To test your theme, run bundle exec jekyll serve and open your browser at http://localhost:4000. This starts a Jekyll server using your theme. Add pages, documents, data, etc. like normal to test your theme's contents. As you make modifications to your theme and to your content, your site will regenerate and you should see the changes in the browser after a refresh, just like normal.

When the theme is released, only the files in _layouts, _includes, and _sass tracked with Git will be released.

License

The theme is available as open source under the terms of the MIT License.