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
-
Linux Mint 22.3 Now Available with New Tools
Linux Mint 22.3 has been released with a pair of new tools for system admins and some pretty cool new features.
-
New Linux Malware Targets Cloud-Based Linux Installations
VoidLink, a new Linux malware, should be of real concern because of its stealth and customization.
-
Say Goodbye to Middle-Mouse Paste
Both Gnome and Firefox have proposed getting rid of a long-time favorite Linux feature.
-
Manjaro 26.0 Primary Desktop Environments Default to Wayland
If you want to stick with X.Org, you'll be limited to the desktop environments you can choose.
-
Mozilla Plans to AI-ify Firefox
With a new CEO in control, Mozilla is doubling down on a strategy of trust, all the while leaning into AI.
-
Gnome Says No to AI-Generated Extensions
If you're a developer wanting to create a new Gnome extension, you'd best set aside that AI code generator, because the extension team will have none of that.
-
Parrot OS Switches to KDE Plasma Desktop
Yet another distro is making the move to the KDE Plasma desktop.
-
TUXEDO Announces Gemini 17
TUXEDO Computers has released the fourth generation of its Gemini laptop with plenty of updates.
-
Two New Distros Adopt Enlightenment
MX Moksha and AV Linux 25 join ranks with Bodhi Linux and embrace the Enlightenment desktop.
-
Solus Linux 4.8 Removes Python 2
Solus Linux 4.8 has been released with the latest Linux kernel, updated desktops, and a key removal.
