search

bobwaycott / octostrap

Octopress and Bootstrap walked into a bar ... and made a baby.
bobwaycott.github.io/octotest/
MIT License
5 stars 2 forks source link

Handling custom domains #4

Open robertfw opened 11 years ago

robertfw commented 11 years ago

There are some minor pathing issues when running as a gh-pages site (as opposed to a user/org site) using a custom domain.

The default setup is expecting includes to reside at i.e. username.github.io/project-dir/stylesheets, but this breaks when using a custom domain - the browser looks at example.com/notanantelope/stylesheets, when it should be looking at example.com/stylesheets.

My initial attempt at fixing this involved modifying _config.yml settings: change "root" from "/project_dir" to "/" change destination from "public/project_dir" to "public"

Unfortunately this broke my generation, the site is not picking anything up. I dun gone and goobed it up!

Don't worry about this one, I'll take care of it! I didn't spot anything in the Octopress or Github Pages docs, but I'm sure it's either been covered, or is a relatively simple modification that I'm missing because I've still only skimmed the Octopress docs. I'll sit down at lunch and spend some quality time with the documentation.

Once I have this worked out I'll submit a pull request to update README with instructions.

What do you think about also modifying the setup task to prompt the user for a domain name? We could automate the creation of the CNAME file and alter the settings as needed, then spit out instructions for modifying their DNS settings.

bobwaycott commented 11 years ago

Hmmm ... are you on the latest checkout? I actually found a bug yesterday evening that I pushed a fix for specifically dealing with gh-pages not generating correctly. It was related to the set_root_dir command not replacing strings correctly when I moved from rb config to yaml config.

Can you verify you're using the latest checkout, run rake setup_github_pages by itself, and then check if it resolves your issue?

EDIT: It also may be worth pointing out that a successful setup_github_pages should change some paths inside config.rb and inside rakes.config.yml. When you rake preview locally, you should see everything working correctly. When you rake gen_deploy to push to github, you should also see everything show up correctly on Github Pages, as long as your on the latest commit.

EDIT2: Oh, wait. I see you're using both gh-pages and custom domain. Did you follow the Github doc on setting up a custom domain with Jekyll? There's an extra CNAME file you have to place inside the generated pages, which I haven't automated at this point. See gh-pages help here: https://help.github.com/articles/setting-up-a-custom-domain-with-pages

bobwaycott commented 11 years ago

Any word on this? Were you able to get things figured out properly? If so, can we close this? If not, is there anything more I can do to help?

robertfw commented 11 years ago

Sorry for the lack of an update. I've got a few pathing issues - css and javascript are not loading. I just need to spend some time with the config and docs to figure out what went wrong.

Once I've got it working I was going to rebuild from a stock install and use that experience to identify any places in the docs that should be updated to deal with this use case. If you don't mind leaving this open, I'll close it once I've got that done - I'll make that my lunchtime task today.

bobwaycott commented 11 years ago

No problem. Hit me up if you'd like some help working through things. Also, it'd be swell if you were up-to-date on the latest Octostrap while ensuring things are working properly.