Giter VIP home page Giter VIP logo

fastdoc's Introduction

fastdoc

Create publication-quality books from Jupyter notebooks

The output of fastdoc is an asciidoc file for each input notebook. You can then use asciidoctor to convert that to HTML, DocBook, epub, mobi, and so forth.

Install

To install using pip:

pip install fastdoc

To install using Conda:

conda install -c fastai fastdoc

How to use

Suppose your notebook is in a folder called book. To run fastdoc:

fastdoc_convert_all --path book --dest_path convert_book

You'll find your exported asciidoc files and all images used in convert_book.

For a single notebook demonstrating all the features of fastdoc, see the test/_test.ipynb notebook.

For a complete O'Reilly book written in this way, see fastbook.

fastdoc's People

Contributors

allendowney avatar jph00 avatar lewtun avatar radekosmulski 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.