Configuration

Complete configuration options for the Arsxy Jekyll theme

The Arsxy Theme can be extensively customized through your site’s _config.yml file. This page documents all available configuration options.

Basic Site Settings

These settings control fundamental aspects of your site:

# Site settings
title: Your Site Title              # Used in the header and SEO
name: Your Site Name                # Alternative name for branding
description: >-
  Your site description for SEO and social sharing.
baseurl: "/"                        # The subpath of your site, e.g. /blog
url: "https://yourdomain.com"       # The base hostname & protocol

Theme Settings

When using the theme, specify either:

# For remote theme installation
remote_theme: awcodify/arsxy-theme

# OR for gem-based installation
theme: arsxy-theme

Navigation Menu

Configure your site’s navigation menu:

navigation:
  - title: Home
    url: /
  - title: About
    url: /about
  - title: Articles
    url: /articles
  - title: Tags
    url: /tags
  - title: Contact
    url: /contact
  - title: Documentation
    url: /docs

Social Links

Add your social media accounts to display icons in the footer:

social:
  github: yourusername
  twitter: yourusername
  linkedin: yourusername
  email: your.email@example.com
  # You can also add: facebook, instagram, mastodon, youtube, etc.

Theme Features

Enable or disable specific theme features:

# Feature toggles
features:
  dark_mode: true                   # Enable dark mode toggle
  auto_dark_mode: true              # Respect system preferences
  toc: true                         # Table of contents for posts
  reading_time: true                # Show estimated reading time
  social_sharing: true              # Show social sharing buttons
  hero_section: true                # Enable hero section on homepage
  featured_posts: true              # Show featured posts section
  related_posts: true               # Show related posts
  search: true                      # Enable search functionality

Homepage Configuration

Customize your homepage layout:

# Homepage settings
homepage:
  hero:
    title: "Welcome to My Site"     # Hero section headline
    subtitle: "A personal blog about technology and life"
    button_text: "Read Articles"    # Call-to-action button
    button_url: "/articles/"        # Button destination
    background: "/assets/images/hero-background.jpg"
  
  featured_posts:
    enabled: true
    count: 3                        # Number of featured posts to display
    title: "Featured Content"       # Section title

Post Settings

Configure default settings for blog posts:

# Default post settings (can be overridden in front matter)
defaults:
  - scope:
      path: ""
      type: "posts"
    values:
      layout: "post"
      comments: true
      toc: true
      featured: false
      reading_time: true
      share: true

Favicon Configuration

Customize your site’s favicon:

# Favicon configuration
favicon:
  enabled: true                # Set to false to disable favicons completely
  icon16: "/assets/images/favicon/favicon-16x16.png"
  icon32: "/assets/images/favicon/favicon-32x32.png"
  apple_touch_icon: "/assets/images/favicon/apple-touch-icon.png"
  manifest: "/assets/images/favicon/site.webmanifest"
  # Optional additional favicon formats
  mask_icon: "/assets/images/favicon/safari-pinned-tab.svg"
  mask_icon_color: "#5bbad5"
  shortcut_icon: "/assets/images/favicon/favicon.ico"
  ms_config: "/assets/images/favicon/browserconfig.xml"

SEO and Analytics

Configure SEO features and analytics:

# SEO settings
seo:
  og_image: "/assets/images/og-default.jpg"  # Default Open Graph image
  twitter_card: summary_large_image
  twitter_username: yourusername

# Google Analytics
google_analytics: UA-XXXXXXXX-X     # Your Google Analytics tracking ID

Plugin Settings

Enable Jekyll plugins:

plugins:
  - jekyll-feed
  - jekyll-seo-tag
  - jekyll-sitemap
  - jekyll-paginate
  - jekyll-remote-theme              # Only if using remote_theme

Pagination

Configure blog pagination:

paginate: 6                         # Number of posts per page
paginate_path: "/page/:num/"        # URL path for paginated pages

Advanced Settings

Additional advanced configuration options:

# Build settings
markdown: kramdown
highlighter: rouge                  # Syntax highlighter
sass:
  style: compressed                 # CSS compression
  
# Exclude files from processing
exclude:
  - Gemfile
  - Gemfile.lock
  - node_modules
  - vendor
  - .sass-cache

Complete Example

Here’s a complete example showcasing all the configuration options:

# Site settings
title: My Awesome Site
name: Awesome Site
description: >-
  A personal blog about technology, programming, and life.
baseurl: "/"
url: "https://example.com"

# Theme settings
remote_theme: awcodify/arsxy-theme

# Navigation menu
navigation:
  - title: Home
    url: /
  - title: About
    url: /about
  - title: Articles
    url: /articles
  - title: Tags
    url: /tags
  - title: Contact
    url: /contact
  - title: Documentation
    url: /docs

# Social links
social:
  github: username
  twitter: username
  linkedin: username
  email: your.email@example.com

# Feature toggles
features:
  dark_mode: true
  auto_dark_mode: true
  toc: true
  reading_time: true
  social_sharing: true
  hero_section: true
  featured_posts: true
  related_posts: true
  search: true

# Homepage settings
homepage:
  hero:
    title: "Welcome to My Site"
    subtitle: "A personal blog about technology and life"
    button_text: "Read Articles"
    button_url: "/articles/"
    background: "/assets/images/hero-background.jpg"
  
  featured_posts:
    enabled: true
    count: 3
    title: "Featured Content"

# Default post settings
defaults:
  - scope:
      path: ""
      type: "posts"
    values:
      layout: "post"
      comments: true
      toc: true
      featured: false
      reading_time: true
      share: true

# SEO settings
seo:
  og_image: "/assets/images/og-default.jpg"
  twitter_card: summary_large_image
  twitter_username: username

# Google Analytics
google_analytics: UA-XXXXXXXX-X

# Plugins
plugins:
  - jekyll-feed
  - jekyll-seo-tag
  - jekyll-sitemap
  - jekyll-paginate
  - jekyll-remote-theme

# Pagination
paginate: 6
paginate_path: "/page/:num/"

# Build settings
markdown: kramdown
highlighter: rouge
sass:
  style: compressed
  
# Exclude files from processing
exclude:
  - Gemfile
  - Gemfile.lock
  - node_modules
  - vendor
  - .sass-cache