{ "info": { "author": "Jason Moiron", "author_email": "jmoiron@jmoiron.net", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Environment :: Console", "License :: OSI Approved :: MIT License", "Operating System :: POSIX" ], "description": "redtape\n-------\n\n``redtape`` is a focused *document* generator that uses `github flavored markdown`_\nto generate simple, attractive HTML documents. It automatically integrates with\n`twitter bootstrap`_ and features simple, attractive styling. It is inspired by\n`d`_, but attempts to have a simple interface while still allowing users to style\nand control their output documents to a high degree of customization.\n\n.. _github flavored markdown: http://github.github.com/github-flavored-markdown/\n.. _twitter bootstrap: http://twitter.github.com/bootstrap\n.. _d: http://stevelosh.com/projects/d/\n\ninstalling\n----------\n\nIf you are on linux or OSX, you can use `pip`_ to install::\n\n > pip install redtape\n\nWhich will install redtape and its dependencies. \n\n.. _pip: http://www.pip-installer.org/en/latest/index.html\n\nusage\n-----\n\nTo use, run ``rt`` on a document or directory full of documents. If run on\na directory, ``rt`` will create html files for every markdown file (``.md``,\n``.mdown``, or ``.markdown`` extensions)::\n\n > rt mydocument.md\n > rt documentation/\n\nassets\n------\n\nBy default, ``rt`` assumes you have set up a location to serve the files from\nwhich have the assets that ``rt`` links into these documents. The layout is\nexactly the same as the `assets directory`_ in the redtape repository:\n``/assets/{css,img,js}/..`` for each asset that you will be using. If you want\nto use redtape's default assets, you can easily create a suitable asset\ndirectory in the current directory by running::\n\n > rt --create-assets\n\nIf you are running in single document mode or do not wish to set up an asset\ndirectory on the eventual host for your HTML documents, you can tell redtape to\nembed each asset used in a document by using ``--embed``::\n\n > rt --embed mydocument.md\n\n.. _assets directory: https://github.com/jmoiron/redtape/blob/master/redtape/script.py\n\njavascript\n~~~~~~~~~~\n\nBy default, ``redtape`` not require any javascript to run, and will not embed\nany in ``--embed`` mode. If the ``--prettify`` option is selected, google's\nprettify library will be used for source highlighting instead of `pygments`_,\nand if ``--prettify`` and ``--embed`` are both used, it will be automatically\nembedded.\n\nRedtape is also suitable for simple single-page javascript demonstrations, and\nif ``--use-js`` is enabled, redtape will include `jquery`_ and bootstrap's\njavascript libraries.\n\n.. _pygments: http://pygments.org\n.. _jquery: http://jquery.org\n\ncustomizing output\n------------------\n\nCustomizing output is easy to do in a variety of ways. Besides changing the\nasset CSS for non-embedded documents, you can also add headers and footers or\neven use custom document templates based on redtape's default template.\n\nheaders and footers\n~~~~~~~~~~~~~~~~~~~\n\nIf you have a customized document header or footer you want added to your\ndocuments, you can either add ``header.html`` and ``footer.html`` documents\nto the base directory you are rendering or set default paths to be used \nin the config as ``header`` and ``footer``. By default, these will be\nplaced at the top and bottom of your document, respectively.\n\nA sample set of documents could be::\n\n > ls mydocs/\n mydocs/index.md mydocs/simple.md mydocs/advanced.md\n mydocs/header.html mydocs/footer.html\n\nRendering mydocs with ``rt mydocs`` will use the header and footer for each\ndocument in the directory.\n\ncustom templates\n~~~~~~~~~~~~~~~~\n\nIf you have very specific requirements, you can write your own document\ntemplate and have total control of the output. Redtape uses the `jinja2`_\ntemplating engine, which is a widely used templating system similar to\ndjango templates. Run redtape with the ``--context`` argument to get a brief\nidea of what variables are available to the template.\n\nYou can also inherit from ``basic.jinja``, which is the name of redtape's\ndefault template. This template defines two blocks, ``head`` and ``body``,\nwhich would allow you to craft a distinct document body while, for instance,\nretaining the basic CSS and JavaScript functionality of redtape. Overriding\nboth will leave you with a standard HTML5 document structure.\n\nYou can specify a custom template to use with ``-t, --template`` or place\nit in the document directory as ``custom.html`` or ``custom.jinja``.\n\n.. _jinja2: http://jinja.pocoo.org/docs/\n\nsample output\n-------------\n\n.. image:: http://jmoiron.net/~jmoiron/i/sldriiq.png", "description_content_type": null, "docs_url": null, "download_url": "UNKNOWN", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "http://github.com/jmoiron/redtape", "keywords": "github markdown documentation quick small simple", "license": "MIT", "maintainer": null, "maintainer_email": null, "name": "redtape", "package_url": "https://pypi.org/project/redtape/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/redtape/", "project_urls": { "Download": "UNKNOWN", "Homepage": "http://github.com/jmoiron/redtape" }, "release_url": "https://pypi.org/project/redtape/1.2/", "requires_dist": null, "requires_python": null, "summary": "simple tiny document generator", "version": "1.2" }, "last_serial": 798717, "releases": { "1.0": [ { "comment_text": "", "digests": { "md5": "5f618f84a771bf8143ee0d2357e3a2f9", "sha256": "66e5dc28f595c5a6f7fd9b55f4fcb9401dcfb58a0d56d24746b0524713ee90ee" }, "downloads": -1, "filename": "redtape-1.0.tar.gz", "has_sig": false, "md5_digest": "5f618f84a771bf8143ee0d2357e3a2f9", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 87726, "upload_time": "2012-03-25T06:20:45", "url": "https://files.pythonhosted.org/packages/8c/1e/c03639af1fcdcf173a0b3426bd9a0da4cc6a043147df898b8faf6bb272d8/redtape-1.0.tar.gz" } ], "1.1": [ { "comment_text": "", "digests": { "md5": "e02d5d1d9bd485457350b5da413d721c", "sha256": "b423f21959283a5ab90b1ab77e77d8f807fb69446243f0c5c0fc8deb76a83fe4" }, "downloads": -1, "filename": "redtape-1.1.tar.gz", "has_sig": false, "md5_digest": "e02d5d1d9bd485457350b5da413d721c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 87741, "upload_time": "2012-03-25T16:05:53", "url": "https://files.pythonhosted.org/packages/42/3e/ebefa08a8432752befcc2d73100d36916b66e06ae1d4d183ac677e45d56d/redtape-1.1.tar.gz" } ], "1.2": [ { "comment_text": "", "digests": { "md5": "b524bcd195bba8b159102cc032246810", "sha256": "b3ce01cd001ac6e7db76f565e4b41f58bc7c729a063a36451b406bfbb156ff2b" }, "downloads": -1, "filename": "redtape-1.2.tar.gz", "has_sig": false, "md5_digest": "b524bcd195bba8b159102cc032246810", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 87754, "upload_time": "2012-11-03T08:01:36", "url": "https://files.pythonhosted.org/packages/cb/a9/553e2ff0b4f0085e11ee6e1930a939180b2a676e629de58aee69a26449f6/redtape-1.2.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "b524bcd195bba8b159102cc032246810", "sha256": "b3ce01cd001ac6e7db76f565e4b41f58bc7c729a063a36451b406bfbb156ff2b" }, "downloads": -1, "filename": "redtape-1.2.tar.gz", "has_sig": false, "md5_digest": "b524bcd195bba8b159102cc032246810", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 87754, "upload_time": "2012-11-03T08:01:36", "url": "https://files.pythonhosted.org/packages/cb/a9/553e2ff0b4f0085e11ee6e1930a939180b2a676e629de58aee69a26449f6/redtape-1.2.tar.gz" } ] }