A responsive, minimalist Pelican theme with comprehensive SEO/LEO support, dark mode, and modern features.

Note: This is a heavily modified fork of alexandrevicenzi/Flex. See Changes from Original for details.

• Features
• Quick Start
• Configuration Reference
  • Site Settings
  • Navigation & Layout
  • Dark Mode & Styling
  • SEO & Social
  • Analytics & Tracking
  • Comments
  • Newsletter
  • Advertising
  • Favicon
  • Video Embedding
  • Twitter/X Embedding
  • Advanced Features
• Plugin Support
• Article Frontmatter
• Changes from Original Flex
• Documentation
• License

• Mobile-first responsive design
• Dark mode with system preference detection and manual toggle
• Pagefind search integration (static search)
• Reading progress indicator
• Table of contents for articles (optional)

• Schema.org structured data: BlogPosting, FAQPage, HowTo, BreadcrumbList
• Open Graph and Twitter Cards meta tags
• AI-friendly meta tags for ChatGPT, Perplexity, and other LLMs
• Speakable schema for voice search
• Canonical URLs support

• Series navigation for multi-part articles
• Related posts display
• Previous/next article navigation
• Video embedding for YouTube and Vimeo (Obsidian vid code block format)
• Twitter/X embedding via tweet code block
• Syndication links for cross-posted content
• BibTeX citation blocks
• Applause button support

• Google Analytics (GA4)
• Google Tag Manager
• Microsoft Clarity
• Google AdSense
• Giscus comments (GitHub Discussions)
• Newsletter subscriptions (Mailchimp, Buttondown, ConvertKit, Substack)
• RealFaviconGenerator support

# Clone into your Pelican themes directory
git clone https://github.com/izikeros/Flex.git pelican-themes/Flex

Add to your pelicanconf.py:

THEME = "pelican-themes/Flex"

# Required
SITENAME = "My Blog"
SITEURL = "https://example.com"
AUTHOR = "Your Name"

# Recommended
SITETITLE = "My Blog"
SITESUBTITLE = "A blog about things"
SITELOGO = "/images/logo.png"
MAIN_MENU = True

Dark mode is automatically available with:

• System preference detection (prefers-color-scheme)
• Manual toggle button (persists choice in localStorage)
• No configuration required - always enabled

See docs/GISCUS_COMMENTS.md for setup instructions.

Provider-specific settings:

See docs/NEWSLETTER.md for detailed setup.

AdSense configuration:

GOOGLE_ADSENSE = {
    "ca_id": "ca-pub-XXXXXXXXXX",
    "page_level_ads": True,
    "ads": {
        "aside": "XXXXXXXXXX",
        "main_menu": "XXXXXXXXXX",
        "index_top": "XXXXXXXXXX",
        "index_bottom": "XXXXXXXXXX",
        "article_top": "XXXXXXXXXX",
        "article_bottom": "XXXXXXXXXX",
    }
}

FAVICON = "/images/favicon.ico"

Setup:

1. Go to realfavicongenerator.net
2. Generate and download favicon package
3. Place files in content/ directory
4. Add to STATIC_PATHS: favicon.ico, apple-touch-icon.png, favicon-32x32.png, favicon-16x16.png, site.webmanifest
5. Enable: RFG_FAVICONS = True

Supports both YouTube and Vimeo videos using the Obsidian vid code block format. Either variable enables the feature.

```vid
https://www.youtube.com/watch?v=VIDEO_ID
Title: Video Title
Author: Channel Name
AuthorUrl: https://www.youtube.com/@Channel
```

```vid
https://vimeo.com/123456789
Title: Video Title
Author: Creator Name
AuthorUrl: https://vimeo.com/creator
```

Features:

• Responsive 16:9 aspect ratio
• Privacy-enhanced (YouTube: youtube-nocookie.com, Vimeo: dnt=1)
• Lazy loading
• Optional title/author info bar

Note: Twitter embeds are also enabled if VIDEO_EMBED or YOUTUBE_EMBED is set.

```tweet
https://twitter.com/user/status/123456789
```

Or with X.com URL:

```tweet
https://x.com/user/status/123456789
```

Features:

• Uses Twitter oEmbed API (no authentication required)
• Privacy-enhanced (dnt=true)
• Lazy-loads Twitter widget JS only when needed
• Graceful fallback with link on error

CC_LICENSE = {
    "slug": "by-sa",
    "name": "Creative Commons Attribution-ShareAlike",
    "version": "4.0",
    "language": "en_US"
}
COPYRIGHT_YEAR = "2024"
COPYRIGHT_NAME = "Your Name"

For blogs using pelican-jupyter to publish Jupyter notebooks:

# Use theme's pygments CSS for unified syntax highlighting
IPYNB_SKIP_CSS = True

# Optionally set different highlight theme for dark mode
PYGMENTS_STYLE = "github"
PYGMENTS_STYLE_DARK = "monokai"

The theme includes:

• .warning class styling for notebook compatibility
• Unified code highlighting across markdown and notebook articles
• Support for MathJax (handled by pelican-jupyter)

The theme works seamlessly with pelican-obsidian:

• Wiki-links: [[article-slug]] converts to proper links
• Hashtag removal: Inline #tags removed from body text
• Callouts to Admonitions: Obsidian callouts render with theme's admonition CSS

# pelicanconf.py
PLUGINS = ["obsidian", ...]
OBSIDIAN_CALLOUTS_USE_ADMONITION = True  # Use theme's admonition styles

Supported callout types: note, tip, warning, danger, info, question, example, quote, abstract, success, failure, bug, important, caution, attention

Title: Article Title
Date: 2024-01-15
Modified: 2024-01-20
Category: Machine Learning
Tags: python, ml, tutorial
Slug: article-slug
Status: published
Summary: Brief description for listings
Image: /images/featured.jpg

Article-Type: howto  # article, howto, faq, tutorial
AI-Summary: Two-sentence summary for AI systems
Key-Takeaways:
  - First key point
  - Second key point
Expertise-Level: intermediate  # beginner, intermediate, advanced
Topics: machine learning, python, data science

FAQ:
  - question: What is X?
    answer: X is a thing that does Y.
  - question: How do I Z?
    answer: You can Z by doing A, B, C.

Or use content markers:

<!-- faq-start -->
### What is X?
X is a thing that does Y.
<!-- faq-end -->

Article-Type: howto
HowTo-Steps:
  - name: Install dependencies
    text: Run pip install package-name
  - name: Configure settings
    text: Edit config.yaml with your values

Syndicated-To:
  - platform: dev.to
    url: https://dev.to/user/article
    date: 2024-01-16
  - platform: medium
    url: https://medium.com/@user/article

See docs/SEO_LEO_SPEC.md and docs/ARTICLE_WRITING_GUIDE.md for complete documentation.

This fork includes significant enhancements over alexandrevicenzi/Flex:

• Pagefind search - Static site search integration (with www/non-www support)
• Dark mode toggle - Manual theme switcher with localStorage persistence
• Reading progress bar - Visual scroll progress indicator
• Table of contents - Auto-generated from headings
• Series navigation - Full UI for multi-part articles
• Video embedding - YouTube and Vimeo via Obsidian vid code block
• Twitter/X embedding - Tweet embeds via tweet code block
• Newsletter subscription - Multiple provider support
• Giscus comments - GitHub Discussions integration
• RealFaviconGenerator - Cross-platform favicon support
• Microsoft Clarity - Analytics integration
• LinkedIn Follow button - Sidebar follow button
• Jupyter notebook support - Unified syntax highlighting with pelican-jupyter

• FAQPage schema - Structured data for Q&A content
• HowTo schema - Structured data for tutorials
• BreadcrumbList schema - Navigation structured data
• AI meta tags - Optimization for LLM systems
• Speakable schema - Voice search optimization
• Syndication display - Cross-posting links

• TIL (Things I Learned) - Dedicated template for notes
• Archives by year - Grouped archive display
• Article cards - Modern card-based homepage layout
• Filtered pagination - Category exclusion from index
• Admonition styling - CSS for callout/admonition blocks
• Notebook CSS - .warning class and unified highlighting support

• Disqus comments (replaced with Giscus)
• Tipue Search (replaced with Pagefind)
• Some legacy integrations

Full diff: Compare with original

• SEO/LEO Specification - Complete SEO and AI optimization guide
• Article Writing Guide - How to write optimized articles
• Giscus Setup - GitHub Discussions comments
• Newsletter Setup - Email subscription configuration
• Original Flex Wiki - Base theme documentation

MIT License - see LICENSE for details.

Original theme by Alexandre Vicenzi
Fork maintained by Krystian Safjan