Generate Online Documentation in a Jiffy Using d

Dmitri Popov

Productivity Sauce

Mar 14, 2012 GMT
Dmitri Popov

Turning a bunch of text files into nicely-formatted online documentation can be a real chore, unless you use a helper tool like d. This Python-based software can convert text files formatted using the Markdown markup into a ready-to-publish set of HTML pages. To deploy d on your system, you need to install a few packages. On the latest version of Ubuntu and its derivatives, you can do this by running the following commands:

sudo apt-get install python-pip python-dev build-essential libxml2-dev libxslt1-dev
sudo pip install --upgrade pip 
sudo pip install --upgrade virtualenv
sudo pip install d

On Debian and earlier Ubuntu releases, you can install d using the easy_setup tool:

apt-get install build-essential python-dev python-setuptools libxml2-dev libxslt1-dev
sudo easy_setup d

Using d to generate documentation couldn't be easier: switch to a directory containing formatted text files (the files must have .markdown, .mdown, or .md), and run the d command in the terminal. You can then find the generated HTML pages along with the accompanying files in the build folder of the current directory. Upload the files in the build folder to your web server, and you are done. That's all there is to it. You might want to consult the Usage page for a few tips on using d.

comments powered by Disqus

Issue 163/2014

Buy this issue as a PDF

Digital Issue: Price $9.99
(incl. VAT)

News