Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Loading…

Another broken link in index.md #18

Merged
merged 1 commit into from

3 participants

Jayraj Jog matt swanson Jade Dominguez
matt swanson

Thanks for the fix, I'm sure @plusjade will merge it in.

If you are looking for other things in this same area to improve on, you could change all of these links to be relative URLs - that way you can build the docs locally and all the links will be properly prefixed with localhost.

Jayraj Jog

How do you build the docs locally? I tried running

rake -f Rakefile

but it didn't work. I know practically nothing about Ruby

Also, is that the best approach? The way it is right now, I can access the docs online without building them locally. My understanding of your suggestion is to change URLs like http://jekyllbootstrap.com/usage/jekyll-quick-start.html to just usage/jekyll-quick-start.html. If a user doesn't build the docs locally, but runs

jekyll --server

like I did, just to try it out, they would have an index page full of broken links. I may have misunderstood your intention though.

matt swanson

Sorry, my wording of 'build the docs' is slightly misleading

If you checkout the gh-pages branch of the project (git checkout gh-pages) and run jekyll --server you will be serving the documentation site. Any changes to the documentation of http://jekyllbootstrap.com/ should be done in that branch - any of the pages in the master branch will eventually be removed by the user when they create their own blog.

You will notice that if you look at the gh-pages branch, index.md has the correct URL already and already seems to be using relative URLs.

I missed this fact when I suggested that you use relative URLs - in fact, you are correct that the master branch version should probably link directly to the official site. My apologies for leading you down a dead-end, but make sure if you are looking to fix documentation-related issues in the future that you are working in the gh-pages branch.

Jade Dominguez
Owner

Thanks @jogjayr, I imagine I have a lot of other small typos and grammar errors littered throughout ;) Seems a good number of pull requests are typos! This definitely is important though, so keep up the good work.

Jade Dominguez plusjade merged commit b7a353c into from
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Commits on Jan 21, 2012
  1. Jayraj Jog

    fixed broken link for jekyll quick start on index.md. checked and mad…

    jogjayr authored
    …e sure there are no more broken links on that page
This page is out of date. Refresh to see the latest.
Showing with 1 addition and 1 deletion.
  1. +1 −1  index.md
2  index.md
View
@@ -3,7 +3,7 @@ layout: page
title: Hello World!
---
-Read [Jekyll Quick Start](http://jekyllbootstrap.com/jekyll-quick-start.html)
+Read [Jekyll Quick Start](http://jekyllbootstrap.com/usage/jekyll-quick-start.html)
Complete usage and documentation available at: [Jekyll Bootstrap](http://jekyllbootstrap.com)
Something went wrong with that request. Please try again.