Skip to content

Latest commit

 

History

History
88 lines (60 loc) · 3.82 KB

README.md

File metadata and controls

88 lines (60 loc) · 3.82 KB
Raw

Documentation (EN) | Documentation (PT-BR)

Note: The documentation needs to be updated. Some features have been removed to make the theme lighter.

Wiki

THE PUBLIC RELEASE IS IN BETA VERSION.
WE ALREADY USE THIS VERSION IN PRODUCTION BUT USE WITH CAUTION.

Onyx Theme is a starter kit for for assistance in developing themes in Wordpress. It can be considered a kind of framework.

This theme is inpired by Sage and Themosis but ligther because we do not need thousands of dependencies to develop a WordPress theme.

Documentation

The full documentation is available here .

How to Install

Download latest version from releases extract in the themes folder, then:

  • 1 / Run npm install
  • 2 / Run composer install
  • 3 / Rename .env.example file inside the onyx theme folder to .env and configure it
  • 4 / Activate the theme inside WordPress
  • 5 / Run npm run serve or npm run dev (live reload will only work if you develop with a .local domain)

Folder structure

  • core/ - This is where the main structure of the theme resides

    • ./app - Classes for theme setup
      • ./Api - WP REST Api Controllers
      • ./Controllers - Main Controllers
      • ./Onyx - Onyx Classes
    • ./config - Resides all the main configurations of your project.
    • ./includes - Its own hooks, functions and classes.

  • src/ - Source files for styles and javascripts.

    • ./sass
    • ./js

  • views/ - Twig templates

Composer

  • composer install inside theme folder to create the autoload and install dependencies
  • composer onyx-dump inside theme folder to dump the autoload

Gulp

Gulp is used for processing javascripts, scss and livereload. To be used in conjunction with a WEB server such as LocalbyFlywheel or MAMP.

  • Configure the environment through the file .env inside the theme folder.
  • Execute npm install inside theme folder.
Commands Functionality
npm run serve Listen and process files when saving. Need a .local domain to work
npm run serve:prod Same as serve but using production environment
npm run build Build assets (css/js)

Other gulp commands npx gulp styles, npx gulp stylesHome, npx gulp stylesPurge, npx gulp js, npx gulp jsHome, npx gulp watch

Requiring dependencies in javascript

Please, use ES6 Modules or CommonJS to import your dependencies (see app.js)

Some JS libraries

Dependency Install Repository/Site
tiny-slider npm install tiny-slider https://github.com/ganlanyuan/tiny-slider
imask npm install imask https://github.com/uNmAnNeR/imaskjs
fancybox npm install @fancyapps/ui https://fancyapps.com
lightgallery.js npm install lightgallery https://www.lightgalleryjs.com/

License

The Onyx Theme is open-source software licensed under GPL-2+ license.