Redis Documentation in HTML/PDF

[Shantanu Thatte]

Hi,

This might seem a simple question. But how can I get the documentation in HTML/PDF format from the github repository: https://github.com/antirez/redis-doc

Regards,

Shantanu

[Jan-Erik Rediger]

The content is served as HTML at http://redis.io.
For PDF there's no "official" way, but I know atleast two possibilities:

1. Print the pages from within your browser to a PDF (or use something
like wkhtmltopdf[1] to do it automatically)
2. Use pandoc[2] to convert the markdown to a PDF.

Of course both require manual processing so you get nice working links
and a readable layout.

[1]: https://code.google.com/p/wkhtmltopdf/
[2]: http://johnmacfarlane.net/pandoc/

> --
> You received this message because you are subscribed to the Google Groups "Redis DB" group.
> To unsubscribe from this group and stop receiving emails from it, send an email to redis-db+u...@googlegroups.com.
> To post to this group, send email to redi...@googlegroups.com.
> Visit this group at http://groups.google.com/group/redis-db.
> For more options, visit https://groups.google.com/d/optout.

[Shantanu Thatte]

Yes,

I know of those options, and have been playing with those for the past few hours. But most of the .md files have 

@return

@array-reply

@examples

Which do not show up as expected in pandoc or pandoc->html->wkhtmltopdf

I also notice the .json files (commands.json, topic.json) which have further details.

How can I use that too?

Regards,

Shantanu Thatte

[Matt Stancliff]

On Jun 16, 2014, at 3:59 PM, Shantanu Thatte <shantan...@gmail.com> wrote:

> I also notice the .json files (commands.json, topic.json) which have further details.
>
> How can I use that too?

Yeah, it’s a little vague. The easiest way to get everything working: clone and follow directions for building the entire redis-io site from https://github.com/antirez/redis-io — the redis-docs repository is just a sub-component of the redis-io site.

You could tweak the site config to export everything to HTML instead of generating a live site, or you could just launch the site locally and run recursive wget against it to capture the HTML output.


-Matt

[Itamar Haber]

(Personally, I prefer the former suggestion but for the sake of completeness...)

Another way is to use, ehm, Adobe Acrobat that reportedly sports a feature that rips an entire site into a single PDF (http://www.adobepress.com/articles/article.asp?p=1252827&seqNum=3) - you'd either have to get the trial version, buy the thing or get it from a "friend" :)

On Mon, Jun 16, 2014 at 11:07 PM, Matt Stancliff <mstan...@gopivotal.com> wrote:

On Jun 16, 2014, at 3:59 PM, Shantanu Thatte <shantan...@gmail.com> wrote:

> I also notice the .json files (commands.json, topic.json) which have further details.
>
> How can I use that too?

  Yeah, it's a little vague.  The easiest way to get everything working: clone and follow directions for building the entire redis-io site from https://github.com/antirez/redis-io -- the redis-docs repository is just a sub-component of the redis-io site.

  You could tweak the site config to export everything to HTML instead of generating a live site, or you could just launch the site locally and run recursive wget against it to capture the HTML output.


-Matt

--
You received this message because you are subscribed to the Google Groups "Redis DB" group.
To unsubscribe from this group and stop receiving emails from it, send an email to redis-db+u...@googlegroups.com.
To post to this group, send email to redi...@googlegroups.com.
Visit this group at http://groups.google.com/group/redis-db.
For more options, visit https://groups.google.com/d/optout.

--

Itamar Haber

Chief Developers Advocate

Redis Labs

Mobile: +1 (415) 688-2443

Mobile (IL): +972 (54) 567-9692

Skype: itamar.haber

Blog  |  Twitter  |  LinkedIn