mirror text documentation to MDN
Project description
# DocumentIt
DocumentIt renders [markdown]() syntax to HTML and uploads it to the
[Mozilla Developer Network](https://developer.mozilla.org/)
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
http://k0s.org/mozilla/hg/DocumentIt/file/tip/example.manifest
## TODO
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 http://developer.mozilla.org it would be nice to POST
to `http://wiki.mozilla.org` as well. This would allow staging
documents at `wiki.mozilla.org` 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))
DocumentIt renders [markdown]() syntax to HTML and uploads it to the
[Mozilla Developer Network](https://developer.mozilla.org/)
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
http://k0s.org/mozilla/hg/DocumentIt/file/tip/example.manifest
## TODO
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 http://developer.mozilla.org it would be nice to POST
to `http://wiki.mozilla.org` as well. This would allow staging
documents at `wiki.mozilla.org` 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
Release history Release notifications | RSS feed
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.1.tar.gz
(4.6 kB
view details)
File details
Details for the file document_it-0.1.1.tar.gz
.
File metadata
- Download URL: document_it-0.1.1.tar.gz
- Upload date:
- Size: 4.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | d8ade28736bbd6e622d34bbc544d6e22cc495efe5f6ae8b9031f64ba598f02da |
|
MD5 | c95b13944d896ea9c90edcdbf39e0a0e |
|
BLAKE2b-256 | cdd1a5f4fcff2994723b52ab314a4f8e803cad947312b8ba933dc89afda2bc7f |