{
"info": {
"author": "Bruno Bord",
"author_email": "bruno@jehaisleprintemps.net",
"bugtrack_url": null,
"classifiers": [
"Development Status :: 4 - Beta",
"License :: OSI Approved :: MIT License",
"Natural Language :: English",
"Operating System :: OS Independent",
"Programming Language :: Python",
"Programming Language :: Python :: 2",
"Topic :: Text Processing",
"Topic :: Text Processing :: Markup"
],
"description": "==================\nMarkdown to e-book\n==================\n\nRequirements\n============\n\n* `Calibre `_ (especially its `command-line-interface tools `_)\n* `Pandoc `_\n* `Python `_\n* `epubcheck `_ (this one's optional)\n\nPlease note that you need either **Calibre** or **Pandoc** (or both) to generate\nEPUB files, but you need Calibre (and its CLI tools) to check the EPUB\nconformity.\n\nInstallation\n------------\n\nOnce the non-python requirements are installed, you can install system-wide, or\ninside a virtualenv::\n\n pip install -e ./\n\n\nUsage\n=====\n\nto start a new book, just create a new project with the following command::\n\n md2ebook start\n\nor, alternatively::\n\n md2ebook start directory-name\n\nWhen you're done, you can move to this directory and use the ``build`` command::\n\n md2ebook build\n\nThis will build a HTML and a EPUB version of your book, as defined in the\n``book.json`` file.\n\nExtra commands\n--------------\n\nYou can check your EPUB integrity using the following::\n\n md2ebook check\n\nOptions\n-------\n\nFor more help on the md2ebook command, simply type::\n\n md2ebook --help\n\nand you'll get extensive documentation about commands and their options.\n\nCover\n-----\n\nYou can designate a cover for your ebook using one of the three options:\n\n* Adding a ``--cover`` argument to the command line,\n* Adding a ``cover`` key to your configuration file,\n* Leaving a ``cover.(png|jpg|jpeg|svg)`` file at the root of your project, this\n one will be used as a cover.\n\nIf none of them leads to an existing file, the ugly default cover will be used.\n\nPlease note that the configuration option or the optional argument may be a\nURL (yes, something like ``http://example.com/beautiful-cover.jpg``).\n\nConfiguration file\n==================\n\nAt the root of your book directory, you have a ``book.json`` file which\ncontains your book configuration. This file is mandatory.\n\nHere are its **mandatory** options, as a complete example:\n\n::\n\n {\n \"files\": [\"chapter1.md\", \"chapter2.md\", \"chapter3.md\"],\n \"author\": \"Joe A. Nonymous\",\n \"title\": \"What a beautiful title\",\n \"fileroot\": \"what-a-beautiful-title\",\n \"generator\": \"calibre\"\n }\n\n* ``files`` is a list of markdown files that live in your book root directory.\n They'll be processed in that specific order and compiled into a single ebook.\n* ``author`` is the name of the author of the book.\n* ``title`` is the title of the book, in its full glory.\n* ``fileroot`` this string will serve as a *root* for the different outputs.\n Following the example, you'll produce ``what-a-beautiful-title.html`` and\n ``what-a-beautiful-title.epub`` in your book root directory.\n* ``generator`` is either \"calibre\" or \"pandoc\". Pick the one you prefer (or\n the one that is available on your system).\n\nExtra configuration\n-------------------\n\n* ``pdf``: triggers the PDF generation when using build. Set it to ``true`` or\n ``false``. If not set, the PDF won't be generated. Use the ``--with-pdf``\n option to override this settings.\n* ``cover``: will set the path of your cover. this must lead to an existing file\n and if possible, an image (png, jpg, jpeg, or even SVG).\n* ``extensions``: this list of strings defines the\n `Markdown Extensions `_\n you can add to parse the Markdown files. Please refer to the Markdown\n extension to use the supported extensions.\n\nNote about the Markdown extensions\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nHere's a list about the available extensions:\n\n* Extra (\"extra\")\n\n * Abbreviations: (\"abbr\")\n * Attribute list: (\"attr_list\")\n * Definition Lists: (\"def_list\")\n * Fenced Code Blocks: (\"fenced_code\")\n * Footnotes: (\"footnotes\")\n * Tables: (\"tables\")\n * Smart Strong: (\"smart_strong\")\n\n* Admonition: (\"admonition\")\n* CodeHilite: (\"codehilite\")\n* HeaderId: (\"headerid\")\n* Meta-Data: (\"meta\")\n* New Line to Break: (\"nl2br\")\n* Sane Lists: (\"sane_lists\")\n* Table of Contents: (\"toc\")\n* WikiLinks: (\"wikilinks\")\n\nHere's an example of config.json using the extensions::\n\n {\n \"files\": [\n \"book.md\"\n ],\n \"title\": \"Les 3 Mousquetaires\",\n \"fileroot\": \"les-3-mousquetaires\",\n \"author\": \"Alexandre Dumas\",\n \"extensions\": [\"admonitions\", \"toc\", \"footnotes\"],\n \"generator\": \"pandoc\"\n }\n\nExtension parameters are set `as described in the docs `_\n\n::\n\n \"extensions\": [\"headerid(level=3)\"]\n\nCredits\n=======\n\nThis piece of software is Copyleft 2013 - Bruno Bord.\n\nIt is released under the terms of the MIT License, see LICENSE file for more\ndetails.",
"description_content_type": null,
"docs_url": null,
"download_url": "UNKNOWN",
"downloads": {
"last_day": -1,
"last_month": -1,
"last_week": -1
},
"home_page": "https://github.com/brunobord/md2ebook/",
"keywords": null,
"license": "MIT",
"maintainer": null,
"maintainer_email": null,
"name": "md2ebook",
"package_url": "https://pypi.org/project/md2ebook/",
"platform": "UNKNOWN",
"project_url": "https://pypi.org/project/md2ebook/",
"project_urls": {
"Download": "UNKNOWN",
"Homepage": "https://github.com/brunobord/md2ebook/"
},
"release_url": "https://pypi.org/project/md2ebook/0.1.1/",
"requires_dist": null,
"requires_python": null,
"summary": "Build e-books (EPUB or PDF) out of markdown files",
"version": "0.1.1"
},
"last_serial": 927517,
"releases": {
"0.1": [
{
"comment_text": "",
"digests": {
"md5": "07befe9c4ea550106e729bce8d01954c",
"sha256": "376b17140faf57a45f596f4b0d69823792cb08ef6fdb0e392b64b198aea28c86"
},
"downloads": -1,
"filename": "md2ebook-0.1.tar.gz",
"has_sig": false,
"md5_digest": "07befe9c4ea550106e729bce8d01954c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 3380,
"upload_time": "2013-11-23T10:15:34",
"url": "https://files.pythonhosted.org/packages/f0/48/721217d49ab8a9796e6918b0b870ee3b75c9926353eb08bc85b06d04d6c5/md2ebook-0.1.tar.gz"
}
],
"0.1.1": [
{
"comment_text": "",
"digests": {
"md5": "71564bee3374bb237ba551b2d4caadc0",
"sha256": "cb0806f2f4b38cc72be59432b91a95867527ebfcd8d923f7c6c78efa4d1e1f16"
},
"downloads": -1,
"filename": "md2ebook-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "71564bee3374bb237ba551b2d4caadc0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 8698,
"upload_time": "2013-11-23T23:19:53",
"url": "https://files.pythonhosted.org/packages/31/d7/fcf27a60a53e60899064f95d8a6f9c32298a6752fe473c5081b447c23015/md2ebook-0.1.1.tar.gz"
}
]
},
"urls": [
{
"comment_text": "",
"digests": {
"md5": "71564bee3374bb237ba551b2d4caadc0",
"sha256": "cb0806f2f4b38cc72be59432b91a95867527ebfcd8d923f7c6c78efa4d1e1f16"
},
"downloads": -1,
"filename": "md2ebook-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "71564bee3374bb237ba551b2d4caadc0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 8698,
"upload_time": "2013-11-23T23:19:53",
"url": "https://files.pythonhosted.org/packages/31/d7/fcf27a60a53e60899064f95d8a6f9c32298a6752fe473c5081b447c23015/md2ebook-0.1.1.tar.gz"
}
]
}