Open kyleniemeyer opened 6 years ago
Oh! I think I just got it to work. I had to add "Gemfile.lock", "Gemfile"
to my exclude list in the jekyll _config.yml
.
Anything to be done on our side (docs or otherwise)?
I think it would be helpful to have some tips or this use case—it may not be super common, but it there were some non-obvious bits:
master
, so the actual source code needs to be on a different branch. .nojekyll
file so that GitHub Pages didn't automatically build the sitedoctr does create .nojekyll automatically, but only when it creates a gh-pages branch from scratch. Since you are using a .github.io repo this doesn't apply.
I thought we had some stuff in the docs about .github.io pages but I guess we don't.
@kyleniemeyer and @asmeurer do you have any advice for me in https://github.com/oceanhackweek/oceanhackweek.github.io
I created the source
branch and followed the docs. Added the .nojekyll
to master, made source
the default branch
, and removed .travis.yml
from master
. The only thing I did not do was to clean up the master branch (should I?). The CIs are passing but the page is not published.
This is why it didn't push https://travis-ci.org/github/oceanhackweek/oceanhackweek.github.io/builds/668978759#L2494.
I would clear master
if you want it to be your gh-pages branch. Even if it doesn't cause problems, it can confuse people (you can also put a README in master telling them that they should use source
).
This is why it didn't push https://travis-ci.org/github/oceanhackweek/oceanhackweek.github.io/builds/668978759#L2494.
Argh! I've been bitten by this before. I always assume the first time it will push whatever as "new" but there is nothing really new.
I would clear
master
if you want it to be your gh-pages branch. Even if it doesn't cause problems, it can confuse people (you can also put a README in master telling them that they should usesource
).
I will once the setup is working. Thanks for the tip.
OK. I cleared master and made a modification. Somehow I still get the The docs have not changed. Not updating
message :-/
Looks like my leftover config in travis.yml had the lines:
doctr:
require-master: true
and that was the problem. Also, I had to remove the README.md from the root directory b/c GH was confused and did not render the site.
Thanks @asmeurer!
Glad to hear you figured it out.
Also, I had to remove the README.md from the root directory b/c GH was confused and did not render the site.
You might be able to fix that by modifying the Jekyll config https://jekyllrb.com/docs/configuration/. I haven't used Jekyll before beyond the default GitHub config, but it sounds like you can move the sources to a subdirectory and set source
.
So, I am trying to use doctr with jekyll on my GitHub Pages-based site; I have a custom jekyll plugin, so I can't just rely on the built-in jekyll support.
This is complicated by the fact that this is a user page (i.e., the repo is "orgname.github.io"), so it must be built from the
master
branch.I haven't seen any examples that use jekyll with doctr, so I've mostly hacked together the
.travis.yml
:I'm trying to have the website source on the
source
branch and then the content built in_site
will be in themaster
branch for Github Pages. I added a.nojekyll
file so that GitHub Pages doesn't try to build everything. Right now, the master branch has all of the source files as well.However, I can't seem to get this to work. Any suggestions?