CINXE.COM
Pelican – A Python Static Site Generator
<!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8" /> <meta name="description" content="Pelican static site generator" /> <meta name="keywords" content="static site generator, Python" /> <meta name="fediverse:creator" content="@pelican@fosstodon.org"> <meta http-equiv="X-UA-Compatible" content="IE=edge" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /> <title> Pelican – A Python Static Site Generator </title> <link href="https://getpelican.com/feeds/all.atom.xml" type="application/atom+xml" rel="alternate" title="Pelican – A Python Static Site Generator Atom Feed"/> <link rel="stylesheet" href="/theme/css/fonts.css" /> <link rel="stylesheet" href="/output.css" /> </head> <body> <div class="bg-primary-100"> <div class="max-w-7xl mx-auto px-4"> <nav class="flex justify-between items-center text-gray-900 py-4"> <a class="inline-flex items-center no-underline" href="https://getpelican.com/"> <div> <img class="h-6 sm:h-8 lg:h-12" src="https://getpelican.com/theme/img/logo.svg" alt="logo"/> </div> <p class="font-black sm:text-xl lg:text-3xl ml-3 leading-none">Pelican</p> </a> <div class="flex items-center"> <div> <a class="font-bold no-underline" href="https://getpelican.com/blog/">Blog</a> </div> <div class="font-bold ml-6"> <a class="no-underline" href="https://docs.getpelican.com/en/latest/">Docs</a> </div> <div class="font-bold ml-6"> <a class="no-underline" href="https://github.com/getpelican/pelican">GitHub</a> </div> </div> </nav> </div> <div class="max-w-7xl mx-auto px-4 text-gray-900 pt-8 sm:pt-16 lg:pt-32 pb-8 sm:pb-44 relative"> <header class="max-w-4xl mx-auto"> <h1 class="font-black text-3xl sm:text-5xl lg:text-7xl lg:leading-snug text_gradient"> Static site generator <br/> powered by Python </h1> <h2 class="mt-6 md:mt-8 lg:mt-12 max-w-xl font-bold sm:text-xl lg:text-2xl"> Pelican is a static site generator that requires no database or server-side logic. </h2> <div class="sm:flex items-center mt-14"> <div> <a class="btn btn_primary sm:text-xl lg:text-2xl font-bold" href="https://docs.getpelican.com/en/latest/">Read the Docs</a> </div> <div class="sm:ml-6 mt-6 sm:mt-0"> <a class="btn btn_white sm:text-xl lg:text-2xl font-bold" href="#quickstart">Quickstart</a> </div> </div> <div class="sm:absolute right-0 lg:right-32 bottom-12"> <picture> <source srcset="https://getpelican.com/theme/img/pelican.jxl" type="image/jxl" /> <source srcset="https://getpelican.com/theme/img/pelican.webp" type="image/webp" /> <img class="sm:max-w-sm lg:w-auto fluctuate_animation" src="https://getpelican.com/theme/img/pelican.png" alt="a pelican" loading="lazy" /> </picture> </div> </header> </div> </div> <div class="max-w-7xl mx-auto px-4"> <div class="max-w-7xl mx-auto px-4 mt-12 sm:mt-24"> <div class="max-w-4xl mx-auto"> <h3 class="text-4xl text_gradient font-black">Features</h3> <p class="mt-4 text-lg max-w-2xl text-gray-900"> Pelican has everything you need to build your static site. The builds are fast and it is well laid out. </p> </div> <div class="mt-8 grid grid-cols-1 sm:grid-cols-3 lg:grid-cols-4 gap-4 text-base sm:text-lg font-semibold text-gray-800"> <div class="flex items-center text-center p-4 sm:p-8 bg-primary-100 rounded-lg"> <p>Write content in reStructuredText or Markdown markup</p> </div> <div class="flex items-center text-center p-4 sm:p-8 bg-primary-100 rounded-lg"> <p>Chronological content (e.g., articles, blog posts) as well as static pages</p> </div> <div class="flex items-center text-center p-4 sm:p-8 bg-primary-100 rounded-lg"> <p>Integration with external services</p> </div> <div class="flex items-center text-center p-4 sm:p-8 bg-primary-100 rounded-lg"> <p>Site themes (created using Jinja2 templates)</p> </div> <div class="flex items-center text-center p-4 sm:p-8 bg-primary-100 rounded-lg"> <p>Publication of articles in multiple languages</p> </div> <div class="flex items-center text-center p-4 sm:p-8 bg-primary-100 rounded-lg"> <p>Generation of Atom and RSS feeds</p> </div> <div class="flex items-center text-center p-4 sm:p-8 bg-primary-100 rounded-lg"> <p>Code syntax highlighting via Pygments</p> </div> <div class="flex items-center text-center p-4 sm:p-8 bg-primary-100 rounded-lg"> <p>Import existing content from WordPress, Dotclear, or RSS feeds</p> </div> <div class="flex items-center text-center p-4 sm:p-8 bg-primary-100 rounded-lg"> <p>Fast rebuild times due to content caching and selective output writing</p> </div> <div class="flex items-center text-center p-4 sm:p-8 bg-primary-100 rounded-lg"> <p>Extensible via a rich plugin ecosystem: Pelican Plugins</p> </div> </div> </div> <div class="flex justify-center mt-12 sm:mt-24"> <picture> <source srcset="https://getpelican.com/theme/img/pelican-3.jxl" type="image/jxl" /> <source srcset="https://getpelican.com/theme/img/pelican-3.webp" type="image/webp" /> <img class="w-40 sm:max-w-xs fluctuate_animation" src="https://getpelican.com/theme/img/pelican-3.png" alt="another pelican" loading="lazy" /> </picture> </div> <div id="quickstart"></div> <div class="max-w-7xl mx-auto px-4 mt-12 sm:mt-24"> <div class="max-w-4xl mx-auto"> <h3 class="text-4xl text_gradient font-black">Quickstart</h3> <p class="mt-4 text-lg max-w-2xl text-gray-900"> Reading through all the documentation is highly recommended, but for the truly impatient, following are some quick steps to get started. </p> <div class="mt-10"> <div class="flex items-center"> <div class="rounded-full h-12 w-12 flex items-center justify-center bg-primary-shade text-xl font-black text-white"> 1 </div> <p class="ml-3 text-xl font-black">Installation</p> </div> <div class="mt-4"> <p class="mb-4 max-w-2xl">Install Pelican and Markdown.</p> <pre><code class="overflow-x-auto max-w-full inline-block rounded-lg bg-gray-100 text-black px-6 py-6">python -m pip install "pelican[markdown]"</code></pre> </div> <div class="flex items-center mt-8"> <div class="rounded-full h-12 w-12 flex items-center justify-center bg-primary-shade text-xl font-black text-white"> 2 </div> <p class="ml-3 text-xl font-black">Create a project</p> </div> <div class="mt-4"> <p class="mb-4 max-w-2xl">Create a folder for your site and create a skeleton project inside of it.</p> <pre><code class="overflow-x-auto max-w-full inline-block rounded-lg bg-gray-100 text-black px-6 py-6">mkdir -p ~/projects/yoursite cd ~/projects/yoursite pelican-quickstart </code></pre> <p class="mt-4 max-w-2xl"> When asked for your URL prefix, enter your domain name as indicated (e.g., https://example.com). </p> </div> <div class="flex items-center mt-8"> <div class="rounded-full h-12 w-12 flex items-center justify-center bg-primary-shade text-xl font-black text-white"> 3 </div> <p class="ml-3 text-xl font-black">Create an article</p> </div> <div class="mt-4"> <p class="mb-4 max-w-3xl"> Create your first article with the following content in <span class="inline_code">~/projects/yoursite/content/keyboard-review.md</span>: </p> <pre><code class="overflow-x-auto max-w-full inline-block rounded-lg bg-gray-100 text-black px-6 py-6">Title: My First Review Date: 2010-12-03 10:20 Category: Review Following is a review of my favorite mechanical keyboard.</code></pre> </div> <div class="flex items-center mt-8"> <div class="rounded-full h-12 w-12 flex items-center justify-center bg-primary-shade text-xl font-black text-white"> 4 </div> <p class="ml-3 text-xl font-black">Preview your site</p> </div> <div class="mt-4"> <pre><code class="overflow-x-auto max-w-full inline-block rounded-lg bg-gray-100 text-black px-6 py-6">pelican -r -l</code></pre> <p class="mt-4 max-w-2xl"> Preview your site by navigating to <a class="underline" href="http://localhost:8000/">http://localhost:8000/</a> in your browser. </p> </div> </div> </div> </div><div class="max-w-7xl mx-auto px-4 mt-12 sm:mt-24"> <div class="max-w-4xl mx-auto"> <h3 class="text-4xl text_gradient font-black">Support</h3> <p class="mt-4 text-lg max-w-2xl text-gray-900">Following are ways you can support Pelican’s development:</p> <ul class="list-disc list-inside text-lg mt-4"> <li> <a href="https://donate.getpelican.com/">Donate</a> to Pelican Dev Team </li> <li> Follow <a href="https://ramble.space/@justin">@justin</a> and <a rel="me" href="https://fosstodon.org/@pelican">@pelican on the Fediverse</a> </li> <li> <a href="https://github.com/getpelican">Contribute</a> pull requests, help triage issues, and improve documentation </li> </ul> </div> </div><div class="max-w-7xl mx-auto px-4 mt-12 sm:mt-24"> <div class="max-w-4xl mx-auto"> <h3 class="text-4xl text_gradient font-black">Pelican is supported by…</h3> </div> <div class="max-w-4xl mx-auto text-gray-900"> <div class="grid grid-cols-1 sm:grid-cols-3 gap-12 mt-12"> <div class="text-center"> <a class="flex justify-center" href="https://fortressa.com"> <img class="h-24 sm:h-32" src="https://getpelican.com/theme/img/fortressa-logo.svg" alt="fortressa logo"/> </a> <a class="text-lg font-bold" href="https://fortressa.com">Fortressa</a> </div> </div> </div> <div class="max-w-4xl mx-auto mt-12"> <p class="mt-4 text-xl max-w-2xl text-gray-900">Thank you! ❤️</p> </div> </div> <div class="flex justify-end mt-12"> <picture> <source srcset="https://getpelican.com/theme/img/pelican-4.jxl" type="image/jxl" /> <source srcset="https://getpelican.com/theme/img/pelican-4.webp" type="image/webp" /> <img class="h-48 sm:h-auto" src="https://getpelican.com/theme/img/pelican-4.png" alt="another pelican" loading="lazy" /> </picture> </div> </div> <footer class="bg-primary text-white py-16"> <div class="max-w-7xl mx-auto px-4 grid grid-cols-1 sm:grid-cols-5"> <div class="col-span-2"> <p class="font-black sm:text-xl text-3xl leading-none pb-6 sm:pb-0">Pelican</p> </div> <div> <p class="font-bold text-xl">Links</p> <ul class="mt-4"> <li class="mt-2"> <a class="text-white" href="https://getpelican.com/blog/">Blog</a> </li> <li class="mt-2"> <a class="text-white" href="https://docs.getpelican.com/en/latest/">Docs</a> </li> <li class="mt-2"> <a class="text-white" href="https://github.com/getpelican/pelican">GitHub</a> </li> <li class="mt-2"> <a class="text-white" href="https://getpelican.com/gratitude/">Gratitude</a> </li> </ul> </div> <div> <p class="font-bold text-xl">Support</p> <ul class="mt-4"> <li class="mt-2"> <a class="text-white" href="https://donate.getpelican.com/">Donate</a> </li> <li class="mt-2"> <a class="text-white" href="https://github.com/getpelican/pelican">Code</a> </li> </ul> </div> <div class="pt-6 sm:pt-0"> <p class="font-bold text-xl">Follow</p> <ul class="mt-4"> <li class="mt-2"> <a class="text-white" href="https://getpelican.com/feeds/all.atom.xml">Feed</a> </li> <li class="mt-2"> <a class="text-white" href="https://fosstodon.org/@pelican">@pelican</a> </li> <li class="mt-2"> <a class="text-white" href="https://ramble.space/@justin">@justin</a> </li> </ul> </div> </div> <div class="max-w-7xl mx-auto px-4 mt-8 sm:mt-12 flex justify-center"> <div class="inline-flex items-center justify-center"> <p class="text-center"> Powered by <a class="text-white" href="https://fortressa.com/">Fortressa</a> </p> <img class="h-10 ml-2" src="https://getpelican.com/theme/img/fortressa-logo.svg" alt="fortressa logo"/> </div> </div> </footer> </body> </html>