Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (
Help us improve Python packaging - Donate today!

mirror text documentation to MDN

Project Description
# DocumentIt

DocumentIt renders [markdown]() syntax to HTML and uploads it to the
[Mozilla Developer Network](

It is run by:

document-it [options] manifest [manifest] [...]

See `document-it --help` for options. It will render to a local
temporary directory by default but you can specify its output with
`--dest` (although you will need to pass `--user` and `--password` to
POST data).

## Manifests

A manifest is in the form:

relative_file_path page_name

The file path is relative to the manifest.

(*TODO: more columns of options may be added in subsequent release to
e.g. specify input format and expand macros)

An example manifest is at


Currently, to POST, DocumentIt assumes `curl` is available on the
path. This is an obvious deficiency and it should be replaced with a
request from (e.g.) `urllib2`.

In addition to it would be nice to POST
to `` as well. This would allow staging
documents at `` and then moving to MDN.

There are other features that would be nice to have:

- inclusion of other files
- inclusion of `--help` documentation

In general the approach taken shouldn't compromise the general
approach that the documentation should be the documentation, not
pre-documentation. This may be achieved by the use of (e.g. regex)
macros. For instance:

append(--help.*$,shell(mozmill --help))
Release History

Release History

This version
History Node


History Node


Download Files

Download Files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
document_it-0.1.1.tar.gz (4.6 kB) Copy SHA256 Checksum SHA256 Source Aug 5, 2011

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting