2012-05-26 19:29:47 +00:00
namespace :guides do
2012-09-07 04:09:56 +00:00
desc 'Generate guides (for authors), use ONLY=foo to process just "foo.md"'
2016-08-06 17:39:28 +00:00
task generate : " generate:html "
2012-05-26 19:29:47 +00:00
namespace :generate do
desc " Generate HTML guides "
task :html do
2015-07-30 00:00:58 +00:00
ENV [ " WARNINGS " ] = " 1 " # authors can't disable this
2012-05-26 19:29:47 +00:00
ruby " rails_guides.rb "
end
2015-03-01 01:39:52 +00:00
desc " Generate .mobi file. The kindlegen executable must be in your PATH. You can get it for free from http://www.amazon.com/gp/feature.html?docId=1000765211 "
2012-05-26 19:29:47 +00:00
task :kindle do
2016-12-29 02:53:51 +00:00
require " kindlerb "
2016-12-18 15:13:50 +00:00
unless Kindlerb . kindlegen_available?
abort " Please run `setupkindlerb` to install kindlegen "
2012-11-28 16:25:32 +00:00
end
2016-08-06 17:55:02 +00:00
unless ` convert ` =~ / convert /
2012-11-28 16:25:32 +00:00
abort " Please install ImageMagick` "
end
2016-08-06 17:21:59 +00:00
ENV [ " KINDLE " ] = " 1 "
Rake :: Task [ " guides:generate:html " ] . invoke
2012-05-26 19:29:47 +00:00
end
end
# Validate guides -------------------------------------------------------------------------
desc 'Validate guides, use ONLY=foo to process just "foo.html"'
task :validate do
ruby " w3c_validator.rb "
end
2012-03-17 15:32:49 +00:00
2012-05-26 20:05:52 +00:00
desc " Show help "
task :help do
puts <<-help
2014-11-26 00:54:30 +00:00
Guides are taken from the source directory , and the result goes into the
2012-05-26 20:05:52 +00:00
output directory . Assets are stored under files , and copied to output / files as
part of the generation process .
2014-11-26 00:54:30 +00:00
You can generate HTML , Kindle or both formats using the ` guides:generate ` task .
2014-12-05 15:32:50 +00:00
All of these processes are handled via rake tasks , here ' s a full list of them :
2012-05-28 21:17:00 +00:00
#{%x[rake -T]}
2012-05-26 20:05:52 +00:00
Some arguments may be passed via environment variables :
WARNINGS = 1
Internal links ( anchors ) are checked , also detects duplicated IDs .
ALL = 1
Force generation of all guides .
ONLY = name
Useful if you want to generate only one or a set of guides .
2012-08-31 16:01:06 +00:00
2012-05-26 20:05:52 +00:00
Generate only association_basics . html :
ONLY = assoc
Separate many using commas :
ONLY = assoc , migrations
GUIDES_LANGUAGE
Use it when you want to generate translated guides in
source / < GUIDES_LANGUAGE > folder ( such as source / es )
EDGE = 1
Indicate generated guides should be marked as edge .
Examples :
$ rake guides : generate ALL = 1
$ rake guides : generate EDGE = 1
2012-05-28 21:20:10 +00:00
$ rake guides : generate : kindle EDGE = 1
2012-05-26 20:05:52 +00:00
$ rake guides : generate GUIDES_LANGUAGE = es
help
end
2012-03-17 15:32:49 +00:00
end
2012-05-26 20:05:52 +00:00
2016-08-06 17:39:28 +00:00
task default : " guides:help "