Permalink
Browse files

added subdir-friendly url_root, updated docs

  • Loading branch information...
1 parent 6c13ac2 commit c5cbd48d13d06ecec8b1469f5313cc751ab4aaf6 @coolaj86 committed Oct 14, 2010
Showing with 29 additions and 5 deletions.
  1. +24 −1 README.md
  2. +1 −0 _config.yml
  3. +4 −4 _layouts/default.html
View
@@ -5,15 +5,36 @@ Jekyll, the ruby-based blog-aware site builder has no default setup.
Jekyll-aid provides a nice "template" for a Jekyll-based site.
+ * Disqus Comments
+ * Google Analytics
+ * categories for posts (in a tag-like fashion)
+ * plays well with subdirectories
+
Usage
====
+Add Jekyll-aid to your Jekyll-blog.
+
+ git remote add jekyll-aid git://github.com/coolaj86/jekyll-aid.git
+ git pull jekyll-aid gh-pages
+
+You will have conflicts if you already had any content.
+
+ git mergetool
+ git checkout --ours ./path/to/file
+ git checkout --theirs ./path/to/file
+
+ git commit -a -m "now using jekyll-aid"
+
+You Jekyll-aid!
+
./mkdocument 'Title of my Awesome-blog post!!!'
* creates `_posts/2010-10-14-title-of-my-awesome-blog-post.md`
* create link `edit/title-of-my-awesome-blog-post.md`
* adds `created_at` timestamp
* creates `UUID` (for disqus comments)
+ * adds to `unfinished` category
Prepare
====
@@ -29,7 +50,9 @@ Files to edit:
* `index.html` -- change the `title`
* `_layouts/default.html` -- replace `___YOUR_ID_HERE___` and `___YOUR_UA_HERE` with your `disqus id` and `google analytics id`
* `_layouts/article.html` -- replace `___YOUR_ID_HERE___` with your `disqus id`
- * `_config.yml` -- change the `destination`
+ * `_config.yml`
+ * change the `destination`
+ * url_root to `/your/subpath`
* `CNAME` -- if you're hosting on github and have a custom domain, enter it here (*without* the www prefix)
TODO
View
@@ -4,3 +4,4 @@ markdown: rdiscount
exclude: mkdocument
lsi: true
permalink: /articles/:title.html
+url_root: /
View
@@ -2,9 +2,9 @@
<html>
<head>
<title>{{ page.title }}</title>
- <link rel="stylesheet" type="text/css" href="/stylesheets/main.css" media="screen" />
- <link rel="stylesheet" type="text/css" href="/vendor/highlight/styles/sunburst.css" media="screen" />
- <script src="/vendor/highlight/highlight.pack.js"></script>
+ <link rel="stylesheet" type="text/css" href="{{ site.url_root }}/stylesheets/main.css" media="screen" />
+ <link rel="stylesheet" type="text/css" href="{{ site.url_root }}/vendor/highlight/styles/sunburst.css" media="screen" />
+ <script src="{{ site.url_root }}/vendor/highlight/highlight.pack.js"></script>
<script>
hljs.initHighlightingOnLoad();
</script>
@@ -24,7 +24,7 @@
</head>
<body>
- <h1 id="header"><a href="/">[Home]</a> {{ page.title }}</h1>
+ <h1 id="header"><a href="{{ site.url_root }}/">[Home]</a> {{ page.title }}</h1>
<div id="article">
{{ content }}

0 comments on commit c5cbd48

Please sign in to comment.