Skip to main content
Donate to the Python Software Foundation or Purchase a PyCharm License to Benefit the PSF! Donate Now

Markdown-oriented content authoring for Axilent.

Project description

Dox
===

Markdown-oriented content authoring for Axilent.

Basic Idea
----

Installation

pip install Axilent-Dox


Initialization

cd mydocs
dox init --library-key=abc123 --project=My\ Project --content-type=Article --body-field=body

Post Content

touch "Hello World" > hello.md
dox up

Update Content

touch "Yo, whazzzup" > hello.md
dox up

Known Limitations
---

* Only one content type supported.
* S3 Asset Fields not supported.
* Due to the limitations of the Markdown parser, only the ASCII character set is supported.

Other TODOs
---

Dox depends on [Sharrock](http://github.com/Axilent/sharrock), which currently requires a full installation of Django. However Dox only really needs the Sharrock client – not the server capabilities. In the future we'll package up a client-only version of Sharrock, and Dox will use that, negating the need for a full Django install.

Project details


Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
Axilent-Dox-0.1.4.tar.gz (6.3 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page