Code Monkey home page Code Monkey logo

flo-theme-2017's Introduction

Build Status

Air - A minimalist WordPress starter theme

Air is designed to be a minimal starting point for a WordPress project at Digitoimisto Dude Oy, a Finnish boutique digital agency in the center of Jyväskylä. Theme is based on _s.

  • CSS gzipped: 6.2 KB (27.6 KB original)
  • JS gzipped: 3.5 KB (11.1 KB original)
  • Front page HTML: 7.4 KB (29.4 KB original)

This theme is built to be very straightforward, front end developer friendly and only partly modular by its structure.

Table of contents

  1. Please note before using
  2. License
  3. Features
    1. Layout base & grid
    2. Typography
    3. Development
    4. Navigation
    5. WordPress & functions
    6. Disabled features
    7. WooCommerce support
  4. Requirements
  5. Recommendations for development
  6. Installation
  7. Contributing
  8. Notes

Please note before using

Air is a development theme, so it has updates very often. By using this starter theme, you agree that the anything can change to a different direction without a warning.

Air is not meant to be "a theme for everyone", so it doesn't have many parts that are generally included (see Disabled features).

If you for some reason happen to use this theme as base, please note the theme won't necessarily be that much fun or won't necessarily look any good. I recommend using Sage if you need something more complete.

License

Dudestarter is licensed with The MIT License (MIT) which means you can freely use this theme commercially or privately, modify it, or distribute it, but you are forbidden to hold Dude liable for anything, or claim that what you do with this is made by us.

Features

Layout base & grid

  • All good things from the latest Underscores
  • SASS-support (SCSS-syntax)
  • CSS reset with a combination with Nicolas Gallagher's normalize*css
  • Jeet Grid for SASS @include column(1/100)
  • Container div inside site-main
  • Possible to choose between fluid (flexible 100%) and snappy grid style (snapping to breakpoint, more space around)
  • Inline SVG-ready

Typography

  • Responsive typography with viewport units with fallbacks (formerly Megatype, still recommended with blogs or text-only based sites, but not included by default after 1.5.0)
  • Google Webfonts with Penman's Sass-Web-Fonts
  • Web fonts helper: Sass Boilerplate's fontFace-mixin (if you have .odt, .ttf, .woff, .woff2 in fonts directory, you can add them with @include fontFace('Proxima Nova', '../fonts/proximanova-regular-webfont', 400);)

Development

  • BrowserSync for keeping multiple browsers and devices synchronized while testing, along with injecting updated CSS and JS into your browser while you're developing (included in devpackages)
  • gulp build script that compiles both Less and Sass, checks for JavaScript errors, optimizes images, and concatenates and minifies files (see Dude's devpackages)
  • npm for front-end package management

Navigation

  • Custom navigation walker based on Bootstrap 3
  • Sassified version of viljamis' responsive-nav, fully Accessible and responsive multi-level navigation

WordPress & functions

  • Available for translation
  • Automatic feed links
  • WordPress managed title tag
  • Support for Post Thumbnails on posts and pages
  • HTML5 core markup for WordPress elements
  • WP updates nag hidden
  • All times and local units in Finnish
  • Custom uploads folder media/ instead of default content/uploads/
  • Air specific: Templates for hero slides

Disabled features

  • Widgets
  • Post formats
  • Jetpack support
  • Customizer
  • RTL support
  • Threaded comments
  • Template tags (direct edit preferred)
  • WordPress admin bar for logged in users
  • No sidebar by default
  • Emojicons

WooCommerce support

Air has by default basic WooCommerce support from version 1.9.2. It includes the most basic overrides like buttons. WooCommerce as well as other things in the theme are built for starting point only.

Requirements

  • Requires at least: WordPress 4.7.0
  • Tested up to WordPress 4.7.0

Recommendations for development

  • Mac OS X
  • Devpackages - Npm, Gulp and Bower
  • Dudestack - A toolkit for creating a new professional WordPress project with deployments. Heavily based on Bedrock by Roots.

Installation

Traditional way:

  1. Git clone or download zip
  2. Open Terminal and run npm install
  3. Open project to Atom (or your preferred editor) and run search and replace air => yourprojectname
  4. Run gulp watch and start coding

If you are using Dudestack and Devpackages, your project folder is located at ~/Projects, your vagrant box is up and running at 10.1.2.4, just

  1. Open Terminal and cd to air directory
  2. Run sh newtheme.sh - the script takes care of the rest (updates textdomain with your project name, checks updates for air and npm packages, runs npm install, fetches devpackages, sets up gulp, cleans up the leftover files and activates the theme via wp-cli)

Contributing

If you have ideas about the theme or spot an issue, please let us know. Before contributing ideas or reporting an issue about "missing" features or things regarding to the nature of that matter, please read Please note section. Thank you very much.

Notes

Gzip file sizes tested with wc -c css/global.css and gzip -c css/global.css | wc -c commands.

flo-theme-2017's People

Contributors

deester4x4jr avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.