Giter VIP home page Giter VIP logo

couchdb-guide's Introduction

jrk's buildable fork

I've made a modest fork of the original repository which builds cleanly into epub with off-the-shelf docbook-xsl dbtoepub src/01/book.xml. (The script lives in the DOCBOOK_XSL_ROOT/epub/dbtoepub at least as of docbook-xsl version 1.75.2.)

Changes

The only change so far was the addition of cover images under src/covers. These are referenced in the book.xml, but are not included in the repository. Rather than removing these references, I downloaded and created corresponding images at the required paths.

CouchDB: The Definitive Guide

This is the source code repository for a free book about Apache CouchDB.

Introduction

The book is called CouchDB: The Definitive Guide and is published by O’Reilly Media under a free license.

We believe that community software needs community documentation. You can inspect the source code for CouchDB and make improvements to it, and similarly you can inspect the source code for this book and make improvements to it. If you want to contribute, please do so! Fork it, hack on it, and send back your changes! If you want to support the project, you can do so by buying a copy of the book in digital or printed form.

Dependencies

We edit the book in HTML and accept contributions in HTML.

HTML allows us a lot of freedom as authors, and makes editing much easier. Before going to print we hand the HTML to O’Reilly Media, and they convert this into DocBook. DocBook allows a lot of control over the typesetting and publishing of the book. Once that process is complete, O’Reilly Media hand us back the final DocBook, which now includes any modifications from our editors. We then transform this into HTML, and tidy it up.

You must install the DocBook XSL stylesheets to generate the HTML:

sudo port install docbook-xsl

You must install Tidy to clean the HTML:

sudo port install tidy

You can now generate HTML from the DocBook source.

Instructions

The DocBook source for the book is under:

src/EDITION

So, the first edition of the book can be found at:

src/01/book.xml

And the images used for the first edition of the book can be found at:

src/01/figs

The tools we use to convert this into HTML can be found at:

bin/

You can transform the DocBook to HTML by running:

bin/transform.sh src/EDITION/book.xml

You can tidy the HTML files by running:

bin/tidy.sh ch01.html

The HTML we generate with this process is held in the gh-pages branch.

Relax.

couchdb-guide's People

Contributors

jrk avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.