Written by: Geoffrey Callaghan

pelican tutorial

Pelican Tutorial

Sure! Pelican is a static site generator written in Python, and here’s a step-by-step tutorial to get you started:

  1. Installation: First, ensure you have Python installed on your machine. You can download and install Python from the official Python website. Once Python is installed, you can install Pelican using pip, the Python package manager:

    pip install pelican
  2. Create a New Site: Once Pelican is installed, create a new directory for your Pelican project and navigate into it. Then, initialize a new Pelican site:


    This command will guide you through a series of prompts to set up your Pelican project. You’ll be asked to provide information such as your site’s title, author name, URL, and other settings.

  3. Write Content: Pelican uses reStructuredText, Markdown, or AsciiDoc for content creation. You can start writing your content using any of these formats. By default, Pelican sets up a content directory where you can store your content files.

  4. Customize Your Theme: Pelican comes with a default theme, but you can customize it or use a different theme to change the appearance of your site. You can find Pelican themes on the Pelican Themes GitHub repository. Download the theme you like and place it in the themes directory of your Pelican project.

  5. Generate Your Site: Once you have written your content and customized your theme (if necessary), generate your site by running the following command:

    pelican content

    This command will process the content in your content directory and generate the static HTML files for your site. The generated files will be placed in the output directory by default.

  6. Preview Your Site: You can preview your site locally by running Pelican’s built-in development server:

    pelican --listen

    This command will start a local web server, and you can view your site by navigating to http://localhost:8000 in your web browser.

  7. Deployment: Once you’re happy with your site, you can deploy it to your chosen hosting platform. Pelican generates static HTML files, so you can deploy your site to any web server that supports static file hosting. You can use FTP, Git, or any other method to upload the generated files to your server.

That’s a basic overview to help you get started with Pelican. As you become more familiar with Pelican, you can explore its documentation and community resources to learn more about its features and customization options.