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
-
Endless OS 6 has Arrived
After more than a year since the last update, the latest release of Endless OS is now available for general usage.
-
Fedora Asahi 40 Remix Available for Macs with Apple Silicon
If you've been anticipating KDE's Plasma 6 for your Apple Silicon-powered Mac, then you're in luck.
-
Red Hat Adds New Deployment Option for Enterprise Linux Platforms
Red Hat has re-imagined enterprise Linux for an AI future with Image Mode.
-
OSJH and LPI Release 2024 Open Source Pros Job Survey Results
See what open source professionals look for in a new role.
-
Proton 9.0-1 Released to Improve Gaming with Steam
The latest release of Proton 9 adds several improvements and fixes an issue that has been problematic for Linux users.
-
So Long Neofetch and Thanks for the Info
Today is a day that every Linux user who enjoys bragging about their system(s) will mourn, as Neofetch has come to an end.
-
Ubuntu 24.04 Comes with a “Flaw"
If you're thinking you might want to upgrade from your current Ubuntu release to the latest, there's something you might want to consider before doing so.
-
Canonical Releases Ubuntu 24.04
After a brief pause because of the XZ vulnerability, Ubuntu 24.04 is now available for install.
-
Linux Servers Targeted by Akira Ransomware
A group of bad actors who have already extorted $42 million have their sights set on the Linux platform.
-
TUXEDO Computers Unveils Linux Laptop Featuring AMD Ryzen CPU
This latest release is the first laptop to include the new CPU from Ryzen and Linux preinstalled.