Skip to main content

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))

Project details

Download files

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

Source Distribution

document_it-0.1.tar.gz (4.5 kB view hashes)

Uploaded source

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page