How to install it properly

[Hax4us]

Hey i did two steps
Just add remote_theme: pmarsceill/just-the-docs and this gem "jekyll-remote-theme" in Gemfile.
But as u can see here https://hax4us.github.io/hax4us-site/
It's not working
Note :- yes i am absolute beginner in Jekyll

Edit :
I solved it by setting url in config file. Actually i am willing to migrate from blogger to gh pages but this is totally new to me.

Last query : can i use fork instead of remote_theme

[pdmosses]

@Hax4us good that you managed to get it working OK.

It seems that the _config.yml produced when following the Jekyll Quick Start guide needs updating when publishing to GH Pages from non-user repositories (such as your hax4us-site):

baseurl: "" # the subpath of your site, e.g. /blog
url: "" # the base hostname & protocol for your site, e.g. http://example.com

There is a very helpful webpage about these settings at https://byparker.com/blog/2014/clearing-up-confusion-around-baseurl/

This seems to be a general issue with publishing Jekyll sites on GH Pages from non-user repositories, but I think it would be helpful to mention it in the Quick Start guide for this theme, in view of the difficulty of finding anything about it in the official Jekyll documentation.

[pdmosses]

@pmarsceill the example of _config.yml in jtd-remote doesn't set baseurl, but still publishes OK at https://pmarsceill.github.io/jtd-remote/. How does that work?

[SgtSilvio]

GitHub Pages automatically configures the (base)urls correctly, it is better to not define them in the _config.yml.

[pmarsceill]

To be clear:

• If you're using remote_theme there is no need to additionally install the gem in your Gemfile. GitHub Pages will do this automatically. This is typically used if you want to use the stock JTD theme (and configure it using our out-of-the-box options).
• If you are looking to do some customization / local development, then do not use remote_theme, but rather install the gem in the gemfile and use theme in your config (not remote_theme).

[pdmosses]

@Hax4us asked:

can i use fork instead of remote_theme

Although a site can be built locally from a fork, I don't think it can be published on GH Pages from the fork. Forks are used primarily for submitting pull requests.

However, the remote theme has various folders used by Jekyll (_layouts, _includes, etc.) and the files in them are overridden by any files with the same names in the user's repository. This has the effect of customising the remote theme without creating a fork.

[SgtSilvio]

A fork is just a normal git repository that clones the original repository.
You can use any git repository as a remote_theme, you can also specify the branch or tag directly.
Example of my fork: remote_theme: SgtSilvio/just-the-docs@merged