Wireframe Paths - mixatheme/Wireframe GitHub Wiki

NOTE: THIS WIKI PAGE WAS WRITTEN WAY BACK IN 2015 FOR WIREFRAME ALPHA. WE ARE CURRENTLY IN THE PROCESS OF UPDATING THESE DOCS HOPEFULLY FOR A JUNE 2017 RELEASE. THANK YOU FOR YOUR PATIENCE.

Wireframe Folder

This is the main theme folder which holds Wireframe's files. If you download an 📦 archive of the :octocat: Wireframe repository, you can rename 📁 Wireframe-master to 📁 wireframe if you wish. You'll notice there are 2 top-tier folders inside the wireframe theme folder. The wireframe_client and wireframe_dev folders help organize and declutter things.

wireframe_client

The wireframe_client folder holds Wireframe's compiled font-end assets. This area is intended for End-Users, also commonly referred to as a "dist" directory. Although anyone can modify these files to their liking, it is strongly recommended that Developers, Teams and Theme Shops instruct Users/Customers to install a Child Theme and only modify Child Theme files.

Structure:

  • :open_file_folder: wireframe_client
    • :file_folder: css
    • :file_folder: docs
    • :file_folder: fonts
    • :file_folder: images
    • :file_folder: js
    • :file_folder: languages

Constants:

  • WIREFRAME_CLIENT_DIR
  • WIREFRAME_CLIENT_CSS
  • WIREFRAME_CLIENT_FONTS
  • WIREFRAME_CLIENT_IMG
  • WIREFRAME_CLIENT_JS
  • WIREFRAME_CLIENT_LANG
  • WIREFRAME_TPL

wireframe_dev

The wireframe_dev folder holds Wireframe's classes, functions, modules, sass, etc. This area is only intended for Developers and is also commonly known as a "src" directory. Developers will make any modifications they need, then recompile or pre-process files as per needed. All processed files should then be mapped to the wireframe_client directory for front-end output. Developers, Teams and Theme Shops should instruct their Users/Customers to never modify these files.

Structure:

  • :open_file_folder: wireframe_dev
    • :file_folder: classes
    • :file_folder: helpers
    • :file_folder: modules
    • :file_folder: scripts
    • :file_folder: scss
    • :file_folder: template-parts
    • :file_folder: vendor
    • :file_folder: wpcs

Constants:

  • WIREFRAME_DEV