Deneb Jekyll documentation

Jekyll Configuration

Jekyll Configuration guide.

Jekyll Configuration (_config.yml)

Site Basic Configuration

Site URL and Base Path

baseurl: ""  # Subpath of your site (e.g., /blog)
url: "https://deneb-jekyll.tortoizthemes.com"  # Base hostname and protocol
  • baseurl: Used when your site is in a subdirectory
  • url: Full URL of your website

Plugin Configuration

plugins:
  - jekyll-feed        # Generate RSS feed
  - jekyll-paginate-v2 # Advanced pagination
  - jekyll-archives    # Generate archive pages
  • Enables additional Jekyll functionality
  • Extends site’s capabilities with community plugins

SASS Compilation

sass:
  sass_dir: _sass     # Directory for SASS files
  style: compressed   # Minify CSS output
  • Controls SASS compilation process
  • compressed style minimizes CSS file size

Collections Configuration

collections:
  posts:
    output: true
    permalink: "/blog/:title"
  services:
    output: true
  portfolio:
    output: true
    permalink: "/portfolio/:title"
    sort_by: date
  authors:
    output: true
    permalink: "/author/:title"
  • Define custom collections beyond default posts
  • Control URL structure for each collection
  • Set sorting and output preferences

Default Page Layouts

defaults:
  - scope:
      path: "_portfolio"
      type: portfolio
    values:
      layout: portfolio
      is_collection: true
  - scope:
      path: ""
      type: authors
    values:
      layout: author
  • Automatically assign layouts to specific collections
  • Set default front matter for collection pages

Pagination Configuration

pagination:
  enabled: true      # Enable pagination
  per_page: 5        # Posts per page
  permalink: '/page/:num/'
  sort_field: 'date'
  sort_reverse: true
  • Control blog post pagination
  • Customize number of posts per page
  • Define pagination URL structure
  • Sort posts by date (newest first)

Archives Configuration

jekyll-archives:
  enabled:
    - tags
    - categories
  layouts:
    tag: tag
    category: category
  permalinks:
    tag: '/tag/:name/'
    category: '/category/:name/'
  • Generate archive pages for tags and categories
  • Define layout and URL structure for archives

RSS Feed Configuration

feed:
  collections:
    posts:
      path: "/index.xml"
  • Generate RSS feed for blog posts
  • Specify feed location
  • Keep baseurl and url updated for your deployment
  • Use appropriate plugins for site requirements
  • Optimize SASS compilation for performance
  • Customize collections to match your content strategy

Troubleshooting

  • Verify plugin compatibility
  • Check permalink structures
  • Ensure collection configurations match your site’s structure