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
Direct Download
Read full article as PDF:
Price $2.95
Subscribe to our Linux Newsletters
Find Linux and Open Source Jobs
Subscribe to our ADMIN Newsletters
Find SysAdmin Jobs
News
-
CarbonOS: A New Linux Distro with a Focus on User Experience
CarbonOS is a brand new, built-from-scratch Linux distribution that uses the Gnome desktop and has a special feature that makes it appealing to all types of users.
-
Kubuntu Focus Announces XE Gen 2 Linux Laptop
Another Kubuntu-based laptop has arrived to be your next ultra-portable powerhouse with a Linux heart.
-
MNT Seeks Financial Backing for New Seven-Inch Linux Laptop
MNT Pocket Reform is a tiny laptop that is modular, upgradable, recyclable, reusable, and ships with Debian Linux.
-
Ubuntu Flatpak Remix Adds Flatpak Support Preinstalled
If you're looking for a version of Ubuntu that includes Flatpak support out of the box, there's one clear option.
-
Gnome 44 Release Candidate Now Available
The Gnome 44 release candidate has officially arrived and adds a few changes into the mix.
-
Flathub Vying to Become the Standard Linux App Store
If the Flathub team has any say in the matter, their product will become the default tool for installing Linux apps in 2023.
-
Debian 12 to Ship with KDE Plasma 5.27
The Debian development team has shifted to the latest version of KDE for their testing branch.
-
Planet Computers Launches ARM-based Linux Desktop PCs
The firm that originally released a line of mobile keyboards has taken a different direction and has developed a new line of out-of-the-box mini Linux desktop computers.
-
Ubuntu No Longer Shipping with Flatpak
In a move that probably won’t come as a shock to many, Ubuntu and all of its official spins will no longer ship with Flatpak installed.
-
openSUSE Leap 15.5 Beta Now Available
The final version of the Leap 15 series of openSUSE is available for beta testing and offers only new software versions.