Pelican plugins

The Pel­i­can theme pro­vid­ed by m.css us­es on­ly a part of the func­tion­al­i­ty on its own, the rest is ex­posed by var­i­ous plug­ins.

Us­age

Each plug­in is a stand­alone *.py file that is meant to be down­load­ed and put in­to a m/ sub­di­rec­to­ry in­to one of your PLUGIN_PATHS. Then you add giv­en m.something pack­age to your PLUGINS in pelicanconf.py and restart Pel­i­can. Down­load the plug­ins be­low or grab the whole Git re­pos­i­to­ry:

Click on the head­ings be­low to get to know more. Note that par­tic­u­lar plug­ins can have ad­di­tion­al de­pen­den­cies be­sides just Pel­i­can, see doc­u­men­ta­tion of each of them to see more.

HTML san­i­ty »

The m.htmlsanity plug­in is es­sen­tial for m.css. It makes your markup valid HTM­L5, of­fers a few opt-in ty­po­graph­i­cal im­prove­ments and en­ables you to make full use of fea­tures pro­vid­ed by oth­er plug­ins.

Com­po­nents »

All CSS com­po­nents are ex­posed by the m.components plug­in, so you can use them via reST di­rec­tives with­out need­ing to touch HTML and CSS di­rect­ly.

Im­ages »

Im­age-re­lat­ed CSS com­po­nents are im­ple­ment­ed by the m.images plug­in, over­rid­ing builtin reST func­tion­al­i­ty and pro­vid­ing a con­ve­nient au­to­mat­ic way to ar­range pho­tos in an im­age grid.

Math and code »

The m.math and m.code plug­ins use ex­ter­nal li­braries for math ren­der­ing and syn­tax high­light­ing, so they are pro­vid­ed as sep­a­rate pack­ages that you can but don’t have to use. With these, math and code snip­pets can be en­tered di­rect­ly in your reST sources.

Links »

The m.gh, m.dox, m.gl, m.abbr and m.fiilesize plug­ins make it easy for you to link to GitHub projects, is­sues or PRs, to Doxy­gen doc­u­men­ta­tion and do more use­ful things.

Meta­da­ta »

With the m.metadata plug­in it’s pos­si­ble to as­sign ad­di­tion­al de­scrip­tion and im­ages to au­thors, cat­e­gories and tags. The in­for­ma­tion can then ap­pear on ar­ti­cle list­ing page, as a badge un­der the ar­ti­cle or be added to so­cial meta tags.