https://github.com/talon1024/ruby-users-guide-multimarkdown

Multimarkdown conversion of the Ruby User's Guide
https://github.com/talon1024/ruby-users-guide-multimarkdown

Last synced: 5 months ago
JSON representation

Multimarkdown conversion of the Ruby User's Guide

• Host: GitHub
• URL: https://github.com/talon1024/ruby-users-guide-multimarkdown
• Owner: Talon1024
• License: other
• Created: 2014-08-03T23:45:10.000Z (almost 12 years ago)
• Default Branch: master
• Last Pushed: 2025-02-13T07:26:53.000Z (over 1 year ago)
• Last Synced: 2025-07-20T22:23:11.991Z (about 1 year ago)
• Language: JavaScript
• Size: 1.36 MB
• Stars: 1
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: Readme.md
  • License: license.html

Awesome Lists containing this project

README

          
Ruby User's Guide

=================

This is a [MultiMarkdown](https://github.com/fletcher/MultiMarkdown-4) conversion

of the [Ruby User's Guide](http://www.rubyist.net/~slagell/ruby/) by Mark Slagell.

The original English translation of the Ruby User's Guide was released as a

[bunch of HTML/CSS](http://www.rubyist.net/~slagell/ruby/ruby-uguide-20111216.tar.gz) files under the GNU Free Documentation License.

However, the HTML/CSS version was designed for desktop users, and as such, it

is very hard to read, if not impossible, on mobile phones. This version is

intended to enhance readability on mobile phones and other such devices, as

well as ease conversion to other formats.

How to build the HTML version

-----------------------------

Assuming you have Node.js and MultiMarkdown installed, run tohtml.js to convert

all of the .md files to HTML files.

To build each .md file individually, run `multimarkdown --process-html xxxxx.md`,

where `xxxxx.md` is the markdown file you want to build.

Ebooks

-------

EPUB, MOBI, AZW3, PDF versions are available under the `ebook` directory

in this repository.

These versions are generated from the markdown source.