Skip to content

Latest commit

 

History

History
133 lines (93 loc) · 12.4 KB

README.md

File metadata and controls

133 lines (93 loc) · 12.4 KB

Simplifii WordPress FSE Theme

Total Downloads Auto Assign Code Quality PHP Code Quality CSS DevSkim Generate POT file WordPress version checker Website VS Code Dev.to WordPress EsLint eslint Prettier Stylelint Figma iterm git chrome maintained built github twitter patreon paypal sponsor coffee freelancer

stats

Tested on PHP 5.4 to 7.4 snapshot Release Date of the Latest Version Number of Contributors Last Commit Minimum PHP Version release commits since closed issues PR closed Codeable license

This theme is designed as a block theme to support WordPress full site editing. You must have the Gutenberg Plugin Activate to use this theme before ready for full site editing on released WordPress.

screenshot

Simplifii is a versatile block-based WordPress theme with Full Site Editing allowing you to customise to your hearts content - with WooCommerce support. You must have the Gutenberg Plugin Activate to use this theme before ready for full site editing on released WordPress.

Preview Download

Tags:

Block Editor Patterns, Block Editor Styles, Blog, Custom Background, Custom Colors, Custom Logo, Custom Menu, E-Commerce, Editor Style, Featured Images, Four Columns, Full Site Editing, Grid Layout, One Column, Sticky Post, Threaded Comments, Three Columns, Translation Ready, Two Columns, Wide Blocks

Contributing

If you would like to contribute code, the list of open issues is a great place to start looking for tasks. Pull requests are preferred when linked to an existing issue.

Contributing is not just for developers! There are many opportunities to help with testing, triage, discussion, designing and building variations, and more. Please look through open issues, and join in wherever you feel most comfortable.

Contributing Style Variations

A big part of Simplifii is to emphasize a diverse collection of style variations, so this is a great way to contribute to the theme!

Design a style variation

This can be done a few different ways, including:

  • Create an alternate theme.json file to the one provided by the theme and change values directly in the code.
  • Make changes in the Global Styles panel in the Site Editor. You can save these changes as a new style variation using the Create Block Theme plugin.
  • Design static mockups in Figma or a similar program.

Submit your style variation

When you're ready to submit, please create a new issue and share your designs:

  • Theme.json files can be submitted as code or as zip files.
  • Add images that showcase the look & feel of the variation.
  • Include a style guide with design specifications — this should include details on typography, colors, spacing, etc. Here’s an example.

Getting Started

To get started with development:

  1. Set up a WordPress instance, we recommend wp-env or Local as an alternative to docker.
  2. Install the Gutenberg plugin
  3. Clone / download this repository into your /wp-content/themes/ directory

Tips for Contributors

  • Similar to Simplifii, a goal for the theme is to have as little CSS as possible. Much of the theme's visual treatments should be handled by the Block Editor and Global Styles. As a general rule, if multiple themes would benefit from the CSS you're considering adding, it might reasonably be provided by Gutenberg instead. Let's include clear code comments for any CSS we do include.
  • Similarly, let's refrain from building any custom-built PHP or JavaScript-based workarounds for functionality that might reasonably be provided by the Block Editor. Simplifii will be a block theme, so let's keep its code simple.
  • In accordance to those last two bullets, this theme has no required build process.
  • If you've helped contribute to the theme in any way, you deserve credit! Folks will be updating CONTRIBUTORS.md periodically with names of contributors, but feel free to open a PR or issue if we leave someone out.

Requirements

  • Gutenberg plugin (latest)
  • WordPress 5.9+
  • PHP 5.6+
  • License: GPLv2 or later

Some theme features / PRs may require Gutenberg trunk and will be described or tagged accordingly.

Resources