Pelican Documentation Release 3.6.3 Alexis Métaireau October13,2015 Contents 1 Features 3 2 Whythename“Pelican”? 5 3 Sourcecode 7 4 Howtogethelp,contribute,orprovidefeedback 9 5 Documentation 11 5.1 Quickstart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 5.2 InstallingPelican . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 5.3 Writingcontent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14 5.4 Publishyoursite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 5.5 Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25 5.6 Creatingthemes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36 5.7 Plugins . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43 5.8 pelican-themes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47 5.9 Importinganexistingsite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48 5.10 FrequentlyAskedQuestions(FAQ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50 5.11 Tips . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54 5.12 Contributingandfeedbackguidelines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56 5.13 Pelicaninternals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62 5.14 SomehistoryaboutPelican . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63 5.15 Releasehistory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66 i ii PelicanDocumentation,Release3.6.3 Pelicanisastaticsitegenerator,writteninPython. Highlightsinclude: • WriteyourcontentdirectlywithyoureditorofchoiceinreStructuredTextorMarkdownformats • IncludesasimpleCLItoolto(re)generateyoursite • Easytointerfacewithdistributedversioncontrolsystemsandwebhooks • Completelystaticoutputiseasytohostanywhere Readytogetstarted? CheckouttheQuickstartguide. Contents 1 PelicanDocumentation,Release3.6.3 2 Contents 1 CHAPTER Features Pelican3currentlysupports: • Articles(e.g.,blogposts)andpages(e.g.,“About”,“Projects”,“Contact”) • Comments,viaanexternalservice(Disqus). Ifyouprefertohavemorecontroloveryourcommentdata,self- hostedcommentsareanotheroption. CheckoutthePelicanPluginsrepositoryformoredetails. • Themingsupport(themesarecreatedusingJinja2templates) • Publicationofarticlesinmultiplelanguages • Atom/RSSfeeds • Codesyntaxhighlighting • ImportfromWordPress,Dotclear,orRSSfeeds • Integrationwithexternaltools: Twitter,GoogleAnalytics,etc. (optional) • Fastrebuildtimesthankstocontentcachingandselectiveoutputwriting 3 PelicanDocumentation,Release3.6.3 4 Chapter1. Features 2 CHAPTER Why the name “Pelican”? “Pelican”isananagramforcalepin,whichmeans“notebook”inFrench. ;) 5 PelicanDocumentation,Release3.6.3 6 Chapter2. Whythename“Pelican”?

Pelican Documentation PDF

76 Pages

2015

0.38 MB

English

Checking for file health...

Preview Pelican Documentation

Pelican Documentation Release 3.6.3 Alexis Métaireau October13,2015 Contents 1 Features 3 2 Whythename“Pelican”? 5 3 Sourcecode 7 4 Howtogethelp,contribute,orprovidefeedback 9 5 Documentation 11 5.1 Quickstart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 5.2 InstallingPelican . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 5.3 Writingcontent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14 5.4 Publishyoursite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 5.5 Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25 5.6 Creatingthemes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36 5.7 Plugins . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43 5.8 pelican-themes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47 5.9 Importinganexistingsite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48 5.10 FrequentlyAskedQuestions(FAQ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50 5.11 Tips . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54 5.12 Contributingandfeedbackguidelines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56 5.13 Pelicaninternals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62 5.14 SomehistoryaboutPelican . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63 5.15 Releasehistory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66 i ii PelicanDocumentation,Release3.6.3 Pelicanisastaticsitegenerator,writteninPython. Highlightsinclude: • WriteyourcontentdirectlywithyoureditorofchoiceinreStructuredTextorMarkdownformats • IncludesasimpleCLItoolto(re)generateyoursite • Easytointerfacewithdistributedversioncontrolsystemsandwebhooks • Completelystaticoutputiseasytohostanywhere Readytogetstarted? CheckouttheQuickstartguide. Contents 1 PelicanDocumentation,Release3.6.3 2 Contents 1 CHAPTER Features Pelican3currentlysupports: • Articles(e.g.,blogposts)andpages(e.g.,“About”,“Projects”,“Contact”) • Comments,viaanexternalservice(Disqus). Ifyouprefertohavemorecontroloveryourcommentdata,self- hostedcommentsareanotheroption. CheckoutthePelicanPluginsrepositoryformoredetails. • Themingsupport(themesarecreatedusingJinja2templates) • Publicationofarticlesinmultiplelanguages • Atom/RSSfeeds • Codesyntaxhighlighting • ImportfromWordPress,Dotclear,orRSSfeeds • Integrationwithexternaltools: Twitter,GoogleAnalytics,etc. (optional) • Fastrebuildtimesthankstocontentcachingandselectiveoutputwriting 3 PelicanDocumentation,Release3.6.3 4 Chapter1. Features 2 CHAPTER Why the name “Pelican”? “Pelican”isananagramforcalepin,whichmeans“notebook”inFrench. ;) 5 PelicanDocumentation,Release3.6.3 6 Chapter2. Whythename“Pelican”?

See more

The list of books you might like

Most books are stored in the elastic cloud where traffic is expensive. For this reason, we have a limit on daily download.