diff options
author | Xavier Noria <fxn@hashref.com> | 2011-12-24 17:26:18 -0800 |
---|---|---|
committer | Xavier Noria <fxn@hashref.com> | 2011-12-24 17:33:18 -0800 |
commit | 69cc645c70bdbd4e0a43f176a66197d6b07d1dd7 (patch) | |
tree | 7d6f5d62a6230f600eca5cb1dd7226aac1047995 /railties/guides/source/kindle/KINDLE.md | |
parent | bea3524e3f5a56e4dc87ae240a2c58301e73a128 (diff) | |
download | rails-69cc645c70bdbd4e0a43f176a66197d6b07d1dd7.tar.gz rails-69cc645c70bdbd4e0a43f176a66197d6b07d1dd7.tar.bz2 rails-69cc645c70bdbd4e0a43f176a66197d6b07d1dd7.zip |
(draft) guides for the Kindle and Kindle apps [Mip Earson & Xavier Noria]
Diffstat (limited to 'railties/guides/source/kindle/KINDLE.md')
-rw-r--r-- | railties/guides/source/kindle/KINDLE.md | 26 |
1 files changed, 26 insertions, 0 deletions
diff --git a/railties/guides/source/kindle/KINDLE.md b/railties/guides/source/kindle/KINDLE.md new file mode 100644 index 0000000000..a7d9a4e4cf --- /dev/null +++ b/railties/guides/source/kindle/KINDLE.md @@ -0,0 +1,26 @@ +# Rails Guides on the Kindle + + +## Synopsis + + 1. Obtain `kindlegen` from the link below and put the binary in your path + 2. Run `KINDLE=1 rake generate_guides` to generate the guides and compile the `.mobi` file + 3. Copy `output/kindle/rails_guides.mobi` to your Kindle + +## Resources + + * [StackOverflow: Kindle Periodical Format](http://stackoverflow.com/questions/5379565/kindle-periodical-format) + * Example Periodical [.ncx](https://gist.github.com/808c971ed087b839d462) and [.opf](https://gist.github.com/d6349aa8488eca2ee6d0) + * [Kindle Publishing guidelines](http://kindlegen.s3.amazonaws.com/AmazonKindlePublishingGuidelines.pdf) + * [KindleGen & Kindle Previewer](http://www.amazon.com/gp/feature.html?ie=UTF8&docId=1000234621) + +## TODO + +### Post release + + * Integrate generated Kindle document in to published HTML guides + * Tweak heading styles (most docs use h3/h4/h5, which end up being smaller than the text under it) + * Tweak table styles (smaller text? Many of the tables are unusable on a Kindle in portrait mode) + * Have the HTML/XML TOC 'drill down' into the TOCs of the individual guides + * `.epub` generation. + |