Installation¶

Install Pelican (and optionally Markdown if you intend to use it) on Python>=3.9 by running the following command in your preferred terminal, prefixingwithsudo if permissions warrant:

python-mpipinstall"pelican[markdown]"

Create a project¶

First, choose a name for your project, create an appropriately-named directoryfor your site, and switch to that directory:

mkdir-p~/projects/yoursitecd~/projects/yoursite

Create a skeleton project via thepelican-quickstart command, which beginsby asking some questions about your site:

pelican-quickstart

For questions that have default values denoted in brackets, feel free to usethe Return key to accept those default values[1]. When asked foryour URL prefix, enter your domain name as indicated (e.g.,https://example.com).

Create an article¶

You cannot run Pelican until you have created some content. Use your preferredtext editor to create your first article with the following content:

Title:MyFirstReviewDate:2010-12-0310:20Category:ReviewFollowingisareviewofmyfavoritemechanicalkeyboard.

Given that this example article is in Markdown format, save it as~/projects/yoursite/content/keyboard-review.md.

Generate your site¶

From your project root directory, run thepelican command to generate your site:

pelicancontent

Your site has now been generated inside theoutput/ directory. (You may seea warning related to feeds, but that is normal when developing locally and canbe ignored for now.)

Preview your site¶

Open a new terminal session, navigate to your project root directory, andrun the following command to launch Pelican’s web server:

pelican--listen

Preview your site by navigating tohttp://localhost:8000/ in your browser.

Continue reading the other documentation sections for more detail, and checkout the Pelican wiki’sTutorials page for links to community-publishedtutorials.

Footnotes¶

You can help localize default fields by installing theoptionaltzlocalmodule.