aboutsummaryrefslogtreecommitdiff
path: root/README.markdown
diff options
context:
space:
mode:
authorBrandon Mathis <brandon@imathis.com>2011-07-16 09:29:09 -0400
committerBrandon Mathis <brandon@imathis.com>2011-07-16 09:29:09 -0400
commitf81bdbc1a8e341d9d3fe1eba3b77beadfe59b3d6 (patch)
tree31458d76b97e7e6af151be3bbf666bd58d7f9739 /README.markdown
parent4855ef5d2f976b07d624dddb85b46075009d5a6d (diff)
downloadmy_new_personal_website-f81bdbc1a8e341d9d3fe1eba3b77beadfe59b3d6.tar.xz
my_new_personal_website-f81bdbc1a8e341d9d3fe1eba3b77beadfe59b3d6.zip
Added support and documentation for deploying to subdirectories (like
with gh-pages)
Diffstat (limited to 'README.markdown')
-rw-r--r--README.markdown17
1 files changed, 17 insertions, 0 deletions
diff --git a/README.markdown b/README.markdown
index 2ebcd4e1..79ef8e18 100644
--- a/README.markdown
+++ b/README.markdown
@@ -118,6 +118,23 @@ The `config_deploy` rake task takes a branch name as an argument and creates a [
This prepares your branch for easy deployment. The `rake deploy` task copies the generated blog from the `public` directory to the `_deploy` directory, adds new files, removes old files, sets a commit message, and pushes to Github.
Github will queue your site for publishing (which usually occurs instantly or within minutes if it's your first commit).
+**Please note,** Github's project pages will be published to a subdirectory and you'll have to make sure you set up your urls correctly in your configs.
+
+For Octopress my cofigs would be set up like this:
+
+ # _config.yaml
+ destination: public/octopress
+ url: http://imathis.github.com/octopress
+ subscribe_rss: /octopress/atom.xml
+ root: /octopress
+
+ # config.rb
+ http_path = "/octopress"
+
+ # Rakefile
+ public_dir = "public/octopress"
+
+
## License
(The MIT License)