You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+29-31Lines changed: 29 additions & 31 deletions
Original file line number
Diff line number
Diff line change
@@ -1,10 +1,10 @@
1
-
# Aucor Starter
1
+
# Axio by Generaxion (previously Aucor Starter)
2
2
3
3
**🖥 For developer from developers:**
4
4
5
-
Superior Gutenberg WordPress starter theme with modern build tools by **[Generaxion](https://www.generaxion.com)**. 200+ hours of development over 4 years to make the greatest starting point for WordPress site.
5
+
Superior Gutenberg WordPress starter theme with modern build tools by **[Generaxion](https://www.generaxion.com)**. 250+ hours of development over 6 years to make the greatest starting point for WordPress site.
@@ -87,17 +85,16 @@ Do these theme installation steps before modifying anything.
87
85
88
86
#### Run setup
89
87
90
-

88
+

91
89
92
90
Run setup wizard in theme root with bash `sh bin/setup.sh`
93
91
94
92
|**Field**|**Meaning**|**Default**|
95
93
|---|---|---|
96
-
|**Site name**| Name in style.css |`Aucor Starter`|
97
-
|**Unique id**| Prefix and ID for code. Recommended length 1-5 characters. |`aucor_starter`|
98
-
|**Local development url**| Browsersync's mirror URL. Stored at `/assets/manifest.js`|`https://aucor-starter.local`|
99
-
|**Author name**| Author in style.css |`Aucor Oy`|
100
-
|**Author URL**| Author URL in style.css |`https://www.aucor.fi`|
94
+
|**Site name**| Name in style.css |`Axio by Generaxion`|
95
+
|**Local development url**| Browsersync's mirror URL. Stored at `/assets/manifest.js`|`https://axio-starter.local`|
96
+
|**Author name**| Author in style.css |`Generaxion`|
97
+
|**Author URL**| Author URL in style.css |`https://www.generaxion.com`|
101
98
102
99
#### Run localizator (if needed)
103
100
@@ -109,7 +106,7 @@ Theme strings are by default in English but we do support Finnish and probably S
109
106
110
107
#### Install Aucor Core
111
108
112
-
Some of the functionality of Aucor Starter require plugin Aucor Core. The plugin is centrally updated so that sites using starter will be easier to maintain and there will be less duplicate code from project to project. Aucor Starter won't have fatal errors without it, but for example localization won't work without it.
109
+
Some of the functionality of Axio by Generaxion require plugin Aucor Core. The plugin is centrally updated so that sites using starter will be easier to maintain and there will be less duplicate code from project to project. Axio by Generaxion won't have fatal errors without it, but for example localization won't work without it.
113
110
114
111
Download Aucor Core from [WordPress.org](https://wordpress.org/plugins/aucor-core/) or [Github](https://github.com/aucor/aucor-core) and activate.
115
112
@@ -160,15 +157,15 @@ Components get their power from abstract class Component that keeps in the struc
160
157
There are two basic ways to use component:
161
158
162
159
```
163
-
Aucor_Teaser::render();
164
-
Aucor_Teaser::get();
160
+
X_Teaser::render();
161
+
X_Teaser::get();
165
162
```
166
163
167
164
The render function prints out the HTML markup of the component and get will return it. You can pass arguments in an array like so:
168
165
169
166
```
170
-
Aucor_Teaser::render(['id' => 123]);
171
-
Aucor_Teaser::render([
167
+
X_Teaser::render(['id' => 123]);
168
+
X_Teaser::render([
172
169
'id' => 123
173
170
'hide_image' => true,
174
171
]);
@@ -184,13 +181,13 @@ All components can be interacted with the same way. It is up to the component to
184
181
* Component: Componet's name
185
182
*
186
183
* @example
187
-
* Aucor_Components_Name::render([
184
+
* X_Components_Name::render([
188
185
* 'title' => 'Title',
189
186
* 'description' => 'Descriptive text'
190
187
* 'image' => 123
191
188
* ]);
192
189
*/
193
-
class Aucor_Components_Name extends Aucor_Component {
190
+
class X_Components_Name extends X_Component {
194
191
195
192
public static function frontend($data) {
196
193
?>
@@ -199,7 +196,7 @@ class Aucor_Components_Name extends Aucor_Component {
199
196
<?php if (!empty($data['image'])) : ?>
200
197
201
198
<divclass="components-name__image">
202
-
Aucor_Image::render([
199
+
X_Image::render([
203
200
'id' => $data['image'],
204
201
'size' => 'large',
205
202
]);
@@ -293,7 +290,7 @@ A few modules are required or there are more changes needed than just deleting t
293
290
|`/svg/`| Yes | Component to display SVG sprite icons |
294
291
|`/teaser/`| Yes | Component to display teaser cards |
295
292
|`/background/`| - | Replacement for core/group block with background color, image or video options. |
296
-
|`/button/`| - | Replacement for core/button block with ACF block and component. |
293
+
|`/buttons/`| - | Replacement for core/buttons block with ACF block and component. |
297
294
|`/core-columns/`| - | Gutenberg columns block |
298
295
|`/core-embed/`| - | Gutenberg embed blocks |
299
296
|`/core-gallery/`| - | Gutenberg gallery block |
@@ -603,7 +600,7 @@ Put all icons to `/assets/sprite/` and Gulp will combine and minify them into `/
603
600
In PHP you can get these images with:
604
601
605
602
```php
606
-
<?php Aucor_SVG::render([
603
+
<?php X_SVG::render([
607
604
'name' => 'facebook'
608
605
]); ?>
609
606
```
@@ -646,6 +643,7 @@ The `/inc/_conf/` directory has some essential settings for theme that you basic
646
643
647
644
*`register-assets.php` has all CSS and JS enqueues to templates as well as any arbitary code added to header or footer.
648
645
*`register-blocks.php` defines which Gutenberg blocks are allowed. Notice that all blocks that are not defined here are not allowed and modules add their own blocks to the mix.
646
+
*`register-colors.php` configure background colors to be available in blocks using backgrounds (background, media & text).
649
647
*`register-image-sizes.php` register all global image sizes and responsive image sizes.
650
648
*`register-localization.php` all global translatable strings for Polylang.
651
649
@@ -655,13 +653,13 @@ Directory `/inc/helpers/`.
655
653
656
654
#### Dates
657
655
658
-
Function: `aucor_starter_get_posted_on()`
656
+
Function: `x_get_posted_on()`
659
657
660
658
Get published date.
661
659
662
660
#### Hardcoded ids
663
661
664
-
Function: `aucor_starter_get_hardcoded_id($key)`
662
+
Function: `x_get_hardcoded_id($key)`
665
663
666
664
Save all harcoded ids in one place in refer them through this function. Example:
667
665
@@ -673,7 +671,7 @@ Save all harcoded ids in one place in refer them through this function. Example:
673
671
*
674
672
* @return int harcoded id
675
673
*/
676
-
function aucor_starter_get_hardcoded_id($key = '') {
674
+
function x_get_hardcoded_id($key = '') {
677
675
678
676
switch ($key) {
679
677
@@ -689,13 +687,13 @@ function aucor_starter_get_hardcoded_id($key = '') {
689
687
```
690
688
691
689
Used in template:
692
-
`aucor_starter_get_hardcoded_id('some-id')`
690
+
`x_get_hardcoded_id('some-id')`
693
691
694
692
**Protip:** Avoid hardcoding ids if possible. If you really need to do it, centralize them into this function.
695
693
696
694
#### Last edited
697
695
698
-
Function: `aucor_starter_last_edited($asset)`
696
+
Function: `x_last_edited($asset)`
699
697
700
698
Get last edited timestamp from asset files. Timestamps are saved in `/assets/last-edited.json`.
701
699
@@ -787,14 +785,14 @@ Enqueue string to frontend with `wp_localize_script()`:
This makes a global JS variable before given script id (here aucor_starter-js) and you can use string in JS:
795
+
This makes a global JS variable before given script id (here x-js) and you can use string in JS:
798
796
799
797
```js
800
798
console.log(theme_strings_variable_name.prev);
@@ -898,7 +896,7 @@ Gutenberg is the new default WordPress editor so it is not a great long term pla
898
896
899
897
#### Gutenberg styles
900
898
901
-
Aucor Starter includes default Gutenberg styles on front-end and overrides them with from theme. This makes a site more future-proof as Gutenberg will have breaking changes in future where some features will not work properly without correct styles (and default styles will take care of them to some degree). You may have to override some opinionated defaults, though.
899
+
Axio by Generaxion includes default Gutenberg styles on front-end and overrides them with from theme. This makes a site more future-proof as Gutenberg will have breaking changes in future where some features will not work properly without correct styles (and default styles will take care of them to some degree). You may have to override some opinionated defaults, though.
902
900
903
901
In Gutenberg editor, there are still lots of default styles so there might be a few inconsistensies between front-end and back-end. This will get better in future versions of Gutenberg and starter.
0 commit comments