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
-
Hannah Montana Linux Is Back!
Developer Noah Cagle decided the world needed the once obscure but beloved Linux distribution and gave it a decidedly pink refresh.
-
System76 Refreshes the Lemur Laptop
If you're looking for a laptop with tons of power and battery, look no further than the latest iteration of the System76 Lemur Pro.
-
More than 43 Million Lines of Code in Linux Kernel 7.2
Using the cloc utility, Michael Larabel of Phoronix discovered that Linux kernel 7.2 has over 43 million lines of code.
-
Kubuntu Focus Goes Ultra
The Kubuntu Focus team has upped the performance ante of its M2 and Zr laptops with the latest, greatest CPUs from Intel.
-
Linux Gamers May Soon See Less Mouse Lag in KDE Plasma
Gamers using KDE’s Plasma desktop have been suffering from a slight input delay in mouse movement that could lead to getting fragged.
-
Three Lines of Code Improve Linux Storage Performance
A developer changed three lines of code, giving Linux storage performance a 5% bump.
-
AUR Hit Again with Malicious Packages
Once again the Arch User Repository is plagued by a high volume of malicious packages.
-
Alpine Linux 3.24 Features Fresh Desktops and a Newer Kernel
If you're a fan of Alpine Linux, it's time to upgrade because the latest version has been released with KDE Plasma 6.6, Gnome 50, and Linux kernel 6.18 LTS.
-
EU Open Source Strategy Plays Key Role in Tech Sovereignty Package
Comprehensive measures adopted by the European Commission aim to reduce dependency on non-EU countries.
-
Linux Foundation Report Indicates AI Driving Tech Hiring
Within growing security and skills gaps, AI has been found to be a positive driving force behind tech hiring trends in Europe.
