Papyrus screenshot

Papyrus

Author Avatar Theme by Pelican themes
Updated: 27 Oct 2023
64 Stars

A fast and responsive theme built for the Pelican site generator.

Overview

Papyrus is a fast and responsive theme built for the Pelican site generator. It is styled using Tailwind CSS and supports dark mode and site search via a plugin.

Features

  • Fast and responsive design
  • Styled using Tailwind CSS
  • Supports dark mode
  • Site search functionality
  • Easy installation process
  • Customizable image size and placement
  • Embed YouTube videos
  • Tailwind CSS customization options
  • Performance and SEO improvements

Installation

  1. Install the following plugins using Pip:

    • pelican-search
    • pelican-neighbors
    • pelican-readtime
  2. Clone the Papyrus theme repository into the “themes” directory in your project.

  3. Clone the pelican-toc plugin repository into the “pelican-plugins” directory in your project.

  4. Install the beautifulsoup4 dependency.

  5. Install Stork on the system that will generate your site.

  6. Verify the availability of the Stork CLI tool on your $PATH.

  7. Set up your pelicanconf.py settings file according to your needs.

  8. Generate articles with a summary field to add them to the HTML meta description and the blog’s home page.

  9. Create source content files inside the “pages” directory for separate static pages with direct links.

  10. Customize image placement and size using custom class names in your Markdown content.

  11. Embed YouTube videos by wrapping the <iframe> tags inside a <div class=“aspect-w-16 aspect-h-9”> in your Markdown content.

  12. Customize the theme with Tailwind CSS by installing development packages and running the development server.

  13. Improve performance and SEO by creating and adding your own robots.txt and favicon.ico files.

  14. Update your pelicanconf.py file if you are updating from an older version of the theme.

Summary

Papyrus is a versatile theme for the Pelican site generator, offering a fast and responsive design. With features like dark mode support, site search functionality, and customizable image placement and size, it provides a great user experience. Additionally, it allows for easy customization using Tailwind CSS and includes performance and SEO improvements. The installation process is straightforward, with clear instructions provided in the documentation. Overall, Papyrus is a reliable choice for creating attractive and functional websites using Pelican.