http://tom.preston-werner.com/2008/11/17/blogging-like-a-hacker.html.
-Categories for posts are derived from the directory structure the posts were
-found within.
-A post that appears in the directory foo/bar/_posts is placed in the categories
-'foo' and 'bar'.
-By selecting posts from particular categories in your Liquid templates, you will
-be able to host multiple blogs within a site.
+Categories for posts are derived from the directory structure the posts were
+found within. A post that appears in the directory foo/bar/_posts is placed in
+the categories 'foo' and 'bar'. By selecting posts from particular categories
+in your Liquid templates, you will be able to host multiple blogs within a
+site.
Files that do not reside in directories prefixed with an underscore are
mirrored into a corresponding directory structure in the generated site. If a
@@ -88,7 +87,7 @@ The best way to install Jekyll is via RubyGems:
$ sudo gem install mojombo-jekyll -s http://gems.github.com/
Jekyll requires the gems `directory_watcher`, `liquid`, `open4`,
-and `maruku` for markdown support. These are automatically
+and `maruku` (for markdown support). These are automatically
installed by the gem install command.
Maruku comes with optional support for LaTeX to PNG rendering via
@@ -131,6 +130,21 @@ during the conversion:
$ jekyll --pygments
+By default, Jekyll uses "Maruku":http://maruku.rubyforge.org (pure Ruby) for
+Markdown support. If you'd like to use RDiscount (faster, but requires
+compilation), you must install it (gem install rdiscount) and then you can
+have it used instead:
+
+ $ jekyll --rdiscount
+
+When previewing complex sites locally, simply opening the site in a web
+browser (using file://) can cause problems with links that are relative to
+the site root (e.g., "/stylesheets/style.css"). To get around this, Jekyll
+can launch a simple WEBrick server (works well in conjunction with --auto).
+Default port is 4000:
+
+ $ jekyll --server [PORT]
+
h2. Data
Jekyll traverses your site looking for files to process. Any files with YAML
@@ -150,7 +164,7 @@ h3. Global
content
In layout files, this contains the content of the subview(s). In Posts or
- pages, this is undefined.
+ Pages, this is undefined.
h3. Site
@@ -167,7 +181,7 @@ h3. Site
--lsi (latent semantic indexing) option.
site.categories.CATEGORY
- The list of all posts in category CATEGORY.
+ The list of all Posts in category CATEGORY.
h3. Post
@@ -185,12 +199,21 @@ h3. Post
An identifier unique to the Post (useful in RSS feeds).
e.g. /2008/12/14/my-post
+ post.categories
+ The list of categories to which this post belongs. Categories are
+ derived from the directory structure above the _posts directory. For
+ example, a post at /work/code/_posts/2008-12-24-closures.textile
+ would have this field set to ['work', 'code'].
+
+ post.topics
+ The list of topics for this Post. Topics are derived from the directory
+ structure beneath the _posts directory. For example, a post at
+ /_posts/music/metal/2008-12-24-metalocalypse.textile would have this field
+ set to ['music', 'metal'].
+
post.content
The content of the Post.
- post.categories
- The list of categories to which this post belongs.
-
h2. YAML Front Matter
Any files that contain a YAML front matter block will be processed by Jekyll
@@ -263,9 +286,20 @@ becomes
1337
+h3. Array to Sentence String
+
+Convert an array into a sentence.
+
+ {{ page.tags | array_to_sentence_string }}
+
+becomes
+
+ foo, bar, and baz
+
h3. Include (Tag)
-If you have small page fragments that you wish to include in multiple places on your site, you can use the include tag.
+If you have small page fragments that you wish to include in multiple places
+on your site, you can use the include tag.
{% include sig.textile %}
@@ -332,11 +366,49 @@ The best way to get your changes merged back into core is as follows:
# Clone down your fork
# Create a topic branch to contain your change
# Hack away
+# If you are adding new functionality, document it in README.textile
# Do not change the version number, I will do that on my end
# If necessary, rebase your commits into logical chunks, without errors
# Push the branch up to GitHub
# Send me (mojombo) a pull request for your branch
+h2. Blog migrations
+
+h3. Movable Type
+
+To migrate your MT blog into Jekyll, you'll need read access to the database.
+The lib/jekyll/converters/mt.rb module provides a simple convert to create
+.markdown files in a _posts directory based on the entries contained therein.
+
+ $ export DB=my_mtdb
+ $ export USER=dbuser
+ $ export PASS=dbpass
+ $ ruby -r './lib/jekyll/converters/mt' -e 'Jekyll::MT.process( \
+ "#{ENV["DB"]}", "#{ENV["USER"]}", "#{ENV["PASS"]}")'
+
+You may need to adjust the SQL query used to retrieve MT entries. Left alone,
+it will attempt to pull all entries across all blogs regardless of status.
+Please check the results and verify the posts before publishing.
+
+h3. Typo 4+
+
+To migrate your Typo blog into Jekyll, you'll need read access to the MySQL
+database. The lib/jekyll/converters/typo.rb module provides a simple convert
+to create .html, .textile, or .markdown files in a _posts directory based on
+the entries contained therein.
+
+ $ export DB=my_typo_db
+ $ export USER=dbuser
+ $ export PASS=dbpass
+ $ ruby -r './lib/jekyll/converters/typo' -e 'Jekyll::Typo.process( \
+ "#{ENV["DB"]}", "#{ENV["USER"]}", "#{ENV["PASS"]}")'
+
+You may need to adjust the code used to filter Typo entries. Left alone,
+it will attempt to pull all entries across all blogs that were published.
+This code also has only been tested with Typo version 4+. Previous versions
+of Typo may not convert correctly. Please check the results and verify the
+posts before publishing.
+
h2. License
(The MIT License)
diff --git a/Rakefile b/Rakefile
index 3241e9935..3f301a771 100644
--- a/Rakefile
+++ b/Rakefile
@@ -18,4 +18,12 @@ namespace :convert do
task :mephisto do
sh %q(ruby -r './lib/jekyll/converters/mephisto' -e 'Jekyll::Mephisto.postgres(:database => "#{ENV["DB"]}")')
end
+ desc "Migrate from Movable Type in the current directory"
+ task :mt do
+ sh %q(ruby -r './lib/jekyll/converters/mt' -e 'Jekyll::MT.process("#{ENV["DB"]}", "#{ENV["USER"]}", "#{ENV["PASS"]}")')
+ end
+ desc "Migrate from Typo in the current directory"
+ task :typo do
+ sh %q(ruby -r './lib/jekyll/converters/typo' -e 'Jekyll::Typo.process("#{ENV["DB"]}", "#{ENV["USER"]}", "#{ENV["PASS"]}")')
+ end
end
diff --git a/bin/jekyll b/bin/jekyll
index 6a641f6b6..d746806f7 100755
--- a/bin/jekyll
+++ b/bin/jekyll
@@ -25,6 +25,11 @@ opts = OptionParser.new do |opts|
options[:auto] = true
end
+ opts.on("--server [PORT]", "Start web server (default port 4000)") do |port|
+ options[:server] = true
+ options[:server_port] = port || 4000
+ end
+
opts.on("--lsi", "Use LSI for better related posts") do
Jekyll.lsi = true
end
@@ -32,6 +37,16 @@ opts = OptionParser.new do |opts|
opts.on("--pygments", "Use pygments to highlight code") do
Jekyll.pygments = true
end
+
+ opts.on("--rdiscount", "Use rdiscount gem for Markdown") do
+ begin
+ require 'rdiscount'
+ Jekyll.markdown_proc = Proc.new { |x| RDiscount.new(x).to_html }
+ puts 'Using rdiscount for Markdown'
+ rescue LoadError
+ puts 'You must have the rdiscount gem installed first'
+ end
+ end
end
opts.parse!
@@ -69,6 +84,8 @@ case ARGV.size
end
if options[:auto]
+ require 'directory_watcher'
+
puts "Auto-regenerating enabled: #{source} -> #{destination}"
dw = DirectoryWatcher.new(source)
@@ -83,7 +100,28 @@ if options[:auto]
dw.start
- loop { sleep 1000 }
+ unless options[:server]
+ loop { sleep 1000 }
+ end
else
Jekyll.process(source, destination)
+ puts "Successfully generated site in #{destination}"
+end
+
+if options[:server]
+ require 'webrick'
+ include WEBrick
+
+ FileUtils.mkdir_p(destination)
+
+ s = HTTPServer.new(
+ :Port => options[:server_port],
+ :DocumentRoot => destination
+ )
+ t = Thread.new {
+ s.start
+ }
+
+ trap("INT") { s.shutdown }
+ t.join()
end
\ No newline at end of file
diff --git a/jekyll.gemspec b/jekyll.gemspec
index 9b75d2693..ff8002f7f 100644
--- a/jekyll.gemspec
+++ b/jekyll.gemspec
@@ -1,22 +1,22 @@
Gem::Specification.new do |s|
s.name = %q{jekyll}
- s.version = "0.2.0"
+ s.version = "0.3.0"
s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
s.authors = ["Tom Preston-Werner"]
- s.date = %q{2008-12-14}
+ s.date = %q{2008-12-24}
s.default_executable = %q{jekyll}
s.email = ["tom@mojombo.com"]
s.executables = ["jekyll"]
s.extra_rdoc_files = ["History.txt", "Manifest.txt"]
- s.files = ["History.txt", "Manifest.txt", "README.textile", "Rakefile", "bin/jekyll", "jekyll.gemspec", "lib/jekyll.rb", "lib/jekyll/albino.rb", "lib/jekyll/converters/csv.rb", "lib/jekyll/converters/mephisto.rb", "lib/jekyll/convertible.rb", "lib/jekyll/filters.rb", "lib/jekyll/layout.rb", "lib/jekyll/page.rb", "lib/jekyll/post.rb", "lib/jekyll/site.rb", "lib/jekyll/tags/highlight.rb", "lib/jekyll/tags/include.rb", "test/helper.rb", "test/source/_includes/sig.textile", "test/source/_layouts/default.html", "test/source/_layouts/simple.html", "test/source/_posts/2008-10-18-foo-bar.textile", "test/source/_posts/2008-11-21-complex.textile", "test/source/_posts/2008-12-13-include.textile", "test/source/css/screen.css", "test/source/index.html", "test/source/posts/2008-12-03-permalinked-post.textile", "test/suite.rb", "test/test_jekyll.rb", "test/test_post.rb", "test/test_site.rb"]
+ s.files = ["History.txt", "Manifest.txt", "README.textile", "Rakefile", "bin/jekyll", "jekyll.gemspec", "lib/jekyll.rb", "lib/jekyll/albino.rb", "lib/jekyll/converters/csv.rb", "lib/jekyll/converters/mephisto.rb", "lib/jekyll/converters/mt.rb", "lib/jekyll/converters/wordpress.rb", "lib/jekyll/convertible.rb", "lib/jekyll/core_ext.rb", "lib/jekyll/filters.rb", "lib/jekyll/layout.rb", "lib/jekyll/page.rb", "lib/jekyll/post.rb", "lib/jekyll/site.rb", "lib/jekyll/tags/highlight.rb", "lib/jekyll/tags/include.rb", "test/helper.rb", "test/source/_includes/sig.markdown", "test/source/_layouts/default.html", "test/source/_layouts/simple.html", "test/source/_posts/2008-10-18-foo-bar.textile", "test/source/_posts/2008-11-21-complex.textile", "test/source/_posts/2008-12-03-permalinked-post.textile", "test/source/_posts/2008-12-13-include.markdown", "test/source/css/screen.css", "test/source/index.html", "test/suite.rb", "test/test_generated_site.rb", "test/test_jekyll.rb", "test/test_post.rb", "test/test_site.rb"]
s.has_rdoc = true
s.rdoc_options = ["--main", "README.txt"]
s.require_paths = ["lib"]
s.rubyforge_project = %q{jekyll}
s.rubygems_version = %q{1.3.0}
s.summary = %q{Jekyll is a simple, blog aware, static site generator.}
- s.test_files = ["test/test_jekyll.rb", "test/test_post.rb", "test/test_site.rb"]
+ s.test_files = ["test/test_generated_site.rb", "test/test_jekyll.rb", "test/test_post.rb", "test/test_site.rb"]
if s.respond_to? :specification_version then
current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
diff --git a/lib/jekyll.rb b/lib/jekyll.rb
index aa67073e2..829d1d4bd 100644
--- a/lib/jekyll.rb
+++ b/lib/jekyll.rb
@@ -29,9 +29,9 @@ begin
rescue LoadError
puts "The maruku gem is required for markdown support!"
end
-require 'directory_watcher'
# internal requires
+require 'jekyll/core_ext'
require 'jekyll/site'
require 'jekyll/convertible'
require 'jekyll/layout'
@@ -43,14 +43,15 @@ require 'jekyll/tags/include'
require 'jekyll/albino'
module Jekyll
- VERSION = '0.2.0'
+ VERSION = '0.3.0'
class << self
- attr_accessor :source, :dest, :lsi, :pygments
+ attr_accessor :source, :dest, :lsi, :pygments, :markdown_proc
end
Jekyll.lsi = false
Jekyll.pygments = false
+ Jekyll.markdown_proc = Proc.new { |x| Maruku.new(x).to_html }
def self.process(source, dest)
require 'classifier' if Jekyll.lsi
diff --git a/lib/jekyll/converters/mt.rb b/lib/jekyll/converters/mt.rb
new file mode 100644
index 000000000..3b98b139f
--- /dev/null
+++ b/lib/jekyll/converters/mt.rb
@@ -0,0 +1,59 @@
+# Created by Nick Gerakines, open source and publically available under the
+# MIT license. Use this module at your own risk.
+# I'm an Erlang/Perl/C++ guy so please forgive my dirty ruby.
+
+require 'rubygems'
+require 'sequel'
+require 'fileutils'
+
+# NOTE: This converter requires Sequel and the MySQL gems.
+# The MySQL gem can be difficult to install on OS X. Once you have MySQL
+# installed, running the following commands should work:
+# $ sudo gem install sequel
+# $ sudo gem install mysql -- --with-mysql-config=/usr/local/mysql/bin/mysql_config
+
+module Jekyll
+ module MT
+ # This query will pull blog posts from all entries across all blogs. If
+ # you've got unpublished, deleted or otherwise hidden posts please sift
+ # through the created posts to make sure nothing is accidently published.
+ QUERY = "SELECT entry_id, entry_basename, entry_text, entry_text_more, entry_created_on, entry_title FROM mt_entry"
+
+ def self.process(dbname, user, pass, host = 'localhost')
+ db = Sequel.mysql(dbname, :user => user, :password => pass, :host => host)
+
+ FileUtils.mkdir_p "_posts"
+
+ db[QUERY].each do |post|
+ title = post[:entry_title]
+ slug = post[:entry_basename]
+ date = post[:entry_created_on]
+ content = post[:entry_text]
+ more_content = post[:entry_text_more]
+
+ # Be sure to include the body and extended body.
+ if more_content != nil
+ content = content + " \n" + more_content
+ end
+
+ # Ideally, this script would determine the post format (markdown, html
+ # , etc) and create files with proper extensions. At this point it
+ # just assumes that markdown will be acceptable.
+ name = [date.year, date.month, date.day, slug].join('-') + ".markdown"
+
+ data = {
+ 'layout' => 'post',
+ 'title' => title.to_s,
+ 'mt_id' => post[:entry_id],
+ }.delete_if { |k,v| v.nil? || v == ''}.to_yaml
+
+ File.open("_posts/#{name}", "w") do |f|
+ f.puts data
+ f.puts "---"
+ f.puts content
+ end
+ end
+
+ end
+ end
+end
diff --git a/lib/jekyll/converters/typo.rb b/lib/jekyll/converters/typo.rb
new file mode 100644
index 000000000..febac65dc
--- /dev/null
+++ b/lib/jekyll/converters/typo.rb
@@ -0,0 +1,49 @@
+# Author: Toby DiPasquale