Skip to content

Commit

Permalink
mention url and baseurl only need to be modified in local dev
Browse files Browse the repository at this point in the history
  • Loading branch information
daattali authored Jun 17, 2019
1 parent fe0940b commit d674dae
Showing 1 changed file with 11 additions and 17 deletions.
28 changes: 11 additions & 17 deletions _config.yml
Original file line number Diff line number Diff line change
@@ -1,25 +1,20 @@
# --- General options --- #

# To spare yourself from trouble, just leave url and baseurl undefined,
# GitHub can automatically set these properties accordingly for user
# page and project page.
#
# Indeed you can still set the properties yourself, in that case don't
# forget to change the username and projectname to YOUR username and project

# url is the website URL up to host name, without trailing slash
#url: "https://username.github.io"

# For GitHub user page, baseurl is empty string. Don't set to "/".
# For GitHub project page, set it to project name with leading slash,
# e.g. "/myproject". However, don't add trailing slash.
#baseurl: ""

# Name of website
title: My website

# Short description of your site
description: A virtual proof that name is awesome!
description: A virtual proof that I'm awesome

# --- Local development options ---
# If your website is hosted locally rather than on GitHub, then you need to uncomment the next two parameters to set the url and baseurl
# *** If you're not sure what this mean, then leave this section as it is. Only modify the url and baseurl if you know what you're doing!***

# url is the the website domain URL without a trailing slash
#url: "https://example.com"

# baseurl should be an empty string
#baseurl: ""

# --- Navigation bar options --- #

Expand All @@ -29,7 +24,6 @@ navbar-links:
Resources:
- Beautiful Jekyll: "http://deanattali.com/beautiful-jekyll/"
- Learn markdown: "http://www.markdowntutorial.com/"
- GitHub Pages: "https://pages.github.com/"
Author's home: "http://deanattali.com"

# Image to show in the navigation bar - image must be a square (width = height)
Expand Down

2 comments on commit d674dae

@abelcheung
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need to also document the case when user hosts it on local server but want a structure similar to Github project page, like www.mydomain.com/blog/ ?

@daattali
Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think at this point you can assume the user is advanced enough that they'll figure it out on their own. The README and the general idea of the theme is to support the average person who doesn't know what unix is, with just little snippets of info for whoever wants to go further but not too much

Please sign in to comment.