-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Showing
79 changed files
with
33,726 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
# editorconfig.org | ||
|
||
root = true | ||
|
||
[*] | ||
indent_style = space | ||
indent_size = 2 | ||
end_of_line = lf | ||
charset = utf-8 | ||
trim_trailing_whitespace = true | ||
insert_final_newline = true | ||
|
||
[*.php] | ||
indent_size = 4 | ||
|
||
[resources/views/**.php] | ||
indent_size = 2 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,48 @@ | ||
module.exports = { | ||
'root': true, | ||
'extends': 'eslint:recommended', | ||
'globals': { | ||
'wp': true, | ||
}, | ||
'env': { | ||
'node': true, | ||
'es6': true, | ||
'amd': true, | ||
'browser': true, | ||
'jquery': true, | ||
}, | ||
'parserOptions': { | ||
'ecmaFeatures': { | ||
'globalReturn': true, | ||
'generators': false, | ||
'objectLiteralDuplicateProperties': false, | ||
'experimentalObjectRestSpread': true, | ||
}, | ||
'ecmaVersion': 2017, | ||
'sourceType': 'module', | ||
}, | ||
'plugins': [ | ||
'import', | ||
], | ||
'settings': { | ||
'import/core-modules': [], | ||
'import/ignore': [ | ||
'node_modules', | ||
'\\.(coffee|scss|css|less|hbs|svg|json)$', | ||
], | ||
}, | ||
'rules': { | ||
'no-console': 0, | ||
'quotes': ['error', 'single'], | ||
'comma-dangle': [ | ||
'error', | ||
{ | ||
'arrays': 'always-multiline', | ||
'objects': 'always-multiline', | ||
'imports': 'always-multiline', | ||
'exports': 'always-multiline', | ||
'functions': 'ignore', | ||
}, | ||
], | ||
}, | ||
}; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
# Include your project-specific ignores in this file | ||
# Read about how to use .gitignore: https://help.github.com/articles/ignoring-files | ||
.cache-loader | ||
dist | ||
node_modules | ||
npm-debug.log | ||
yarn-error.log | ||
/vendor | ||
resources/assets/config-local.json |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
module.exports = { | ||
'extends': 'stylelint-config-standard', | ||
'rules': { | ||
'no-empty-source': null, | ||
'string-quotes': 'double', | ||
'at-rule-no-unknown': [ | ||
true, | ||
{ | ||
'ignoreAtRules': [ | ||
'extend', | ||
'at-root', | ||
'debug', | ||
'warn', | ||
'error', | ||
'if', | ||
'else', | ||
'for', | ||
'each', | ||
'while', | ||
'mixin', | ||
'include', | ||
'content', | ||
'return', | ||
'function', | ||
'tailwind', | ||
'apply', | ||
'responsive', | ||
'variants', | ||
'screen', | ||
], | ||
}, | ||
], | ||
}, | ||
}; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,74 @@ | ||
# Contributor Covenant Code of Conduct | ||
|
||
## Our Pledge | ||
|
||
In the interest of fostering an open and welcoming environment, we as | ||
contributors and maintainers pledge to making participation in our project and | ||
our community a harassment-free experience for everyone, regardless of age, body | ||
size, disability, ethnicity, gender identity and expression, level of experience, | ||
nationality, personal appearance, race, religion, or sexual identity and | ||
orientation. | ||
|
||
## Our Standards | ||
|
||
Examples of behavior that contributes to creating a positive environment | ||
include: | ||
|
||
* Using welcoming and inclusive language | ||
* Being respectful of differing viewpoints and experiences | ||
* Gracefully accepting constructive criticism | ||
* Focusing on what is best for the community | ||
* Showing empathy towards other community members | ||
|
||
Examples of unacceptable behavior by participants include: | ||
|
||
* The use of sexualized language or imagery and unwelcome sexual attention or | ||
advances | ||
* Trolling, insulting/derogatory comments, and personal or political attacks | ||
* Public or private harassment | ||
* Publishing others' private information, such as a physical or electronic | ||
address, without explicit permission | ||
* Other conduct which could reasonably be considered inappropriate in a | ||
professional setting | ||
|
||
## Our Responsibilities | ||
|
||
Project maintainers are responsible for clarifying the standards of acceptable | ||
behavior and are expected to take appropriate and fair corrective action in | ||
response to any instances of unacceptable behavior. | ||
|
||
Project maintainers have the right and responsibility to remove, edit, or | ||
reject comments, commits, code, wiki edits, issues, and other contributions | ||
that are not aligned to this Code of Conduct, or to ban temporarily or | ||
permanently any contributor for other behaviors that they deem inappropriate, | ||
threatening, offensive, or harmful. | ||
|
||
## Scope | ||
|
||
This Code of Conduct applies both within project spaces and in public spaces | ||
when an individual is representing the project or its community. Examples of | ||
representing a project or community include using an official project e-mail | ||
address, posting via an official social media account, or acting as an appointed | ||
representative at an online or offline event. Representation of a project may be | ||
further defined and clarified by project maintainers. | ||
|
||
## Enforcement | ||
|
||
Instances of abusive, harassing, or otherwise unacceptable behavior may be | ||
reported by contacting the project team at [email protected]. All | ||
complaints will be reviewed and investigated and will result in a response that | ||
is deemed necessary and appropriate to the circumstances. The project team is | ||
obligated to maintain confidentiality with regard to the reporter of an incident. | ||
Further details of specific enforcement policies may be posted separately. | ||
|
||
Project maintainers who do not follow or enforce the Code of Conduct in good | ||
faith may face temporary or permanent repercussions as determined by other | ||
members of the project's leadership. | ||
|
||
## Attribution | ||
|
||
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, | ||
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html | ||
|
||
[homepage]: https://www.contributor-covenant.org | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
Copyright (c) Ben Word and Scott Walkinshaw | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy of | ||
this software and associated documentation files (the "Software"), to deal in | ||
the Software without restriction, including without limitation the rights to | ||
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies | ||
of the Software, and to permit persons to whom the Software is furnished to do | ||
so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,120 @@ | ||
# [Sage](https://roots.io/sage/) | ||
[![Packagist](https://img.shields.io/packagist/vpre/roots/sage.svg?style=flat-square)](https://packagist.org/packages/roots/sage) | ||
[![devDependency Status](https://img.shields.io/david/dev/roots/sage.svg?style=flat-square)](https://david-dm.org/roots/sage#info=devDependencies) | ||
[![Build Status](https://img.shields.io/travis/roots/sage.svg?style=flat-square)](https://travis-ci.org/roots/sage) | ||
|
||
Sage is a WordPress starter theme with a modern development workflow. | ||
|
||
## Features | ||
|
||
* Sass for stylesheets | ||
* Modern JavaScript | ||
* [Webpack](https://webpack.github.io/) for compiling assets, optimizing images, and concatenating and minifying files | ||
* [Browsersync](http://www.browsersync.io/) for synchronized browser testing | ||
* [Blade](https://laravel.com/docs/5.6/blade) as a templating engine | ||
* [Controller](https://github.com/soberwp/controller) for passing data to Blade templates | ||
* CSS framework (optional): [Bootstrap 4](https://getbootstrap.com/), [Bulma](https://bulma.io/), [Foundation](https://foundation.zurb.com/), [Tachyons](http://tachyons.io/), [Tailwind](https://tailwindcss.com/) | ||
|
||
See a working example at [roots-example-project.com](https://roots-example-project.com/). | ||
|
||
## Requirements | ||
|
||
Make sure all dependencies have been installed before moving on: | ||
|
||
* [WordPress](https://wordpress.org/) >= 4.7 | ||
* [PHP](https://secure.php.net/manual/en/install.php) >= 7.1.3 (with [`php-mbstring`](https://secure.php.net/manual/en/book.mbstring.php) enabled) | ||
* [Composer](https://getcomposer.org/download/) | ||
* [Node.js](http://nodejs.org/) >= 8.0.0 | ||
* [Yarn](https://yarnpkg.com/en/docs/install) | ||
|
||
## Theme installation | ||
|
||
Install Sage using Composer from your WordPress themes directory (replace `your-theme-name` below with the name of your theme): | ||
|
||
```shell | ||
# @ app/themes/ or wp-content/themes/ | ||
$ composer create-project roots/sage your-theme-name | ||
``` | ||
|
||
To install the latest development version of Sage, add `dev-master` to the end of the command: | ||
|
||
```shell | ||
$ composer create-project roots/sage your-theme-name dev-master | ||
``` | ||
|
||
During theme installation you will have options to update `style.css` theme headers, select a CSS framework, and configure Browsersync. | ||
|
||
## Theme structure | ||
|
||
```shell | ||
themes/your-theme-name/ # → Root of your Sage based theme | ||
├── app/ # → Theme PHP | ||
│ ├── Controllers/ # → Controller files | ||
│ ├── admin.php # → Theme customizer setup | ||
│ ├── filters.php # → Theme filters | ||
│ ├── helpers.php # → Helper functions | ||
│ └── setup.php # → Theme setup | ||
├── composer.json # → Autoloading for `app/` files | ||
├── composer.lock # → Composer lock file (never edit) | ||
├── dist/ # → Built theme assets (never edit) | ||
├── node_modules/ # → Node.js packages (never edit) | ||
├── package.json # → Node.js dependencies and scripts | ||
├── resources/ # → Theme assets and templates | ||
│ ├── assets/ # → Front-end assets | ||
│ │ ├── config.json # → Settings for compiled assets | ||
│ │ ├── build/ # → Webpack and ESLint config | ||
│ │ ├── fonts/ # → Theme fonts | ||
│ │ ├── images/ # → Theme images | ||
│ │ ├── scripts/ # → Theme JS | ||
│ │ └── styles/ # → Theme stylesheets | ||
│ ├── functions.php # → Composer autoloader, theme includes | ||
│ ├── index.php # → Never manually edit | ||
│ ├── screenshot.png # → Theme screenshot for WP admin | ||
│ ├── style.css # → Theme meta information | ||
│ └── views/ # → Theme templates | ||
│ ├── layouts/ # → Base templates | ||
│ └── partials/ # → Partial templates | ||
└── vendor/ # → Composer packages (never edit) | ||
``` | ||
|
||
## Theme setup | ||
|
||
Edit `app/setup.php` to enable or disable theme features, setup navigation menus, post thumbnail sizes, and sidebars. | ||
|
||
## Theme development | ||
|
||
* Run `yarn` from the theme directory to install dependencies | ||
* Update `resources/assets/config.json` settings: | ||
* `devUrl` should reflect your local development hostname | ||
* `publicPath` should reflect your WordPress folder structure (`/wp-content/themes/sage` for non-[Bedrock](https://roots.io/bedrock/) installs) | ||
|
||
### Build commands | ||
|
||
* `yarn start` — Compile assets when file changes are made, start Browsersync session | ||
* `yarn build` — Compile and optimize the files in your assets directory | ||
* `yarn build:production` — Compile assets for production | ||
|
||
## Documentation | ||
|
||
* [Sage documentation](https://roots.io/sage/docs/) | ||
* [Controller documentation](https://github.com/soberwp/controller#usage) | ||
|
||
## Contributing | ||
|
||
Contributions are welcome from everyone. We have [contributing guidelines](https://github.com/roots/guidelines/blob/master/CONTRIBUTING.md) to help you get started. | ||
|
||
## Sage sponsors | ||
|
||
Help support our open-source development efforts by [becoming a patron](https://www.patreon.com/rootsdev). | ||
|
||
<a href="https://kinsta.com/?kaid=OFDHAJIXUDIV"><img src="https://cdn.roots.io/app/uploads/kinsta.svg" alt="Kinsta" width="200" height="150"></a> <a href="https://k-m.com/"><img src="https://cdn.roots.io/app/uploads/km-digital.svg" alt="KM Digital" width="200" height="150"></a> <a href="https://www.itineris.co.uk/"><img src="https://cdn.roots.io/app/uploads/itineris.svg" alt="itineris" width="200" height="150"></a> <a href="http://www.hbgdesignlab.se/"><img src="https://cdn.roots.io/app/uploads/helsingborgdesignlab.png" alt="Helsingborg Design LAB" with="200" height="150"> | ||
|
||
## Community | ||
|
||
Keep track of development and community news. | ||
|
||
* Participate on the [Roots Discourse](https://discourse.roots.io/) | ||
* Follow [@rootswp on Twitter](https://twitter.com/rootswp) | ||
* Read and subscribe to the [Roots Blog](https://roots.io/blog/) | ||
* Subscribe to the [Roots Newsletter](https://roots.io/subscribe/) | ||
* Listen to the [Roots Radio podcast](https://roots.io/podcast/) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
<?php | ||
|
||
namespace App\Controllers; | ||
|
||
use Sober\Controller\Controller; | ||
|
||
class App extends Controller | ||
{ | ||
public function siteName() | ||
{ | ||
return get_bloginfo('name'); | ||
} | ||
|
||
public static function title() | ||
{ | ||
if (is_home()) { | ||
if ($home = get_option('page_for_posts', true)) { | ||
return get_the_title($home); | ||
} | ||
return __('Latest Posts', 'sage'); | ||
} | ||
if (is_archive()) { | ||
return get_the_archive_title(); | ||
} | ||
if (is_search()) { | ||
return sprintf(__('Search Results for %s', 'sage'), get_search_query()); | ||
} | ||
if (is_404()) { | ||
return __('Not Found', 'sage'); | ||
} | ||
return get_the_title(); | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
<?php | ||
|
||
namespace App\Controllers; | ||
|
||
use Sober\Controller\Controller; | ||
|
||
class FrontPage extends Controller | ||
{ | ||
|
||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
<?php | ||
|
||
namespace App; | ||
|
||
/** | ||
* Theme customizer | ||
*/ | ||
add_action('customize_register', function (\WP_Customize_Manager $wp_customize) { | ||
// Add postMessage support | ||
$wp_customize->get_setting('blogname')->transport = 'postMessage'; | ||
$wp_customize->selective_refresh->add_partial('blogname', [ | ||
'selector' => '.brand', | ||
'render_callback' => function () { | ||
bloginfo('name'); | ||
} | ||
]); | ||
}); | ||
|
||
/** | ||
* Customizer JS | ||
*/ | ||
add_action('customize_preview_init', function () { | ||
wp_enqueue_script('sage/customizer.js', asset_path('scripts/customizer.js'), ['customize-preview'], null, true); | ||
}); |
Oops, something went wrong.