I use “https://github.com/pmarsceill/just-the-docs” as a remote theme for my project:
Is it possible to fork “https://github.com/pmarsceill/just-the-docs” and than use the forked theme as my new remote theme?
remote_theme: pmarsceill/just-the-docs > remote_theme: aronsommer/just-the-docs
I am wondering because I would like to modify stuff in the remote theme.
For example css which is in “https://github.com/pmarsceill/just-the-docs/blob/master/_sass/base.scss”.
Yes that will work on the remote theme field. According to the docs it just needs to be in that format for public repos.
If you run locally, it takes more effort as you will need to add a Gemfile line which points to the gem which must have a unique name on the ruby gems site. I believe you can use a github URL instead. You’ll have to look into publishing your repo on github. I am guessing it’s easier than on rubygems and might work nicer if you don’t intend to share the gem publically yet.
Also, forking a theme may not be the right approach because of that overhead…
Forking a theme makes sense if you want to use your forked theme for two or more of your own repos, or you want to share your fork publically.
If that’s not the case, then go with the more common flow. Load the original theme as your remote theme and gem. And then in your own project where you content is, you can override
_includes etc. folders in your project root. Your Jekyll build will look there first and then look in the installed theme’s folders.
This means you can add custom CSS to a head.html includes file or default.html layout page, or you can add SCSS folder and use that approach. You can override a file in the theme by using the same name. Or you can create a new one