Building a website in Markdown with Pandoc
Slides
Pandoc has built-in support for slideshows and supports several different slideshow standards. Regardless of which output format you wish to use, the format of your source document will be in Markdown.
Begin each slide with a horizontal rule. A slide-level header also starts a new slide. If you want to have notes available while you are present, just add them using the ::: notes
tag, closing it with :::
.
Adding notes is really simple; styling them is a little trickier – CSS to the rescue. If you are using reveal.js, you set all variables as you would without Pandoc. Otherwise, you can set styling using a directory under your Pandoc $DATA-DIR$
– usually ~/.pandoc
; standards are available in the system directory.
The command is the same as usual – just choose the output format you like.
pandoc -t slidy -i slideshow.md -o site/slideshow.html -s
You should be able to pick up more information from the web sites that support the slideshow standards.
Converting to HTML
One command with many input files will create one output file. A more conventional approach is to create one page for each of the parts of your site. This approach also enables blogging-like functions, if you do it right. The simple script for creating multiple output files is shown in Listing 7.
Listing 7
Multiple Output Files
#! /usr/bin/env bash for page in $(ls pages); do pandoc --from markdown_github+smart+yaml_metadata_block+auto_identifiers "pages/$page" \ -o "public/$(basename $page .md).html" \ --template templates/page.html\ -V navigation="$(cat navigation.html)" \ -V footer="$(cat footer.html)" done
To use the script in Listing 7, you have to create the tree structure, including a pages/
directory that has all the pages for your site. On top of the pages/
directory, you have the templates and files that the command references (templates/page.html
, navigation.html
, and footer.html
). The complete code is available online [5].
To take full advantage of these templates, and make your own template, look through the code, and set any necessary variables.
MkPage
A good front end can make things easier. One such front end is MkPage [6].
The MkPage Project uses Pandoc and its template language and adds a few tools, allowing you to define the entire site in a small project directory. All the tools follow *nix standards. To run MkPage, you set values on the command line that matches the variables in your template file.
You can use all tools in the project separately. Available tools include the main MkPage tool, as well as a tool called BlogIt and others. As you might guess, the BlogIt tool lets you write all your blog posts in Markdown.
« Previous 1 2 3 4 Next »
Buy this article as PDF
(incl. VAT)
Buy Linux Magazine
Subscribe 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
-
Latest Cinnamon Desktop Releases with a Bold New Look
Just in time for the holidays, the developer of the Cinnamon desktop has shipped a new release to help spice up your eggnog with new features and a new look.
-
Armbian 24.11 Released with Expanded Hardware Support
If you've been waiting for Armbian to support OrangePi 5 Max and Radxa ROCK 5B+, the wait is over.
-
SUSE Renames Several Products for Better Name Recognition
SUSE has been a very powerful player in the European market, but it knows it must branch out to gain serious traction. Will a name change do the trick?
-
ESET Discovers New Linux Malware
WolfsBane is an all-in-one malware that has hit the Linux operating system and includes a dropper, a launcher, and a backdoor.
-
New Linux Kernel Patch Allows Forcing a CPU Mitigation
Even when CPU mitigations can consume precious CPU cycles, it might not be a bad idea to allow users to enable them, even if your machine isn't vulnerable.
-
Red Hat Enterprise Linux 9.5 Released
Notify your friends, loved ones, and colleagues that the latest version of RHEL is available with plenty of enhancements.
-
Linux Sees Massive Performance Increase from a Single Line of Code
With one line of code, Intel was able to increase the performance of the Linux kernel by 4,000 percent.
-
Fedora KDE Approved as an Official Spin
If you prefer the Plasma desktop environment and the Fedora distribution, you're in luck because there's now an official spin that is listed on the same level as the Fedora Workstation edition.
-
New Steam Client Ups the Ante for Linux
The latest release from Steam has some pretty cool tricks up its sleeve.
-
Gnome OS Transitioning Toward a General-Purpose Distro
If you're looking for the perfectly vanilla take on the Gnome desktop, Gnome OS might be for you.