Basic Configuration Example

Basic config.yml

This example covers the essential settings for assets, cleanup, admin features, and navigation menus:

1
# Basic configuration example
2
assets:
3
  version: "1.0.0"  # Version string for cache busting
4
  lazyload: true    # Enable image lazy loading
5
6
cleanup:
7
  emoji-styles: false      # Disable WordPress emoji styles
8
  generator: false         # Remove WordPress generator meta tag
9
  rsd-link: false          # Remove RSD link
10
  wlwmanifest-link: false  # Remove Windows Live Writer manifest
11
12
admin:
13
  svg-import: true         # Allow SVG uploads
14
  admin-bar: true          # Show admin bar
15
  options-pages:           # ACF options pages
16
    - page_title: 'Site Options'
17
      menu_title: 'Site Options'
18
      menu_slug: 'site-options'
19
      capability: 'edit_posts'
20
      position: null
21
      parent_slug: ''
22
      icon_url: 'dashicons-admin-generic'
23
      redirect: true
24
      post_id: 'options'
25
      autoload: false
26
27
menus:
28
  main-nav: "Main Menu"
29
  footer-nav: "Footer Menu"
30
31
pictures:
32
  yearmonth_folders: true  # Organize uploads by year/month
33
  
34
  thumbnail:               # Default thumbnail size
35
    width: 150
36
    height: 150
37
    crop: true
38
  
39
  sizes:                   # Custom image sizes
40
    medium:
41
      width: 768
42
      height: 0
43
      crop: false
44
    large:
45
      width: 1200
46
      height: 0
47
      crop: false

Basic plugins.yml

Define required plugins for your WordPress site:

1
# Required plugins
2
plugins:
3
  - name: Advanced Custom Fields PRO
4
    slug: advanced-custom-fields-pro
5
    required: true
6
    force_activation: true
7
    source: local
8
    
9
  - name: ACF Extended
10
    slug: acf-extended
11
    required: true
12
    force_activation: true
13
    
14
  - name: Classic Editor
15
    slug: classic-editor
16
    required: false
17
    force_activation: false

Implementation Steps

1. Create the configuration directory

   Create the directory library/combo/config/ in your theme folder.

2. Save the configuration files

   Save the above YAML code as config.yml and plugins.yml in the configuration directory.

3. Activate the plugin

   Make sure the Combo plugin is activated in your WordPress admin panel.

4. Verify the configuration

   Check that the settings are applied correctly by verifying the following:

   • SVG uploads are allowed in the media library
   • The admin bar is displayed
   • The "Site Options" page appears in the admin menu
   • The registered menus appear in the Appearance > Menus section

What This Configuration Does

• Assets Management: Sets a version string for cache busting and enables lazy loading for images.
• WordPress Cleanup: Removes unnecessary WordPress features like emoji styles and generator meta tags.
• Admin Features: Allows SVG uploads, shows the admin bar, and creates an ACF options page.
• Navigation Menus: Registers two navigation menus for the main navigation and footer.
• Media Management: Organizes uploads by year/month and defines custom image sizes.
• Required Plugins: Defines ACF Pro and ACF Extended as required plugins, with Classic Editor as optional.

Next Steps

After implementing this basic configuration, you can expand it by:

• Adding more specific cleanup options
• Configuring the TinyMCE or Gutenberg editor
• Setting up SMTP for reliable email delivery
• Integrating with plugins like Polylang, Contact Form 7, or WooCommerce
• Creating more advanced image size configurations