Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
mckeever02 committed Jan 7, 2019
1 parent 867643a commit 4cba8a7
Show file tree
Hide file tree
Showing 4 changed files with 25 additions and 36 deletions.
Binary file modified .DS_Store
Binary file not shown.
55 changes: 22 additions & 33 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,47 +1,36 @@
[![Build Status](https://travis-ci.org/Automattic/_s.svg?branch=master)](https://travis-ci.org/Automattic/_s)
# Mobius

_s
===
![mobius wordpress theme](https://github.com/mckeever02/mobius/blob/master/screenshot.png)

Hi. I'm a starter theme called `_s`, or `underscores`, if you like. I'm a theme meant for hacking so don't use me as a Parent Theme. Instead try turning me into the next, most awesome, WordPress theme out there. That's what I'm here for.

My ultra-minimal CSS might make me look like theme tartare but that means less stuff to get in your way when you're designing your awesome theme. Here are some of the other more interesting things you'll find here:

* A just right amount of lean, well-commented, modern, HTML5 templates.
* A helpful 404 template.
* A custom header implementation in `inc/custom-header.php` just add the code snippet found in the comments of `inc/custom-header.php` to your `header.php` template.
* Custom template tags in `inc/template-tags.php` that keep your templates clean and neat and prevent code duplication.
* Some small tweaks in `inc/template-functions.php` that can improve your theming experience.
* A script at `js/navigation.js` that makes your menu a toggled dropdown on small screens (like your phone), ready for CSS artistry. It's enqueued in `functions.php`.
* 2 sample CSS layouts in `layouts/` for a sidebar on either side of your content.
Note: `.no-sidebar` styles are not automatically loaded.
* Smartly organized starter CSS in `style.css` that will help you to quickly get your design off the ground.
* Full support for `WooCommerce plugin` integration with hooks in `inc/woocommerce.php`, styling override woocommerce.css with product gallery features (zoom, swipe, lightbox) enabled.
* Licensed under GPLv2 or later. :) Use it to make something cool.
Wordpress starter theme based on underscores with bootstrap and laravel mix for assets compiling.

Getting Started
---------------

If you want to keep it simple, head over to https://underscores.me and generate your `_s` based theme from there. You just input the name of the theme you want to create, click the "Generate" button, and you get your ready-to-awesomize starter theme.
- Download or clone this repo into your wordpress theme directory.
- Run `npm install` in the mobius theme directory to install dependencies.
- Open `webpack.mix.js` and change `.browserSync('template.test');` to your local site URL for hot reloading

If you want to set things up manually, download `_s` from GitHub. The first thing you want to do is copy the `_s` directory and change the name to something else (like, say, `megatherium-is-awesome`), and then you'll need to do a five-step find and replace on the name in all the templates.
Laravel Mix Commands
---------------

1. Search for `'_s'` (inside single quotations) to capture the text domain.
2. Search for `_s_` to capture all the function names.
3. Search for `Text Domain: _s` in `style.css`.
4. Search for <code>&nbsp;_s</code> (with a space before it) to capture DocBlocks.
5. Search for `_s-` to capture prefixed handles.
Laravel Mix provides a few helpful commands while you are developing your theme. Here are the main ones you will need:

OR
```
npm run dev
```
Run dev compiles the assets but does not minify. Useful for seeing the full source.

1. Search for: `'_s'` and replace with: `'megatherium-is-awesome'`
2. Search for: `_s_` and replace with: `megatherium_is_awesome_`
3. Search for: `Text Domain: _s` and replace with: `Text Domain: megatherium-is-awesome` in `style.css`.
4. Search for: <code>&nbsp;_s</code> and replace with: <code>&nbsp;Megatherium_is_Awesome</code>
5. Search for: `_s-` and replace with: `megatherium-is-awesome-`
```
npm run production
```
Run production compiles and minifies, ready for you to push to production.

Then, update the stylesheet header in `style.css`, the links in `footer.php` with your own information and rename `_s.pot` from `languages` folder to use the theme's slug. Next, update or delete this readme.

Now you're ready to go! The next step is easy to say, but harder to do: make an awesome WordPress theme. :)
```
npm run watch
```
This keeps a watch on your files and if any change, then it runs the dev command automatically.

Good luck!
You can see a full list of the laravel mix commands (https://laravel.com/docs/5.4/mix)[here].
6 changes: 3 additions & 3 deletions sass/style.scss
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
/*!
Theme Name: Mobius
Theme URI: http://underscores.me/
Theme URI: https://mckvr.com
Author: Michael McKeever
Author URI: http://mckvr.com
Description: Custom theme built on underscores and developed by Michael McKeever.
Author URI: https://mckvr.com
Description: Wordpress starter theme based on underscores with bootstrap and laravel mix for assets compiling.
Version: 1.0.0
License: GNU General Public License v2 or later
License URI: Mobius
Expand Down
Binary file modified screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 4cba8a7

Please sign in to comment.