Giter VIP home page Giter VIP logo

luxe's Introduction

Luxe - A WordPress starter theme

Luxe is a WordPress starter theme using a modern workflow and best practices.

The theme's primary goal is to offer a modern development experience for WordPress theme authors while sticking as close to possible to WordPress standards as we can. Sometimes those things don't always mesh well. This theme aims to balance that.

Requirements

There's a few requirements in order to develop a new theme or contribute back to the project:

  • PHP 5.6+ (preferably 7+)
  • Git for version control.
  • Composer for managing PHP dependencies.
  • NPM or Yarn (your choice) for managing JS dependencies.

You should feel reasonably comfortable using the command line. The theme tries to keep this as simple as possible, but some command line knowledge is necessary in modern development.

Documentation

Check out the project wiki to learn how to install and set up the theme.

Copyright and License

Luxe is licensed under the GNU GPL, version 2 or later.

2018 © Brett Mason.

luxe's People

Contributors

brettsmason avatar dependabot-preview[bot] avatar dependabot-support avatar dependabot[bot] avatar justintadlock avatar m-e-h avatar tiborp avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

luxe's Issues

Menu styles

Hi Brett,

I noticed when using some custom menu's (for example in the footer), I had to overwrite quite a bit of the menu styles; I think it would be a good idea to specify (parts of) the styling a bit more, as in targeting the --primary menu only. For example: visibility, hover states, z-index and the like.

Cheers, Tibor

Build tools

Investigate the option of using Laravel Mix for the build tool

Dependabot

Consider adding Dependabot. Looks like a useful service that's used on the Foundation repo.

Keep having problems with npm run watch

I seem to keep on having problems with running the npm commands... After nmp install i try to run the watch script but seems to get the error:

npm ERR! code ELIFECYCLE
npm ERR! errno 1

I dont know if it 's got something to do with the luxe config, but my other luxe projects seem to have no problems...
Cleared my caches, dit a reintall, updates node, run audit fixes...

Vertical rhythm

Add vertical rhythm to Sass. Possibly based off Inuit but maybe use a vr() function to output a value.

Responsive menu implementation in other theme

Hi Brett!

I am currently working on an _s based starter theme and trying to implement your responsive-menu.js.

I have managed to add the proper BEM classes to the navigation, but somehow get the following error:

Uncaught ReferenceError: menuIcons is not defined
    at new ResponsiveMenu (responsive-menu.js:13)

Hope you can help me on my way solving this.

Cheers, Tibor

clean-webpack-plugin config error

Hi Brett,

When running npm run dev on a fresh install, I get the following error:

Error: clean-webpack-plugin only accepts an options object

The issue seems to be the path.resolve part, on line 99 in webpack-common.js:

new CleanWebpackPlugin(path.resolve(__dirname, config.paths.public), { verbose: false }),

Would you have any idea on how to fix this? (my webpack knowledge is very limited..)

Thanks in advance!

theme-color meta tag

Should look into adding the meta-theme tag, eg:

<meta name="theme-color" content="#000000" />

Possibly a way to add this automatically from a config file.

JavaScript components

We need to add some basic JS for things like toggling a menu and the menu itself.

CUBE CSS

Been following this for a while and think its a good fit for how I've grown used to writing CSS.
The CSS in the project is due a rework so should explore in greater detail.

Link

Loading custom fonts

Hi Brett,

I'm trying to use a custom font, but can't seem to get it working. I have added the font files to resources/fonts, and used

@font-face { font-family: "CadizWeb";font-style: normal; font-weight: 400; src: local("CadizWeb"), local("CadizWeb-Regular"), url("../../fonts/CadizWeb-Regular.woff2") format("woff2"), url("../../fonts/CadizWeb-Regular.woff") format("woff"); }

I can see the fonts are duplicated to the right directory in /public, but I think this also has to do something with the proper path to the custom fonts from /public.

Hope you can help..

Coding standards

The theme should try and more closely follow WordPress coding standards (with a few exceptions) and include a working phpcs config to enforce it.

View structure

Now that I've been using the theme for a while I think its time to look at simplifying the view structure. The folders are nice, but ultimately make development a little too complex for 99% of projects.

A solid example of what I think might work better is https://github.com/m-e-h/forsite/tree/master/views

Dev/Production assets

Production assets should have a .min suffix added where applicable.
Then we can safely ignore any non production assets in .gitignore to make sure only production assets are comitted.

Tab sizes

See how the tab sizes can be changed. 8 size tab is too large!

Gutenberg styles

Any Gutenberg styles that I notice need adding will be listed here...

Tables

  • Default style should be a bit more pleasing
  • Styling for striped tables

Pullquotes

  • Styling should be applied to the nested blockquote rather than the wrapping div
  • Styling for solid styled

Columns

  • Need responsive styles. Should be 1/2 columns by default.

Buttons

  • Remove underline on hover and focus
  • Coloured buttons need reworking

Twitter embed

  • Bottom is cut off by the wrapper

Dividers

  • Dotted option looks incorrect in editor

Media text

  • No styling at all for the media text block

Tailwind

Hi Brett,

Not an issue, but I noticed you closed all Tailwind related branches. Coincidently I also noticed that WebDevStudios is working on their wd_s theme to support Tailwind; thought you might want to give that a look (since I still think it would be nice to have a Tailwind-supporting version of Luxe ;-)):

https://github.com/WebDevStudios/wd_s/tree/feature/tailwind

Cheers, Tibor

WooCommerce

We need to bake in support for WooCommerce out of the box.
This needs to include styling as well as filters etc.

Sass

The theme needs a full Sass makeover. Refer to Uuups for an excellent example.
We should be able to do this without using Foundation!

Elements:

  • Forms
  • Blockquote
  • Code
  • HR
  • Lists
  • Links
  • Media
  • Tables
  • Headings

Components:

  • Comments
  • Button
  • Entry
  • Footer
  • Header
  • Menu
  • Pagination
  • SVG
  • Table

Large expanded menu closes when scrolling on mobile

When there is an elaborate menu with many nested menu items on multiple levels, a user is unable to scroll down on mobile when he/she has expanded some of these levels to the extend that they fall outside the viewport. In that situation the menu will close when scrolling.

I'd love to submit a pull-request that improves this, but I'm not sure where to look. Can you point me in the right direction? Does the menu lose focus when someone scrolls and therefor closes? I still see the hamburger icon having the :focus outline. I don't think responsive-menu.js has any influence on this.

Any pointers appreciated :-)

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.