Generate Online Documentation in a Jiffy Using d
Productivity Sauce
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 DisqusSubscribe to our Linux Newsletters
Find Linux and Open Source Jobs
Subscribe to our ADMIN Newsletters
Support Our Work
Linux Magazine content is made possible with support from readers like you. Please consider contributing when you’ve found an article to be beneficial.
News
-
Framework Laptop 13 Pro Competes with the Best
Framework has released what might be considered the MacBook of Linux devices.
-
The Latest CachyOS Features Supercharged Kernel
The latest release of CachyOS brings with it an enhanced version of the latest Linux kernel.
-
Kernel 7.0 Is a Bit More Rusty
Linux kernel 7.0 has been released for general availability, with Rust finally getting its due.
-
France Says "Au Revoir" to Microsoft
In a move that should surprise no one, France announced plans to reduce its reliance on US technology, and Microsoft Windows is the first to get the boot.
-
CIQ Releases Compatibility Catalog for Rocky Linux
The company behind Rocky Linux is making an open catalog available to developers, hobbyists, and other contributors, so they can verify and publish compatibility with the CIQ lineup.
-
KDE Gets Some Resuscitation
KDE is bringing back two themes that vanished a few years ago, putting a bit more air under its wings.
-
Ubuntu 26.04 Beta Arrives with Some Surprises
Ubuntu 26.04 is almost here, but the beta version has been released, and it might surprise some people.
-
Ubuntu MATE Dev Leaving After 12 years
Martin Wimpress, the maintainer of Ubuntu MATE, is now searching for his successor. Are you the next in line?
-
Kali Linux Waxes Nostalgic with BackTrack Mode
For those who've used Kali Linux since its inception, the changes with the new release are sure to put a smile on your face.
-
Gnome 50 Smooths Out NVIDIA GPU Issues
Gamers rejoice, your favorite pastime just got better with Gnome 50 and NVIDIA GPUs.
