Hello,
As an experiement I have built a couple of single-page project
documentation booklets in black-n-white using the Jekyll static site
builder (in Ruby).
The examples include:
- The (Official) Jekyll Documentation (Book Edition) [1]
- The Jekyll Plugins & Tools Documentation (Book Edition) [2]
- The Octopress 3 (Jekyll's Ferrari) Documentation (Book Edition) [3]
How it works?
Basically all docu pages and READMEs in Markdown (.md) get
reformatted into an all-in-one-page booklets and auto-build with
GitHub Pages (w /Jekyll) using Jekyll booklet theme. Still early and a
work-in-progess.
If you know any other examples (in Ruby) let us know
Cheers.
[1] http://planetjekyll.github.io/book Source @
https://github.com/planetjekyll/book
[2] http://planetjekyll.github.io/plugins Source @
https://github.com/planetjekyll/plugins
[3] http://planetjekyll.github.io/octopress Source @
https://github.com/planetjekyll/octopress
This is great! I’ve been working with Jekyll a lot recently and have enjoyed it, but the intricacies aren’t documented very well.
If you wanted some help with it add some issues to the repos and I’ve be interested in contributing.
Hello,
If you wanted some help with it add some issues to the repos and I’ve be interested in contributing.
Thanks for your kind words.
The idea is to use the official docu and READMEs as is (1:1) - thus
- to contribute to the docu please contribute to the official repos
and READMEs e.g. for Jekyll see /site/_docs [1]
For formatting, design (colors, fonts, etc.) and layout
contributions are welcome to the jekyll book repos.
Cheers.
PS: If anyone is interested in following Jekyll news (latest themes,
articles, tips&tricks) follow along the Static Times on twitter
@statictimes [2].
[1] https://github.com/jekyll/jekyll/tree/master/site/_docs
[2] https://twitter.com/statictimes
Hello,
FYI: I've started a new imprint Hyde Press [1] - just a github org
- and have moved all manuscripts and books to the new site.
Free books in the Hyde Press series include:
- Jekyll Documentation by Tom Preston-Werner, Nick Quaranto, Parker
Moore, et al
- Jekyll Plugins 'n' Tools by Ben Balter, Parker Moore, Jordon
Bedwell, Sylvester Keil, Gerald Bauer, et al
- Jekyll Style Guide by Ben Balter et al
- Octopress 3 Documentation by Brandon Mathis et al
Sorry for the troube with the broken links. Cheers.
PS: All the themes, layouts, scripts etc. are open source and built
with the Git Hub Pages service and the Jekyll static site builder
machinery.
[1] http://hydepress.github.io
···
2016-02-11 15:15 GMT+01:00 Gerald Bauer <gerald.bauer@gmail.com>:
Hello,
As an experiement I have built a couple of single-page project
documentation booklets in black-n-white using the Jekyll static site
builder (in Ruby).
The examples include:
- The (Official) Jekyll Documentation (Book Edition) [1]
- The Jekyll Plugins & Tools Documentation (Book Edition) [2]
- The Octopress 3 (Jekyll's Ferrari) Documentation (Book Edition) [3]
How it works?
Basically all docu pages and READMEs in Markdown (.md) get
reformatted into an all-in-one-page booklets and auto-build with
GitHub Pages (w /Jekyll) using Jekyll booklet theme. Still early and a
work-in-progess.
If you know any other examples (in Ruby) let us know
Cheers.
[1] http://planetjekyll.github.io/book Source @
https://github.com/planetjekyll/book
[2] Jekyll Plugins | Planet Jekyll Source @
https://github.com/planetjekyll/plugins
[3] http://planetjekyll.github.io/octopress Source @
GitHub - hydepress/octopress: Octopress 3 Documentation (Book Edition) by Brandon Mathis et al
Great idea! Will you be thinking of adding navigational functionality
within the booklet?
cheers,
saji
Saji N Hameed,
Environmental Informatics,
University of Aizu, Tsuruga, Ikki-machi,
Aizuwakamatsu-shi, Fukushima 965-8580,
Japan
Tel: +81242 37-2736
Fax:+81242 37-2760
email: saji@u-aizu.ac.jp
url: http://enformtk.u-aizu.ac.jp
bib: Web of Science
code: sajinh (Saji Hameed) · GitHub
···
On Sat, Feb 27, 2016 at 10:24 PM, Gerald Bauer <gerald.bauer@gmail.com> wrote:
Hello,
FYI: I've started a new imprint Hyde Press [1] - just a github org
- and have moved all manuscripts and books to the new site.
Free books in the Hyde Press series include:
- Jekyll Documentation by Tom Preston-Werner, Nick Quaranto, Parker
Moore, et al
- Jekyll Plugins 'n' Tools by Ben Balter, Parker Moore, Jordon
Bedwell, Sylvester Keil, Gerald Bauer, et al
- Jekyll Style Guide by Ben Balter et al
- Octopress 3 Documentation by Brandon Mathis et al
Sorry for the troube with the broken links. Cheers.
PS: All the themes, layouts, scripts etc. are open source and built
with the Git Hub Pages service and the Jekyll static site builder
machinery.
[1] http://hydepress.github.io
2016-02-11 15:15 GMT+01:00 Gerald Bauer <gerald.bauer@gmail.com>:
> Hello,
>
> As an experiement I have built a couple of single-page project
> documentation booklets in black-n-white using the Jekyll static site
> builder (in Ruby).
>
> The examples include:
>
> - The (Official) Jekyll Documentation (Book Edition) [1]
> - The Jekyll Plugins & Tools Documentation (Book Edition) [2]
> - The Octopress 3 (Jekyll's Ferrari) Documentation (Book Edition) [3]
>
> How it works?
>
> Basically all docu pages and READMEs in Markdown (.md) get
> reformatted into an all-in-one-page booklets and auto-build with
> GitHub Pages (w /Jekyll) using Jekyll booklet theme. Still early and a
> work-in-progess.
>
> If you know any other examples (in Ruby) let us know
>
> Cheers.
>
> [1] http://planetjekyll.github.io/book Source @
> https://github.com/planetjekyll/book
> [2] Jekyll Plugins | Planet Jekyll Source @
> https://github.com/planetjekyll/plugins
> [3] http://planetjekyll.github.io/octopress Source @
> GitHub - hydepress/octopress: Octopress 3 Documentation (Book Edition) by Brandon Mathis et al
Unsubscribe: <mailto:ruby-talk-request@ruby-lang.org?subject=unsubscribe>
<http://lists.ruby-lang.org/cgi-bin/mailman/options/ruby-talk>
Hello,
Thanks for you kind words
Will you be thinking of adding navigational functionality within the booklet?
Yes. The idea is to have a table of contents (with intra-page
links, that is, anchors) and than for every part and chapter to have
an (embedded) mini table of content (again with intra-page links).
If you have any ideas or suggestions you're more than welcome.
The booklet template is still early and rough. The idea / plan is
to also add an epub (it's just html zipped up) and a pdf for download.
Cheers.