Pel­i­can is a stat­ic site gen­er­a­tor pow­ered by Python and un­like most oth­er stat­ic site gen­er­a­tors, it us­es re­Struc­tured­Text in­stead of Mark­down for au­thor­ing con­tent. m.css pro­vides a theme for it, to­geth­er with a set of use­ful plug­ins.

Quick start

In­stall Pel­i­can ei­ther via pip or us­ing your sys­tem pack­age man­ag­er.

# You may need sudo here
pip3 install pelican

Note that us­ing the m.css theme or Pel­i­can plug­ins may re­quire ad­di­tion­al de­pen­den­cies than just Pel­i­can — doc­u­men­ta­tion of each lists the ad­di­tion­al re­quire­ments, if any. Once you have Pel­i­can in­stalled, cre­ate a di­rec­to­ry for your web­site and boot­strap it:

mkdir ~/my-cool-site/
cd ~/my-cool-site/

This com­mand will ask you a few ques­tions. You don’t need the URL pre­fix for now, but you def­i­nite­ly want a Make­file and an au­to-reload script to be gen­er­at­ed. Leave the rest at its de­faults. Once the quick­start script fin­ish­es, you can run the au­to-reload­ing like this:

make devserver

It will print quite some out­put about pro­cess­ing things and serv­ing the da­ta to the con­sole. Open your fresh web­site at http://lo­cal­host:8000. The site is now emp­ty, so let’s cre­ate a sim­ple ar­ti­cle and put it in­to content/ sub­di­rec­to­ry with a .rst ex­ten­sion. For this ex­am­ple that would be ~/my-cool-site/content/my-cool-article.rst:

My cool article

:date: 2017-09-14 23:04
:category: Cool things
:tags: cool, article, mine
:summary: This article has a cool summary.

This article has not only cool summary, but also has cool contents. Lorem?
*Ipsum.* `Hi, google! <>`_

If you did ev­ery­thing right, the au­to-reload script should pick the file up and process it (check the con­sole out­put). Then it’s just a mat­ter of re­fresh­ing your brows­er to see it on the page.

That’s it! Con­grat­u­la­tions, you suc­cess­ful­ly made your first steps with Pel­i­can. The de­fault theme might be a bit un­der­whelm­ing, so let’s fix that. Click on the head­ers be­low to get to know more.

Writ­ing con­tent »

Quick guide and tips for writ­ing con­tent us­ing reST. Chances are that you al­ready know your way around from Sphinx or oth­er doc­u­men­ta­tion tools, nev­er­the­less there are some hid­den tricks that you might not know about yet.

Theme »

A fea­ture-packed theme with mod­ern and re­spon­sive de­sign that ex­pos­es all of m.css func­tion­al­i­ty with good­ies on top such as so­cial meta tags, bread­crumb nav­i­ga­tion and more.